Overview

Endpoint Documentation

API Authentication

Each request should include an HTTP Authorization header with the assigned API key:

Authorization: RSIS <apiKey>

Data Types

As a convention, properties in JSON data conform to the following types:

Type JSON Type Description
string string a JSON string value
boolean boolean a JSON boolean value
null null a JSON null value
integer number an integer value encoded as a JSON number
decimal string a decimal number encoded as a JSON string (must match /^[0-9]+(\.[0-9]+)?$/)

Note: decimal numbers are formatted as JSON strings in order to avoid floating point precision errors.

HTTP Status Codes

API calls may result in the following HTTP status codes:

Code Message Condition
200 OK The request was successful
201 Created The resource was successfully created or modified
401 Unauthorized The API key is missing or invalid
403 Forbidden The API key does not provide access to this resource
404 Not Found The resource does not exist
405 Method Not Allowed The wrong HTTP method was used
415 Unsupported Media Type The wrong content-type was used
422 Unprocessable Entity The request was invalid or could not be processed
500 Internal Server Error An unexpected error occurred

Error Response JSON

In the case of an error (any HTTP status code other than 200 or 201), the API will return JSON with the following format:

{
  "error": "error message",
  "errorCategory": "CATEGORY"
}

Note: The error message in the error field is not structured data and may not be stable. It is intended for display and not for parsing programmatically.

Please refer to this list of error categories for more information.