Incident Types (get) - R24 External Partner APIs

Request

Authorization

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/json

source_system_id

string <uuid>

required

The distinct identifier of the partner system tasked with supplying this data

risk_category_name

string

optional

Filter on the Risk Category

incident_type_name

string

optional

Filter on the Incident Type

Example

{
    "source_system_id": "da451eb5-33e4-b549-9c9f-8171276aed14",
    "risk_category_name": "",
    "incident_type_name": "bom"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://dev.your-api-server.comincident_types' \
--header 'Content-Type: application/json' \
--header 'x-api-key;' \
--data-raw '{
    "source_system_id": "da451eb5-33e4-b549-9c9f-8171276aed14",
    "risk_category_name": "",
    "incident_type_name": "bom"
}'

Responses

🟢200Success

application/json

Body

array of:

risk_category_code

string

required

Code for the Risk Category

risk_category_name

string

required

Name of the Risk Category

incident_type_code

string

required

Code for the Incident Type

incident_type_name

string

required

Name of the Incident Type

incident_type_description

string

required

Description of the Incident Type

Example

[
    {
        "risk_category_code": "B01",
        "risk_category_name": "Bombing",
        "incident_type_code": "B01-0001",
        "incident_type_name": "Bomb Threat",
        "incident_type_description": " A threat, usually verbal or written, to detonate an explosive or incendiary device to cause property damage, death, injuries, and/or incite fear, whether such a device exists."
    },
    {
        "risk_category_code": "A01",
        "risk_category_name": "Air",
        "incident_type_code": "A01-0005",
        "incident_type_name": "Bomber",
        "incident_type_description": " Incidents involving bomber aircraft or airstrikes carried out by fixed wing aircraft (regardless of the type of fixed wing aircraft used in the airstrike.)"
    },
    {
        "risk_category_code": "S01",
        "risk_category_name": "Suicide/Complex",
        "incident_type_code": "S01-0006",
        "incident_type_name": "Vehicle Bomb",
        "incident_type_description": "An improvised explosive device placed in a vehicle and detonated without the intent of suicide by the perpetrator."
    }
]

🟠401Unauthorized

🟠400Bad Request