Contract API Debugging

If you encounter a variety of errors, the Contracts API responds with appropriate HTTP status codes and a response object that explains them, detailed below.

There are many possible causes for failure, such as data input errors or a resource not being found.

This API responds with HTTP problem error objects that provide details useful for debugging. For example:

{
    "status": "400",
    "title": "Erroneous data input.",
    "type": "/contract-api/error-types/E400",
    "errors": [
        {
            "detail": "From date must be within 15 months in past from the current date",
            "title": "from"
        },
        {
            "detail": "To date must be on or before the current date",
            "title": "to"
        }
    ]
}

HTTP Status Codes

The API responds with the following set of HTTP status codes for both success and failure scenarios.

Code Description
200 Request OK
300 Multiple Choice
400 Malformed Request
404 Resource not found

Last modified: 10/5/2017