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.

Response Codes

200OKYesEverything worked as expected.
202AcceptedYesThe request has been accepted for processing, but the processing has not been completed.
204No ContentYesThe server has successfully fulfilled the PUT request and there is no additional content to send in the response payload body.
400Bad RequestNoThe request could not be understood by server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.
403ForbiddenNoThe request is understood but access is not allowed due to the IP whitelisting policy.
404Not foundNoThe URI requested is invalid. Also returned when the requested format is not supported by the requested method.
409ConflictYesThe request could not be completed due to a conflict with the current state of the resource.
429Too Many RequestsYesReturned when a request cannot be served due to the application’s rate limit having been exhausted for the resource.
500Internal Server ErrorYesSomething is broken. Try again later or you may contact the EBSCO customer service team at [email protected].
503Service Unavailable ExceptionYesOur servers are up, but overloaded with requests. Try again later or you may contact the EBSCO customer service team at [email protected].
504Endpoint Request Timed-out ExceptionYesOur 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 protected].

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.

Error Message

  "Errors": [
      "message": "Parameter Offset is missing.",
      "code": 1005,
      "subcode": 0

Error Message Codes

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.

Error Codes

CodeHTTP CodeText (Sample Error Message)Description
1001404Vendor not foundThe specified resource was not found.
1004500Internal error has occurred.An unknown internal error occurred.
1005400Missing parameter "count"Missing required parameter(s).
1006400Parameter count is outside the range 1-100Invalid parameter received
1009400Custom package with the provided name already existsThe specified resource already exists
1010409Snapshot preparation already in progressSnapshot preparation already in progress