1. Introduction
  2. Sample Code
  3. Errors and Troubleshooting
  4. Appendix
  5. Print-Friendly Documentation

Errors and Troubleshooting

As mentioned in the introduction, error responses will return an HTTP code in 400+ range. Clients receiving these headers know that their request failed for various reasons. The API should always at least return a 500 error if there was a fatal error that wasn't caught. Most error responses return a special content type, based on the initial type being requested: application/vnd.digicert.error+xml for XML based requests, and application/vnd.digicert.error+json for JSON based. This content type is based on emerging standards.

In the case of 406 errors, the API doesn't know what format the client requested, so it will send application/vnd.digicert.error+json.

Error Return Values

Parameter NameData TypeDescription
errors[collection]A collection of error codes
error[set]A data set containing information about a specific error
code[string]An error code that identifies the error that occurred
description[string]A human readable description of the error

Sample XML Error Response

For instance, a client wants to reject a pending request, but forgot to include the required NOTE. They would make a REJECT request to the /request/7902 endpoint, and would receive a 400 response with the following body:

JSON (application/vnd.digicert.error+json)XML (application/vnd.digicert.error+xml) 
{
  "errors":[
    {
      "code":"required_param:note",
      "description":"Note is required"
    }
  ]
}
<errors>
  <error>
    <code>required_param:note</code>
    <description>Note is required</description>
  </error>
</errors>