Skip to main content
POST
/
cad-integration-handler
/
fields
Allows for metadata fields to be set on a CAD Incident. 
curl --request POST \
  --url https://realtime.govworx.net/cad-integration-handler/fields \
  --header 'Content-Type: application/json' \
  --data '
{
  "callId": "<string>",
  "incidentId": "<string>",
  "fields": [
    {
      "name": "<string>",
      "value": "<string>",
      "cad_field_name": "<string>"
    }
  ]
}
'

Documentation Index

Fetch the complete documentation index at: https://developers.govworx.ai/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Allows for setting the values of CAD Incident Fields.

​
callId
string

Unique Assist Call ID.

​
incidentId
string

Unique CAD Incident ID.

​
fields
object[]

Field values that Assist is expecting to set in the CAD for the given Incident.

Assist does not send the optional cadFieldName. CAD systems must map to the most appropriate field.

INCIDENT_TYPE - The type of Incident, Incident Code, or Chief Complaint. Typically a code or short-hand value, like ABVEH (Abandoned Vehicle). If the CAD sends this value, and it matches an Assist Guide Card, then Assist will pre-populate the Guide Card instead of attempting to detect the most relevant Guide Card on its own.

INCIDENT_DESCRIPTION - Description of Incident as entered by Call Taker. If no INCIDENT_TYPE is provided, this may be used by Assist to select an initial Guide Card.

INCIDENT_PRIORITY - Priority of the incident as determined by Assist.

CALL_SUMMARY - A summary of the call up until the current point in time. Assist will send this periodically during an active Call.

If Assist sends fields that the CAD does not support or recognize, do not set them, and just return a "200 OK" response.

Response

Indicates the fields have been set as expected.