HTTP Response Codes

We use HTTP Response Codes to communicate a certain status to your system when interacting with our API. Below is a table with a list of codes and what they mean in context. Generally speaking, we aim to align with the general guidance provided in the underlying HTTP standard.

Response CodeDescriptionNotes
200OkMost all of the endpoint are a POST action. A response code of 200 indicates that the POST was successful and did not encounter an error,
401UnauthorizedIf the request already included Authorization credentials, then the 401 response indicates that authorization has been refused for those credentials. Review Authentication and make sure you have the correct authentication.
403ForbiddenThe server understood the request, the token provided is validated but the device is not authorized to access that endpoint.
404Not FoundA 404 indicates that the URL for the request was invalid. Check your code to make sure you are using a published endpoint.
500Internal Server ErrorSomething went wrong when fulfilling the request on the server side. Contact support for additional information and troubleshooting.

All errors return a body with the following JSON schema:

    "timestamp": "03-01-2022 14:33:58",
    "status": 500,
    "error": "Internal Server Error",
    "message": "<error message>"

In addition all HTTP responses will contain a transaction id if a transaction was initiated, which can be used for tracking down the error in our logging system.

OneRecord-Transaction-ID: e683d690-cd04-4438-b94e-2692a5f61631