Errors

Errors

Geo2 API uses 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 user not found, insufficient permissions, etc.).  Codes in the 5xx range indicate an error with Geo2's servers (these are rare).

Code

Description

Example value

Code

Description

Example value

201 - OK

Everything worked as expected.

Code Block
{ "data": { "loadId": "ltyDxSBeFvN4C33mOLpB" }, "status": "OK" }

 

400 - Bad Request

The request was unacceptable, often due to missing a required parameter.

Code Block
{ "data": { "code": "BAD_REQUEST", "message": "Bad request" }, "status": "ERROR", "description": { "value": "object", "errors": [ "string" ], "inner": [ "object" ], "name": "ValidationError", "message": "string" } }

 

401 - Unauthorized

No valid API key provided.

Code Block
{ "data": { "code": "UNAUTHORIZED", "message": "Unauthorized" }, "status": "ERROR" }

 

403 - Forbidden

The API key doesn't have permission to perform the request.

Code Block
{ "data": { "code": "TOKEN_PERMISSIONS", "message": "Insufficient permissions" }, "status": "ERROR" }

 

500 - Internal Server Error

Something went wrong on Geo2's end. (These are rare.)

Code Block
{ "data": { "code": "LOAD_GET", "message": "GET load error" }, "status": "ERROR" }

 

 

 

Related content