Troubleshooting
The following API response codes are returned by the Data API platform:
| HTTP status code | Reason |
|---|---|
| 200 | OK |
| 201 | Created |
| 204 | No Content |
| 400 | Bad Request |
| 410 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 405 | Method Not Allowed |
| 406 | Not Acceptable |
| 409 | Conflict |
| 415 | Unsupported Media Type |
| 500 | Internal Server Error |
| 502 | Bad Gateway |
| 503 | Service Unavailable |
| 504 | Gateway Timeout |
The 200 status code is returned for successful requests even when the request returns no data. For requests receiving application/json output the response body will contain any empty JSON array. For requests receiving text/plain output the response body will contain the header row with no data rows.
The 4xx status codes are returned when a problem exists with a request. The response body will contain a JSON structure with additional information about the error.
5xx status codes are returned when there is a service level error that cannot be identified. The API support team is notified of all error conditions therefore it is not necessary to report these errors via the Support Center, unless the error persists for an extended period of time.
Example Error Response:
{
"statusCode": 400,
"statusDescription": "Bad Request",
"requestId": "ba7c841a-5322-4e07-863a-a44f09a5fc59",
"message": "Invalid date field format. Must be yyyy-MM-dd or yyyy-MM-dd HH:mm:ss.SSS",
"dataRequest": {
"action": "POST",
"internalParams": {},
"datasetGroup": "OTCMarket",
"datasetName": "weeklySummary",
"fields": [],
"dateRangeFilters": [
{
"description": "Filter used to specify a date time range of format (yyyy-MM-dd | yyyy-MM-dd HH:mm:ss(.SSS)). For example, 2017-02-10 21:30:23. Start and End dates are inclusive.",
"startDate": "2017-01-01",
"endDate": "2399-12-31",
"fieldName": "weekStartDate"
}
],
"domainFilters": [],
"compareFilters": [
{
"description": "Filter used to compare field values using traditional equal, not equal, gt, lt, gte, or lte logic.",
"fieldName": "tierIdentifier",
"fieldValue": "T2",
"compareType": "EQUAL"
},
{
"description": "Filter used to compare field values using traditional equal, not equal, gt, lt, gte, or lte logic.",
"fieldName": "weekStartDate",
"fieldValue": "201-03-11",
"compareType": "EQUAL"
},
{
"description": "Filter used to compare field values using traditional equal, not equal, gt, lt, gte, or lte logic.",
"fieldName": "summaryTypeCode",
"fieldValue": "ATS_W_SMBL",
"compareType": "EQUAL"
},
{
"description": "Filter used to compare field values using traditional equal, not equal, gt, lt, gte, or lte logic.",
"fieldName": "issueSymbolIdentifier",
"fieldValue": "ELAN.V",
"compareType": "EQUAL"
}
],
"sortFields": [
"issueSymbolIdentifier",
"marketParticipantName"
],
"limit": 1000,
"offset": 0,
"delimiter": ",",
"quoteValues": true,
"format": "text/plain"
}
}