GET 
/track-and-trace/v2/documents/:documentId/events

Returns a list of events.

Request

Path Parameters

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

Query Parameters

page[after] string

Cursor that points to the end of the page of data that has been returned.

page[size] integer

Defines the maximum number of objects that may be returned.

external-hash string

Filter events by external hash.

origin string

Filter events by origin.

sender string

Filter events by sender.

source string

Possible values: [block, external]

Filter events by source.

Responses

200

Success

application/json

Schema

Schema

self string

Absolute path to the collection (consult)

items object[]
List of events
Array [
eventId string
The event ID
href string
Link to the resource
]
total integer

Total number of items across all pages.

pageSize integer

Maximum number of items per page. For the last page, its value should be independent of the number of actually returned items.

links object

Links model used for pagination

last string

URI of the last page

prev string

URI of the previous page

next string

URI of the next page

first string

URI of the first page

Example

{
  "self": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events?page[after]=1&page[size]=10",
  "items": [
    {
      "eventId": "0xcc1aea14885d7683ce062c8e3b755c4075ef274199c659d03eafa4a6cc0bb587",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events/0xcc1aea14885d7683ce062c8e3b755c4075ef274199c659d03eafa4a6cc0bb587"
    },
    {
      "eventId": "0x502b93df1016f58eb69e1246c97ffc2f4ffeae36432b60626c973dd029fc21e6",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events/0x502b93df1016f58eb69e1246c97ffc2f4ffeae36432b60626c973dd029fc21e6"
    },
    {
      "eventId": "0x780ee9343e9406d785a2261963bef1d0979e992895bddc0f2893c1946661b32f",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events/0x780ee9343e9406d785a2261963bef1d0979e992895bddc0f2893c1946661b32f"
    }
  ],
  "total": 3,
  "pageSize": 10,
  "links": {
    "first": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events?page[after]=1&page[size]=10",
    "prev": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events?page[after]=1&page[size]=10",
    "next": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events?page[after]=2&page[size]=10",
    "last": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4/events?page[after]=10&page[size]=10"
  }
}

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\"]"
}

Bad Paging Request

{
  "title": "Bad Paging Request",
  "status": 400,
  "detail": "[\"page[size] must not be greater than 50\"]"
}

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"
}

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...