GET 
/track-and-trace/v2/documents

Returns a list of documents.

Request

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.

creator string

Filter documents by creator.

source string

Filter documents by source of proof (block or external).

Responses

200

Success

application/json

Schema

Schema

self string

Absolute path to the collection (consult)

items object[]
List of documents
Array [
documentId string
The document 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?page[after]=1&page[size]=10",
  "items": [
    {
      "documentId": "0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4"
    },
    {
      "documentId": "0x99ab5f3cfc581c53a9210fc4588416fbc84b3ff09950ddc84e0efd1e2b2e147a",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x99ab5f3cfc581c53a9210fc4588416fbc84b3ff09950ddc84e0efd1e2b2e147a"
    },
    {
      "documentId": "0x4ed9c02a2c28de4ebfb274f8036d961062b05d8ea7a06682725d36224718e03e",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x4ed9c02a2c28de4ebfb274f8036d961062b05d8ea7a06682725d36224718e03e"
    },
    {
      "documentId": "0xdd97695335b338c3de251247b533589cd2847000c4c0100a5ece17f28feb8640",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0xdd97695335b338c3de251247b533589cd2847000c4c0100a5ece17f28feb8640"
    },
    {
      "documentId": "0xb64f68452c5b4a30ff952e4f873df8f5d340684d98b90417a6c26e9f48ff4e11",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0xb64f68452c5b4a30ff952e4f873df8f5d340684d98b90417a6c26e9f48ff4e11"
    },
    {
      "documentId": "0x9a7897302b2967c8818ea2b61fa64138ea6f370640739f4a04957dd15c0c43e2",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x9a7897302b2967c8818ea2b61fa64138ea6f370640739f4a04957dd15c0c43e2"
    },
    {
      "documentId": "0x8edbce68309d79731a9e45bba4448b3c705e4074016e0f2cf994e8ad37e99b85",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x8edbce68309d79731a9e45bba4448b3c705e4074016e0f2cf994e8ad37e99b85"
    },
    {
      "documentId": "0x6e64123aaaa5d5e73fc878cc374e72bc9b7791f0048c968953d1943ea0138305",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x6e64123aaaa5d5e73fc878cc374e72bc9b7791f0048c968953d1943ea0138305"
    },
    {
      "documentId": "0x32a2334e9b8793fe4862ba6bac909e148b9ff98c4ca3ed54e598aa5cff63e670",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0x32a2334e9b8793fe4862ba6bac909e148b9ff98c4ca3ed54e598aa5cff63e670"
    },
    {
      "documentId": "0xb08f451727fd50a5cd8433a86ce04302462477e7e978028d71094fc564dbad5e",
      "href": "https://api-test.ebsi.eu/track-and-trace/v2/documents/0xb08f451727fd50a5cd8433a86ce04302462477e7e978028d71094fc564dbad5e"
    }
  ],
  "total": 98,
  "pageSize": 10,
  "links": {
    "first": "https://api-test.ebsi.eu/track-and-trace/v2/documents?page[after]=1&page[size]=10",
    "prev": "https://api-test.ebsi.eu/track-and-trace/v2/documents?page[after]=1&page[size]=10",
    "next": "https://api-test.ebsi.eu/track-and-trace/v2/documents?page[after]=2&page[size]=10",
    "last": "https://api-test.ebsi.eu/track-and-trace/v2/documents?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.

Bad Paging Request

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

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