Errors - Advocate API

Advocate employs standard HTTP response codes to signify the outcome of an API request. In general:

HTTP response codes in the 2xx range signify a successful operation.
HTTP response codes in the 4xx range indicate an error related to the request, which may result from issues such as an omitted required parameter or a failed charge.
HTTP response codes in the 5xx range indicate an error on Advocate’s servers, although these are infrequent.

HTTP Status Code Summary

Code - Name	Description
200 - OK	Everything worked as expected.
201 - Created	The resource was created successfully.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
402 - Request Failed	The parameters were valid but the request failed.
403 - Forbidden	The API key doesn’t have permissions to perform the request.
404 - Not Found	The requested resource doesn’t exist.
409 - Conflict	The request conflicts with existing data (for example a duplicate name).
422 - Unprocessable Entity	The request body failed validation. The response lists the failing fields.
429 - Rate Limited	The requested was rate limited after exceeding the quotas
500, 502, 503, 504 - Server Errors	Something went wrong on Advocate’s end. (These are rare.)

Attributes

Property	Type	Description
status	`String`	Status code associated with the error
name	`[{fieldID as String : {value: Mixed, key: String}}]`	Type of error that is encountered
message	`String`	Error message to help understand the issue

Validation errors (422)

Validation failures return field-level details so you can pinpoint the failing input:

{
  "statusCode": 422,
  "message": [
    { "field": "isNotEmpty", "message": "name should not be empty" },
    { "field": "isEmail", "message": "email must be an email" }
  ],
  "error": "Unprocessable Entity"
}

​HTTP Status Code Summary

​Attributes

​Validation errors (422)

HTTP Status Code Summary

Attributes

Validation errors (422)