Response and Error Codes
HTTP Response Codes
The EBSCO Knowledge Services return an HTTP response code with each request. The Knowledge Services use conventional HTTP response codes to indicate success or failure of the request. Response codes in the 400 range indicate an error in the information that was provided in the request. For example, a 404 HTTP response code is returned by the service if the information provided is missing a required parameter. Response codes in the 500 range indicate an error on the server, a database error or an API settings error. The HTTP response codes are below.
|Everything worked as expected.
|The request has been accepted for processing, but the processing has not been completed.
|The server has successfully fulfilled the PUT request and there is no additional content to send in the response payload body.
|The request could not be understood by server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
|The request is understood but access is not allowed due to the IP whitelisting policy.
|The URI requested is invalid. Also returned when the requested format is not supported by the requested method.
|The request could not be completed due to a conflict with the current state of the resource.
|Too Many Requests
|Returned when a request cannot be served due to the application’s rate limit having been exhausted for the resource.
|Internal Server Error
|Something is broken. Try again later or you may contact the EBSCO customer service team at email@example.com.
|Service Unavailable Exception
|Our servers are up, but overloaded with requests. Try again later or you may contact the EBSCO customer service team at firstname.lastname@example.org.
|Endpoint Request Timed-out Exception
|Our servers are up, but the request couldn’t be serviced due to some failure at our server. Try again later or you may contact the EBSCO customer service team at email@example.com.
Error Response Messages
The EBSCO Knowledge Services also return error messages that provide additional information about the error. Error messages are returned in JSON format. The error message contains an error code, a message and a sub code. The error message provides descriptive error text and codes that are machine-parsable. The sub code field is an optional field. The sub code can be used to indicate finer grained details about the error. The message text for an error message could vary, but the error that the code represents will stay the same. An example error message is below.
"Message": "Parameter Offset is missing.",
Each error message has an error code. The error code corresponds to a particular HTTP response code. The error codes for the EBSCO Knowledge Services are in the table below. If you see an error code that is not listed in the table, please use the HTTP response code to determine the best way to address the error. Some errors are resolved if you simply retry the same request.
|TEXT (SAMPLE ERROR MESSAGE)
|Vendor not found
|The specified resource was not found
|Internal error has occurred.
|An unknown internal error occurred
|Missing parameter "count"
|Missing required parameter(s)
|Parameter count is outside the range 1-100
|Invalid parameter received
|Custom package with the provided name already exists
|The specified resource already exists
|Snapshot preparation already in progress