Getting Started

General Considerations

Unless otherwise specified, API methods conform to the following formats:

• Camel casing is used for attribute names (e.g. firstName)
• YYYY-MM-DD is used for dates (e.g. 2024-10-29)

Errors

The API uses conventional HTTP responses codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted). Codes in the 5xx range indicate an error with the API server.