Response Content Type
All responses will be provided in application/json unless stated otherwise in the endpoint description.
When other formats are available, a format parameter will be provided with a list of supported formats.
Date and Duration
All date and duration fields will be formatted using ISO 8601 format. All timestamps will use the UTC time zone.
Date format YYYY-MM-DD example:
2010-10-21
Date and time format YYYY-MM-DDTHH:MM:SS.SSSZ example:
2023-01-25T16:20:20.000Z
Duration format PnYnMnDTnHnMnS example:
PT30M5S
Empty Values
Empty fields will be omitted from responses except in the case of a nested object, then a null value will be provided.
Example:
{
"sessionId": "",
"startDate": "2023-01-25T16:20:20.000Z",
"endDate": "2023-01-25T16:20:20.000Z",
"result": {
"level": "E3 - Lower"
}
}
In the example above, endDate and result can be empty. The example below shows the response when those fields are empty.
{
"sessionId": "",
"startDate": "2023-01-25T16:20:20.000Z",
"result": null
}