Error Handlinglink

The Infraspeak 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, while codes in the 4xx range indicate an error that failed given the information provided. Codes in the 5xx range indicate an error related to Infraspeak's servers (these are rare).

Error Response Formatlink

Errors return both an appropriate HTTP status code and response object which contains a http_code and message attribute describing the error. If it is related to a validation error, a properties attribute is included giving more context over the error. E.g.:

{
  "status": "error",
  "error": {
    "http_code": 400,
    "message": "Property validation error.",
    "properties": {
      "name": [
        "You must provide a value for the name field."
      ],
      "code": [
        "You must provide a value for the code field."
      ]
    }
  }
}

Error Fieldslink

HTTP Status Codeslink