...
Authenticate (same for all services)
Request report (list) of updated objects
Parse list of updated objects (obtain URL to download service for each object)
Download actual objects from download service (one or more requests per object)
URL |
| ||
|---|---|---|---|
Method |
| ||
Request |
| Required | The token acquired from the Authentication Service. Formated "Boknett TGT-...." |
| Required | The timestamp the request was made. Must comply with RFC 1123 date formats. | |
Query |
| Required* | All data elements modified after this “cursor”. The cursor is in a not human readable format. |
| Required* | All data elements modified after this timestamp. The timestamp is on the format yyyyMMddHHmmss. | |
| Optional | See Pagination | |
Response |
| See Pagination | |
| See Pagination | ||
Response | XML (Object metadata) | ||
Returns |
| OK | |
| Bad Request | ||
| Unauthorized | ||
| Forbidden | ||
| Not Acceptable | ||
| Internal Server Error | ||
...
The Object Download Service provides an endpoint for downloading binary object resources. The path to this service, as well as a unique identifier of the requested object, is returned from the object metadata service, which therefore must be called in advance. The unique identifier is only valid for a certain amount of time, as described in the table below, and can only be called by the same user (credentials) that requested the object export metadata service. The following details the parameters, example usage and different responses when using this service.
URL |
| ||
|---|---|---|---|
Method |
| ||
Request |
| Required | The token acquired from the Authentication Service. Formated "Boknett TGT-...." |
| Required | The timestamp the request was made. Must comply with RFC 1123 date formats. | |
| Required | Must be "application/octet-stream" | |
Query |
| Required | An unpredictable generated identifier that uniquely references an object representation. Returned in the response from the Object Report Service. Valid for a limited time. |
Response |
| Suggests a default filename | |
Response | Object file | ||
Returns |
| OK | |
| Forbidden | ||
| Not Found | ||
| Gone | ||
...