GET 
/track-and-trace/v1/documents/:documentId/accesses

Returns a list of accesses related to the document.

Request

Path Parameters

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

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.

Responses

200

Success

application/json

Schema

Schema

self string

Absolute path to the collection (consult)

items object[]
List of accesses
Array [
subject string
A
did:ebsi
or
did:key
DID.
documentId string
The document ID.
grantedBy string
The
did:ebsi
or
did:key
DID of the granter of the permission. "creator" shall have itself as "grantedBy".
permission string
Permission granted: "write", "delegate" or "creator".
]
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-pilot.ebsi.eu/track-and-trace/v1/documents/0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8/accesses?page[after]=1&page[size]=10",
  "items": [
    {
      "subject": "did:ebsi:zxaYaUtb8pvoAtYNWbKcveg",
      "documentId": "0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8",
      "grantedBy": "did:ebsi:zxaYaUtb8pvoAtYNWbKcveg",
      "permission": "creator"
    }
  ],
  "total": 1,
  "pageSize": 10,
  "links": {
    "first": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8/accesses?page[after]=1&page[size]=10",
    "prev": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8/accesses?page[after]=1&page[size]=10",
    "next": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8/accesses?page[after]=1&page[size]=10",
    "last": "https://api-pilot.ebsi.eu/track-and-trace/v1/documents/0xbfc90433cfe7cf69119899a96837032bee6c84ba7f6ac9aa008ef2de5eeacfb8/accesses?page[after]=1&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...