Skip to main content

Examples

The error schema is part of the full Orgvue API schema available to inspect and download here.

Some sample JSON response bodies are included below for illustrative purposes. Remember that it is possible for multiple errors to be reported at once, so the JSON body will always contain an "errors" array.

Authentication Errors​

Using an IP restricted token from an address that is not allowed:

{
  "errors": [
    {
      "name": "ApiTokenSubnetViolation",
      "code": "40303",
      "message": "The API Token cannot be used from the current IP address: 0.0.0.0"
    }
  ]
}

Bad Request Errors​

Calling /api/v1/{tenantId}/datasets/{datasetId}/export/jsonRows where:

  • the datasetId passed is not a UUID
  • the Content-Type header passed is not application/json
{
  "errors": [
    {
      "name": "PathParameterMustBeUUIDString",
      "code": "400603",
      "message": "Path parameter {datasetId} must be a UUID string.",
      "pathParameter": "{datasetId}"
    },
    {
      "code": "415001",
      "name": "ContentTypeIsNotImplemented",
      "message": "The content type header value you provided is not implemented, please use application/json instead."
    }
  ]
}