Skip to end of metadata
Go to start of metadata

HTTP Status Codes

Below is a detailed outline of the status codes and messages used in the API.

Status Code

Message

Description

200

Success

  • Used for general success.
  • Used when a POST operation results in the creation of a new resource (such that response should contain URI of newly created resource).

400

Bad Request

  • Used when one or more parameters are invalid.
  • Used when one or more required parameters are missing.
  • Used when the JSON payload is not valid JSON.

403

Forbidden

  • Used when the operation fails security checks (e.g. wrong app ID specified as input to retrieve specific data).

404

Not Found

  • Used when the requested resource does not exist (e.g. app ID).

500

Internal Server Error

  • Used when the (internal) server is down.

Error Payloads

Each failed response will include a JSON payload that includes the error code number and message:

400

The actual message for this "Bad Request" error will vary depending on whether the error was caused by bad data sent in the request, a validation error when validating the request data or any other generic request error.

{
    "error": 
	{
        "code": 400,
        "message": <error string>
    }
}

403

The actual message for this "Forbidden" error will vary.

{
    "error": 
	{
        "code": 403,
        "message": <error string>
    }
}

404

The actual message for this "Not Found" error will vary depending on what could not be found.

{
    "error": 
	{
        "code": 404,
        "message": <error string>
    }
}

500

{
    "data": 
	{
        "code": 500,
        "message": "An unknown error occurred."
    }
} 

ON THIS PAGE

  • No labels