Modify Identifier

This endpoint allows you to add, edit, or remove unit identifiers.

This API endpoint requires the Pro version of Sonoran CAD or higher. For more information, see our pricing page.

Modify Identifier

POST https://api.sonorancad.com/emergency/modify_identifier

This endpoint allows you to retrieve all unit identifiers for a specified account in your community.

Request Body

Name	Type	Description
id*	string	Your community's ID
key*	string	Your community's API Key
type*	string	MODIFY_IDENTIFIER
data*	array	Array of request objects

200 A successful call will be met with the following response:

// ADD or EDIT
{
    "id": 12,
    "accId": "00000000-0000-0000-0000-000000000000",
    "status": 0,
    "isPanic": false,
    "location": "",
    "aop": "Los Santos",
    "data": {
        "unitNum": "A-10",
        "name": "John Doe",
        "district": "Los Santos",
        "department": "LSPD",
        "subdivision": "Patrol",
        "rank": "Officer",
        "group": "CAR-51",
        "communityUserId": "license:abc123"
    },
    "isDispatch": false
}

// REMOVE
"Identifier 123 removed!"

400 The following 400 errors may be sent in response:

INVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "MODIFY_IDENTIFIER",
    "data": [
        {
            "apiId": "Steam:1234", // (OPTION 1): Generally the Steam HEX
            "account": "000-000-000", // (OPTION 2): Sonoran Account UUID
            "action": 0, // ADD
            "identifier": {
                // OPTIONAL: Only for ADD & EDIT actions
                "status": 0,
                "location": "",
                "aop": "Los Santos",
                "data": {
                    "unitNum": "A-10",
                    "name": "John Doe",
                    "district": "Los Santos",
                    "department": "LSPD",
                    "subdivision": "Patrol",
                    "rank": "Officer",
                    "group": "CAR-51",
                    "communityUserId": "license:abc123"
                }
            },
            "identId": 123 // OPTIONAL: Only for REMOVE action
        }
    ]
}

Action Enum

The action property is an enumerator value with the following values:

Enum (Int)	Description
0	ADD
1	EDIT
2	REMOVE