Introduction

When working with Alarm Organizations (Client Sites that have the Mobile Dispatch setting turned on), Alarm Types must be defined to map the types of alarm responses to Job Types (named task-types in the API) and to assign an identification code for the Alarm Type.

After you've set up an Alarm Organization and is Dispatch Settings, the next step should be to configure the Alarm Types.

In the API, you can access Alarm Types via the /alarm-types endpoint:

[GET] /alarm-types

{
            "customId": "123478",
            "code": "1267",
            "name": "Alarm Main Door",
            "alarmOrganization": 627,
            "taskType": 98,
            "status": "ACTIVE",
            "id": 4
}

Notes:

alarmOrganization : The clients.id value of the Client Site configured to be an Alarm Organization (review /clients and /alarm-organizations for more context)

taskType : The task-types.id value of a Task Type (named Job Type in the UI) is a category for dispatches and are linked to a Report Template (review /task-types)

customId and code : These are user defined fields to help identify the Alarm Type using unique identifiers for internal reference and to assist with joins with unique identifiers in other systems being integrated with.

Creating an Alarm Type

[POST] /alarm-types

{

    "customId": "C123-A",
    "code": "string",
    "name": "Sample Name",
    "alarmOrganization": 123,
    "taskType": 123

}