GET/track-and-trace/v1/documents/:documentId/events/:eventId
Gets the event corresponding to the document ID and event ID.
Request
Path Parameters
The 32-bytes ID of the document, encoded in hexadecimal.
The 32-bytes ID of the event, encoded in hexadecimal.
Responses
- 200
- 400
- 404
- 500
Success
- application/json
- Schema
- Example
Schema
Event's metadata
timestamp object
Timestamp object
The date and time, optionally from transaction input
Defines how the datetime was resolved, enumerated options are "block" and "external"
Proof of the source. Either a block number or a hash of timestamp certificate
The
did:key
did:ebsi
Most of the times empty field, while it may be a string containing company name, while it can also point into an Event. All assumed relations are external to the SC.
Event hash
Externally generated hash
{
"externalHash": "0x7caebd56efed5cf6758c401961de9e33dff856cece64cb6ff3aa3a587393b96d",
"hash": "0x4791c04d2e4838042c67f3e739ab8639b6bd0f6896ec7e32e99c640d43b530c7",
"timestamp": {
"datetime": "0x65d372cb",
"source": "block",
"proof": "0x000000000000000000000000000000000000000000000000000000000047a88d"
},
"sender": "did:ebsi:zxaYaUtb8pvoAtYNWbKcveg",
"origin": "origin",
"metadata": "eventMetadata"
}
Bad Request Error
- application/problem+json
- Schema
- Invalid {documentId} Parameter
- Invalid {eventId} Parameter
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 Request",
"status": 400,
"detail": "[\"documentId must be 32 bytes encoded in hexadecimal and start with 0x\"]"
}
{
"title": "Bad Request",
"status": 400,
"detail": "[\"eventId must be 32 bytes encoded in hexadecimal and start with 0x\"]"
}
Not found
- application/problem+json
- Schema
- Document Not Found
- Event Not Found
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": "Not found",
"status": 404,
"detail": "Not found"
}
{
"title": "Not found",
"status": 404,
"detail": "Not found"
}
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"
}