GET 
/track-and-trace/v2/accesses

Get accesses filtered by subject.

Request

Query Parameters

subject stringrequired
Subject DID
Example: did:ebsi:zkrLJ5WyqiHbiXjur3TqzfA
permission string

Filter accesses by permission (creator, delegate, or write).

granted-by string

Filter accesses by granter.

Responses

200

Success

application/json

Schema

Schema

self string

Absolute path to the collection (consult)

items object[]
List of accesses
Array [
subject string
Subject
documentId string
Document ID
grantedBy string
DID that granted the access
permission string
Possible values: [write, delegate, creator]
Type of permission
]
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/accesses?page[after]=1&page[size]=10&subject=did:ebsi:ztqWJAmfyuUEf9Jvh97p167",
  "items": [
    {
      "documentId": "0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4",
      "subject": "did:ebsi:ztqWJAmfyuUEf9Jvh97p167",
      "grantedBy": "did:ebsi:zmRQoAM1YrVBVA3cP6CwYfc",
      "permission": "write"
    },
    {
      "documentId": "0x65292ff9c6f87f754fe33a03d0b385b2c2d6bbaedff22438bec39593ce5920f4",
      "subject": "did:ebsi:ztqWJAmfyuUEf9Jvh97p167",
      "grantedBy": "did:ebsi:zmRQoAM1YrVBVA3cP6CwYfc",
      "permission": "delegate"
    }
  ],
  "total": 2,
  "pageSize": 10,
  "links": {
    "first": "https://api-test.ebsi.eu/track-and-trace/v2/accesses?page[after]=1&page[size]=10&subject=did:ebsi:ztqWJAmfyuUEf9Jvh97p167",
    "prev": "https://api-test.ebsi.eu/track-and-trace/v2/accesses?page[after]=1&page[size]=10&subject=did:ebsi:ztqWJAmfyuUEf9Jvh97p167",
    "next": "https://api-test.ebsi.eu/track-and-trace/v2/accesses?page[after]=2&page[size]=10&subject=did:ebsi:ztqWJAmfyuUEf9Jvh97p167",
    "last": "https://api-test.ebsi.eu/track-and-trace/v2/accesses?page[after]=10&page[size]=10&subject=did:ebsi:ztqWJAmfyuUEf9Jvh97p167"
  }
}

400

Bad Request

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.

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