GET 
/track-and-trace/v1/documents/:documentId/events/:eventId

Gets the event corresponding to the document ID and event ID.

Request

Path Parameters

documentId stringrequired
The 32-bytes ID of the document, encoded in hexadecimal.
Example: 0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4
eventId stringrequired
The 32-bytes ID of the event, encoded in hexadecimal.
Example: 0xcc1aea14885d7683ce062c8e3b755c4075ef274199c659d03eafa4a6cc0bb587

Responses

200

Success

application/json

Schema

Schema

metadata string

Event's metadata

timestamp object

Timestamp object

datetime string

The date and time, optionally from transaction input

source string

Defines how the datetime was resolved, enumerated options are "block" and "external"

proof string

Proof of the source. Either a block number or a hash of timestamp certificate

sender string

The

did:key

or

did:ebsi

that created the event

origin string

Most of the times empty field, while it may be a string containing company name, while it can also point into an Event. All assumed relations are external to the SC.

hash string

Event hash

externalHash string

Externally generated hash

Example

{
  "externalHash": "0xcc43351fa3c5d304fd2d1b472f8c27a2ffa930510c5eb42b972efd33166c91b9",
  "hash": "0xcc1aea14885d7683ce062c8e3b755c4075ef274199c659d03eafa4a6cc0bb587",
  "timestamp": {
    "datetime": "0x65c3881c",
    "source": "block",
    "proof": "0x0000000000000000000000000000000000000000000000000000000000a026d9"
  },
  "sender": "did:ebsi:zkrLJ5WyqiHbiXjur3TqzfA",
  "origin": "origin",
  "metadata": "eventMetadata"
}

400

Bad Request Error

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Invalid {documentId} Parameter

{
  "title": "Bad Request",
  "status": 400,
  "detail": "[\"documentId must be 32 bytes encoded in hexadecimal and start with 0x\"]"
}

Invalid {eventId} Parameter

{
  "title": "Bad Request",
  "status": 400,
  "detail": "[\"eventId must be 32 bytes encoded in hexadecimal and start with 0x\"]"
}

404

Not found

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Document Not Found

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

Event Not Found

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

500

Internal Server Error

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Internal Server Error

{
  "title": "Internal error",
  "status": 500,
  "detail": "Internal error"
}

Loading...