Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

These logs document changes to the Arken Public API. The document lists the change and the environment where it is rolled out.

Status
colourPurple
titleActive Environments
The environments where the changes are live are listed on the side.

Breaking changes are listed where relevant. Breaking changes are any changes in resource paths, changing of payload structures or fixing HTTP verbs and response codes. This may require development.


New endpoint for File Download

Status
colourRed
titleNZ TEST
Status
titleNZ PREPROD
Status
colourBlue
titleNZ PROD
Status
colourYellow
titleUK PREPROD
Status
colourGreen
titleUK PROD

Info

Breaking changes

The /file endpoint has been split into two different calls. /file/download and /file/detail.

GET /file/download will only return the download URL of the document. This will create an event and it is broadcasted via the webhook service.

GET /file/detail will return all the details about the file similar to the old /file call. This will not create an event.

The purpose of this change was to stop the /file GET method from creating an event, which in turn stops any polling from constantly creating repeating events.

See Public API documentation for more details on calls and webhook events.


Event created with correct EventNumber

Status
colourRed
titleNZ TEST
Status
titleNZ PREPROD
Status
colourYellow
titleUK PREPROD

The response received from a Webhook POST or a GET /event always returned the corresponding eventNumber as 0.

It now shows the correct sequential number linked to the event.

Code Block
languagejson
"eventId": "77fe9c4e-36f7-4627-b8a6-8286e2a91a0b",
"eventType": "FileStore.Upload",
"eventNumber": 265,
"eventDateTimeUtc": "2019-10-21T09:42:53.8826777Z",