JSON Error

Describes an error response returned from the Connect server.

Structure

The structure consists of an object with the following name/value pair:

  • error – the error response, consisting of an object with the following name/value pairs:

    • status – the response HTTP status code (type of number)

    • message – a short description of the error that occurred (type of string)

    • parameter – the ID of the resource that caused the error (type of string)

Example

The following is an example of this structure:

{
    "error": {
        "status": 404,
        "message": "The specified Job Set passed into this method refers to a missing resource.",
        "parameter": "12345"
    }
}