GET/track-and-trace/v1/documents
Returns a list of documents.
Request
Query Parameters
Cursor that points to the end of the page of data that has been returned.
Defines the maximum number of objects that may be returned.
Responses
- 200
- 400
- 500
Success
- application/json
- Schema
- Example
Schema
- Array [
- ]
Absolute path to the collection (consult)
items object[]
List of documents
The document ID
Link to the resource
Total number of items across all pages.
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
URI of the last page
URI of the previous page
URI of the next page
URI of the first page
{
"self": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents?page[after]=1&page[size]=10",
"items": [
{
"documentId": "0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8"
},
{
"documentId": "0x99ab5f3cfc581c53a9210fc4588416fbc84b3ff09950ddc84e0efd1e2b2e147a",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0x99ab5f3cfc581c53a9210fc4588416fbc84b3ff09950ddc84e0efd1e2b2e147a"
},
{
"documentId": "0x4ed9c02a2c28de4ebfb274f8036d961062b05d8ea7a06682725d36224718e03e",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0x4ed9c02a2c28de4ebfb274f8036d961062b05d8ea7a06682725d36224718e03e"
},
{
"documentId": "0xdd97695335b338c3de251247b533589cd2847000c4c0100a5ece17f28feb8640",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xdd97695335b338c3de251247b533589cd2847000c4c0100a5ece17f28feb8640"
},
{
"documentId": "0xb64f68452c5b4a30ff952e4f873df8f5d340684d98b90417a6c26e9f48ff4e11",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xb64f68452c5b4a30ff952e4f873df8f5d340684d98b90417a6c26e9f48ff4e11"
},
{
"documentId": "0x9a7897302b2967c8818ea2b61fa64138ea6f370640739f4a04957dd15c0c43e2",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0x9a7897302b2967c8818ea2b61fa64138ea6f370640739f4a04957dd15c0c43e2"
},
{
"documentId": "0x8edbce68309d79731a9e45bba4448b3c705e4074016e0f2cf994e8ad37e99b85",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0x8edbce68309d79731a9e45bba4448b3c705e4074016e0f2cf994e8ad37e99b85"
},
{
"documentId": "0x6e64123aaaa5d5e73fc878cc374e72bc9b7791f0048c968953d1943ea0138305",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0x6e64123aaaa5d5e73fc878cc374e72bc9b7791f0048c968953d1943ea0138305"
},
{
"documentId": "0x32a2334e9b8793fe4862ba6bac909e148b9ff98c4ca3ed54e598aa5cff63e670",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0x32a2334e9b8793fe4862ba6bac909e148b9ff98c4ca3ed54e598aa5cff63e670"
},
{
"documentId": "0xb08f451727fd50a5cd8433a86ce04302462477e7e978028d71094fc564dbad5e",
"href": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xb08f451727fd50a5cd8433a86ce04302462477e7e978028d71094fc564dbad5e"
}
],
"total": 98,
"pageSize": 10,
"links": {
"first": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents?page[after]=1&page[size]=10",
"prev": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents?page[after]=1&page[size]=10",
"next": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents?page[after]=2&page[size]=10",
"last": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents?page[after]=10&page[size]=10"
}
}
Bad Request Error
- application/problem+json
- Schema
- Bad Paging Request
Schema
Default value: about:blank
An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.
A short summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code generated by the origin server for this occurrence of the problem.
A human readable explanation specific to this occurrence of the problem.
An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"title": "Bad Paging Request",
"status": 400,
"detail": "[\"page[size] must not be greater than 50\"]"
}
Internal Server Error
- application/problem+json
- Schema
- Internal Server Error
Schema
Default value: about:blank
An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.
A short summary of the problem type.
Possible values: >= 400
and <= 600
The HTTP status code generated by the origin server for this occurrence of the problem.
A human readable explanation specific to this occurrence of the problem.
An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"title": "Internal error",
"status": 500,
"detail": "Internal error"
}