Errors

We use conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with our servers.

Some 4xx errors that could be handled programmatically include an error code that briefly explains the error reported.

Below is a non-exhaustive list of the type of HTTP response codes you can expect:

HTTP Status Code

200 OK Everything worked as expected. 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. 429 Too Many Requests Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. 500 Server Error Something went wrong on our server. 502 Bad Gateway Something went wrong on our network. 503 Service Unavailable Our service is temporarily unavailable, often due to planned maintenance. 504 Gateway Timeout Something went wrong on our network or an ISP is experiencing an outage.

Error Model

Whenever a request is unsuccessful, our API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it. Most of the error messages are pretty helpful and actionable.

error_code string

Errors include an error code - a short string with a brief explanation. These codes play a role in your ability to look up an error on this site. Each service will have it's own unique list of error codes.

message string

Additional information about what error occurred.

documentation_url string

Relevant documentation for the error or a link to the services master error code list.

Error response

{ "error_code": "api_error", "message": "No way this is happening!?", "documentation_url": "https://developers.gpcoservices.com/errors" }

Copy