Responses
Shortcuts:
HTTP Status Codes Returned by the API
Responses from the EBH Data Service contain an HTTP status code that indicate the results of the query. A status code of 200 OK indicates that the query executed successfully and returned data in the body of the response. A status code of 404 Not Found indicates that no data was found matching the query parameters. Any other error indicates that an error occurred.
Refer to the "API interfaces available" help pages for a complete list of possible HTTP status codes that can be returned for each API method.
Handling "503 Service Unavailable" Responses
The following conditions cause the EBH Data Service to return a 503 Service Unavailable response as a way to protect the integrity, stability and availability of the server and users' credentials.
- Too many requests with invalid credentials from an IP address within a short time period - the IP address will be blocked.
- Too many requests with invalid credentials for a userid within a short time period - the userid will be blocked.
- Too many requests using the same URL and parameters within a short time period - the URL and parameters will be blocked for the userid.
- Too many requests for any URL and parameters within a short (but longer) time period - the userid will be blocked from submitting any more requests.
The 503 Service Unavailable response indicates that the request has been "throttled" by the server. In addtion to the 503 Service Unavailable HTTP status code, the response will include a Retry-After header, which indicates the number of seconds that the application program should wait before resubmitting the request.