Skip to content
Docs
Select language:English

/api/v1/incidents/{id} (GET)

GET
/api/v1/incidents/{id}
curl --request GET \
  --url https://example.com/api/v1/incidents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
kind
required
string
occurredOn
required
string
policeReference
required
string | null
insurerReference
required
string | null
thingCount
required
integer
>= -9007199254740991 <= 9007199254740991
claimCount
required
integer
>= -9007199254740991 <= 9007199254740991
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
notes
required
string | null
things
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
key
additional properties
claims
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
thingId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
status
required
string
reference
required
string | null
documents
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
key
additional properties
createdBy
required
object
displayName
required
string
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "kind": "example",
  "occurredOn": "example",
  "policeReference": "example",
  "insurerReference": "example",
  "thingCount": 1,
  "claimCount": 1,
  "rowVersion": 1,
  "notes": "example",
  "things": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "claims": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "thingId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "status": "example",
      "reference": "example"
    }
  ],
  "documents": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ],
  "createdBy": {
    "displayName": "example"
  }
}