API is in Alpha and may change at any time.

API Resources > Emergency

Unit Status

Update your unit's status in the CAD via API.

Update Unit Status

POST api/v1/emergency/unit_status

Request Body

Name Type Description Default
user_id number Discord ID of the player. Required
status string New status. Accepted Status Options Required

Example Request Body

{
    "user_id": 123456789123456789,
    "status": "AVL"
}

Responses

200 A successful call.

{
    "success": true,
    "message": "Status updated.",
    "data": []
}

200 with error message if the unit was not found.

{
    "success": false,
    "message": "No active unit found for the given user.",
    "data": []
}

200 with validation error messages.

{
    "success": false,
    "message": "Validation errors",
    "data": {
        "user_id": [
            "The user id field is required.",
            "The user id field is required."
        ],
        "status": [
            "The status field is required.",
            "The selected status is invalid." // Not in given list below
        ]
    }
}

Status Options

ID is what the API expects as the status field.

ID Name
AVL Available
ENRUTE Enroute
ONSCN On Scene
BRK Break
OFFDTY - RPT Off duty and need to fill out report.

Still have questions?

Still have questions? Talk to support.