Documentation

General api information

• Data structure follows "Json API" standard, with addition of upsert PUT requests.
• Bearer authentication scheme is used for authentication.
• PUT http requests will overwrite the existing resource.
• API Breaking change guidelines can be found here.

Error responses

400 Bad Request

{
  "errors": [
    {
      "status": 400,
      "detail": "data.attributes.uprn is required"
    },
    {
      "status": 400,
      "detail": "data.attributes.agents is required"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

401 Unauthorized

{
  "errors": [
    {
      "status": "401",
      "detail": "Authentication credentials were missing or incorrect"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

403 Forbidden

{
  "errors": [
    {
      "status": "403",
      "detail": "Forbidden"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

404 Not Found

{
  "errors": [
    {
      "status": "404",
      "detail": "Resource does not exist"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "status": "500",
      "detail": "Internal Server Error"
    }
  ],
  "meta": {
    "requestId": "30398b8a-4e52-4f93-8868-1c0de2b6f829"
  }
}