# Table of Contents - [API Integration | CAD | Sonoran Software Documentation](#api-integration-cad-sonoran-software-documentation) - [Getting Started | CAD | Sonoran Software Documentation](#getting-started-cad-sonoran-software-documentation) - [Unknown](#unknown) - [Unknown](#unknown) - [Retrieving Your Credentials | CAD | Sonoran Software Documentation](#retrieving-your-credentials-cad-sonoran-software-documentation) - [Map Players to CAD Users | CAD | Sonoran Software Documentation](#map-players-to-cad-users-cad-sonoran-software-documentation) - [Unknown](#unknown) - [Unknown](#unknown) - [Libraries | CAD | Sonoran Software Documentation](#libraries-cad-sonoran-software-documentation) - [Emergency | CAD | Sonoran Software Documentation](#emergency-cad-sonoran-software-documentation) - [Emergency | CAD | Sonoran Software Documentation](#emergency-cad-sonoran-software-documentation) - [General | CAD | Sonoran Software Documentation](#general-cad-sonoran-software-documentation) - [Civilian | CAD | Sonoran Software Documentation](#civilian-cad-sonoran-software-documentation) - [Unknown](#unknown) - [Dispatch and Emergency Calls | CAD | Sonoran Software Documentation](#dispatch-and-emergency-calls-cad-sonoran-software-documentation) - [Identifiers | CAD | Sonoran Software Documentation](#identifiers-cad-sonoran-software-documentation) - [Station Alert | CAD | Sonoran Software Documentation](#station-alert-cad-sonoran-software-documentation) - [Custom Blips | CAD | Sonoran Software Documentation](#custom-blips-cad-sonoran-software-documentation) - [Street Signs | CAD | Sonoran Software Documentation](#street-signs-cad-sonoran-software-documentation) - [ERS | CAD | Sonoran Software Documentation](#ers-cad-sonoran-software-documentation) - [Inferno Pagers | CAD | Sonoran Software Documentation](#inferno-pagers-cad-sonoran-software-documentation) - [Unknown](#unknown) - [Set Identifier | CAD | Sonoran Software Documentation](#set-identifier-cad-sonoran-software-documentation) - [Remove Blip | CAD | Sonoran Software Documentation](#remove-blip-cad-sonoran-software-documentation) - [Kick Unit | CAD | Sonoran Software Documentation](#kick-unit-cad-sonoran-software-documentation) - [Update Call Postal | CAD | Sonoran Software Documentation](#update-call-postal-cad-sonoran-software-documentation) - [Unit Panic | CAD | Sonoran Software Documentation](#unit-panic-cad-sonoran-software-documentation) - [Attach Unit | CAD | Sonoran Software Documentation](#attach-unit-cad-sonoran-software-documentation) - [Close Dispatch | CAD | Sonoran Software Documentation](#close-dispatch-cad-sonoran-software-documentation) - [Add Blip | CAD | Sonoran Software Documentation](#add-blip-cad-sonoran-software-documentation) - [Set Available Callouts | CAD | Sonoran Software Documentation](#set-available-callouts-cad-sonoran-software-documentation) - [Update Call Primary | CAD | Sonoran Software Documentation](#update-call-primary-cad-sonoran-software-documentation) - [Update Street Sign | CAD | Sonoran Software Documentation](#update-street-sign-cad-sonoran-software-documentation) - [Remove Record | CAD | Sonoran Software Documentation](#remove-record-cad-sonoran-software-documentation) - [Edit Record | CAD | Sonoran Software Documentation](#edit-record-cad-sonoran-software-documentation) - [Get Identifiers | CAD | Sonoran Software Documentation](#get-identifiers-cad-sonoran-software-documentation) - [Add Call Note | CAD | Sonoran Software Documentation](#add-call-note-cad-sonoran-software-documentation) - [Set Stations | CAD | Sonoran Software Documentation](#set-stations-cad-sonoran-software-documentation) - [Detach Unit | CAD | Sonoran Software Documentation](#detach-unit-cad-sonoran-software-documentation) - [Set Street Sign Config | CAD | Sonoran Software Documentation](#set-street-sign-config-cad-sonoran-software-documentation) - [Remove 911 | CAD | Sonoran Software Documentation](#remove-911-cad-sonoran-software-documentation) - [Set Ident Group | CAD | Sonoran Software Documentation](#set-ident-group-cad-sonoran-software-documentation) - [Get Map Blips | CAD | Sonoran Software Documentation](#get-map-blips-cad-sonoran-software-documentation) - [Get Record Templates | CAD | Sonoran Software Documentation](#get-record-templates-cad-sonoran-software-documentation) - [New Record | CAD | Sonoran Software Documentation](#new-record-cad-sonoran-software-documentation) - [Set Pager Config | CAD | Sonoran Software Documentation](#set-pager-config-cad-sonoran-software-documentation) - [Update Unit Location | CAD | Sonoran Software Documentation](#update-unit-location-cad-sonoran-software-documentation) - [Unknown](#unknown) - [Get Pager Config | CAD | Sonoran Software Documentation](#get-pager-config-cad-sonoran-software-documentation) - [Modify Identifier | CAD | Sonoran Software Documentation](#modify-identifier-cad-sonoran-software-documentation) - [Unit Status | CAD | Sonoran Software Documentation](#unit-status-cad-sonoran-software-documentation) - [Websocket API | CAD | Sonoran Software Documentation](#websocket-api-cad-sonoran-software-documentation) - [Development Branch | CAD | Sonoran Software Documentation](#development-branch-cad-sonoran-software-documentation) - [Modify Blip | CAD | Sonoran Software Documentation](#modify-blip-cad-sonoran-software-documentation) - [Get Version | CAD | Sonoran Software Documentation](#get-version-cad-sonoran-software-documentation) - [Get Servers | CAD | Sonoran Software Documentation](#get-servers-cad-sonoran-software-documentation) - [Auth Street Signs | CAD | Sonoran Software Documentation](#auth-street-signs-cad-sonoran-software-documentation) - [Set Servers | CAD | Sonoran Software Documentation](#set-servers-cad-sonoran-software-documentation) - [Authentication | CAD | Sonoran Software Documentation](#authentication-cad-sonoran-software-documentation) - [API Endpoints | CAD | Sonoran Software Documentation](#api-endpoints-cad-sonoran-software-documentation) - [Verify Secret | CAD | Sonoran Software Documentation](#verify-secret-cad-sonoran-software-documentation) - [New 911 Call | CAD | Sonoran Software Documentation](#new-911-call-cad-sonoran-software-documentation) - [Apply Permission Key | CAD | Sonoran Software Documentation](#apply-permission-key-cad-sonoran-software-documentation) - [Check API ID | CAD | Sonoran Software Documentation](#check-api-id-cad-sonoran-software-documentation) --- # API Integration | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration.md) . ![](https://docs.sonoransoftware.com/~gitbook/image?url=https%3A%2F%2F232668649-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M4pGN81fb4R6zFhodcu%252Fuploads%252FLK84lZNRx7sYzRPHAThK%252Fapi-integration.png%3Falt%3Dmedia%26token%3Da4edc2b3-162c-48c3-a074-90bebfeec361&width=768&dpr=3&quality=100&sign=825c929f&sv=2) How are API calls sent?[](https://docs.sonoransoftware.com/cad/api-integration#how-are-api-calls-sent) ------------------------------------------------------------------------------------------------------- All API calls are sent via an HTTP POST with a JSON formatted body. GitBook Assistant Can I integrate this with my gamemode/framework?[](https://docs.sonoransoftware.com/cad/api-integration#can-i-integrate-this-with-my-gamemode-framework) --------------------------------------------------------------------------------------------------------------------------------------------------------- Yes, our API calls can be integrated into nearly any gamemode with nearly any programming language. GitBook Assistant We provide a library of drag-and-drop plugins written in Lua. GitBook Assistant You can also write your own script using our API endpoints: GitBook Assistant [API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints) Easily integrate external scripts with our LUA and JS export examples: GitBook Assistant Or, learn more about receiving push events directly to your game server: GitBook Assistant [Push Events](https://docs.sonoransoftware.com/cad/api-integration/push-events) Are there rate limits?[](https://docs.sonoransoftware.com/cad/api-integration#are-there-rate-limits) ----------------------------------------------------------------------------------------------------- Yes, Sonoran CAD will automatically block any malicious or spammed traffic. While we don't publicly publish these limits, it's best to not make more than one call per second for an extended period of time. GitBook Assistant [Getting Started](https://docs.sonoransoftware.com/cad/api-integration/getting-started) [PreviousCall Editor Pin Drop](https://docs.sonoransoftware.com/cad/integration-plugins/erlc/call-editor-pin-drop) [NextGetting Started](https://docs.sonoransoftware.com/cad/api-integration/getting-started) Last updated 1 year ago Was this helpful? This site uses cookies to deliver its service and to analyze traffic. By browsing this site, you accept the [privacy policy](https://docs.sonoransoftware.com/policy/policy/privacy-policy) . AcceptReject --- # Getting Started | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/getting-started.md) . Gather Your Credentials[](https://docs.sonoransoftware.com/cad/api-integration/getting-started#gather-your-credentials) ------------------------------------------------------------------------------------------------------------------------ All API calls require some basic authentication. Here's how to find your community ID and API key. GitBook Assistant [Retrieving Your Credentials](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials) ### Map In-Game Users to CAD Users[](https://docs.sonoransoftware.com/cad/api-integration/getting-started#map-in-game-users-to-cad-users) Before you can update units, send calls, or read player data, your integration needs a way to resolve an in-game player to a Sonoran CAD account. GitBook Assistant [Map Players to CAD Users](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id) ### Start Building[](https://docs.sonoransoftware.com/cad/api-integration/getting-started#start-building) Use the official SDK libraries for package-managed helpers, or work directly with the v2 API documentation. GitBook Assistant [Libraries](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/libraries) [v2 API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2) [PreviousAPI Integration](https://docs.sonoransoftware.com/cad/api-integration) [NextRetrieving Your Credentials](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials) Last updated 3 months ago Was this helpful? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration.md). # API Integration ![](https://docs.sonoransoftware.com/files/fZPLggM1aQVQQ7YKDsxJ) \## How are API calls sent? All API calls are sent via an HTTP POST with a JSON formatted body. ## Can I integrate this with my gamemode/framework? Yes, our API calls can be integrated into nearly any gamemode with nearly any programming language. We provide a library of drag-and-drop plugins written in Lua. You can also write your own script using our API endpoints: {% content-ref url="/pages/-M4pV5Pnc864R0IwW6k9" %} \[API Endpoints\](/cad/api-integration/api-endpoints.md) {% endcontent-ref %} Easily integrate external scripts with our LUA and JS export examples: {% content-ref url="/pages/ONoZRRBy208JfLTCy8VK" %} \[Broken mention\](broken://pages/ONoZRRBy208JfLTCy8VK) {% endcontent-ref %} Or, learn more about receiving push events directly to your game server: {% content-ref url="/pages/-M7F7RghOsB9573hMysj" %} \[Push Events\](/cad/api-integration/push-events.md) {% endcontent-ref %} ## Are there rate limits? Yes, Sonoran CAD will automatically block any malicious or spammed traffic. While we don't publicly publish these limits, it's best to not make more than one call per second for an extended period of time. {% content-ref url="/pages/-M4pV13Ik4JO9SxAZzyV" %} \[Getting Started\](/cad/api-integration/getting-started.md) {% endcontent-ref %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration/getting-started.md). # Getting Started ## Gather Your Credentials All API calls require some basic authentication. Here's how to find your community ID and API key. {% content-ref url="/pages/-M4pT5x6nE7Vl8raWJFM" %} \[Retrieving Your Credentials\](/cad/api-integration/getting-started/retrieving-your-credentials.md) {% endcontent-ref %} ### Map In-Game Users to CAD Users Before you can update units, send calls, or read player data, your integration needs a way to resolve an in-game player to a Sonoran CAD account. {% content-ref url="/pages/-M4pVBkmw1Dy\\\_9dJqP7y" %} \[Map Players to CAD Users\](/cad/api-integration/getting-started/setting-your-api-id.md) {% endcontent-ref %} ### Start Building Use the official SDK libraries for package-managed helpers, or work directly with the v2 API documentation. {% content-ref url="/pages/sLVKmvKCaN5W9LL1URgj" %} \[Libraries\](/cad/api-integration/api-endpoints-v2/libraries.md) {% endcontent-ref %} {% content-ref url="/pages/fCGn9u1XGqiHwYJQM2bW" %} \[v2 API Endpoints\](/cad/api-integration/api-endpoints-v2.md) {% endcontent-ref %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration/getting-started.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Retrieving Your Credentials | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials.md) . ### Retrieving Your Credentials[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials#retrieving-your-credentials) API credentials are shown under **Admin** > **In-Game Integration** > **API** GitBook Assistant Click to copy your community ID and API key. GitBook Assistant ![](https://docs.sonoransoftware.com/~gitbook/image?url=https%3A%2F%2F232668649-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M4pGN81fb4R6zFhodcu%252Fuploads%252F3Pz2phAbewY36V1oOrAv%252FScreenshot%25202026-04-28%2520at%252011.59.15%25E2%2580%25AFPM.png%3Falt%3Dmedia%26token%3D0a66e10b-b8cd-4287-b192-65c84a7cce88&width=768&dpr=3&quality=100&sign=8401ad5&sv=2) [PreviousGetting Started](https://docs.sonoransoftware.com/cad/api-integration/getting-started) [NextMap Players to CAD Users](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id) Last updated 3 months ago Was this helpful? Was this helpful? --- # Map Players to CAD Users | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id.md) . Your integration must be able to tell Sonoran CAD which account an in-game player belongs to. There are four main ways to do that. GitBook Assistant Option 1: `communityUserId`[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-1-communityuserid) ------------------------------------------------------------------------------------------------------------------------------------------------- Use `communityUserId` when your game server controls its own player identifier, such as FiveM. GitBook Assistant This is the default approach used by our [FiveM integration resource](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation) . Players link their CAD account in-game with [`/link`](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/link-user-in-game) , and Sonoran CAD stores the player's game identifier in the account's `communityUserId` field. GitBook Assistant If you need to go from a CAD push event or API response back to an in-game FiveM player, use that same `communityUserId` as your join key. Our FiveM resource documents this flow in [LINKING\_V2.md](https://github.com/Sonoran-Software/SonoranCADFiveM/blob/master/sonorancad/LINKING_V2.md) and exposes `exports.sonorancad:getPlayerCommunityUserId(source)` for third-party resources. GitBook Assistant For example, a push event may include `communityUserId = "license:abc123"`. Your server can compare that to the value returned by `getPlayerCommunityUserId(source)` for connected players, or use it alongside the cached unit payload described in [GetUnitCache](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/framework-development-documentation/server-functions#getunitcache) . GitBook Assistant By default, the FiveM resource uses the `primaryIdentifier` config value, which is set to `license` unless you change it. GitBook Assistant #### Create Community Link[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#create-community-link) Use the following endpoint to create a 4-character link code and associate it with your game's unique player identifier. GitBook Assistant * [Create Community Link](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/general/accounts/create-community-link) GitBook Assistant #### Complete User Link[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#complete-user-link) Users can complete the link verification by logging in and visiting `sonorancad.com/id?code=1234`. This completes the link and automatically joins the user to the community (if not already). GitBook Assistant #### Automatic Link from an Embedded CAD[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#automatic-link-from-an-embedded-cad) As an alternative to the manual 4-character code, the Sonoran CAD frontend emits a message after every successful community login, re-login, or reconnect when it is displayed inside an iframe: GitBook Assistant GitBook AssistantAskCopy { type: 'scad:account-link', accountUuid: '11111111-1111-1111-1111-111111111111', secretUuid: '22222222-2222-2222-2222-222222222222' } The iframe parent should validate the message source and origin, forward the two UUIDs to its trusted server process, derive the current player's `communityUserId`, and call [Set Community Link](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/general/accounts/set-community-link) . The frontend event intentionally does not contain the in-game identifier. GitBook Assistant Keep the secret UUID server-bound: do not log it or store it in the browser, and never expose the community API key to the iframe or game client. See the endpoint documentation for the complete event listener and server-side flow. GitBook Assistant #### Check User Link[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#check-user-link) Use the following API endpoint and push event to programmatically confirm that a user has completed the link. GitBook Assistant * [Check Community Link](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/general/accounts/check-community-link) GitBook Assistant * [Community Link Verified](https://docs.sonoransoftware.com/cad/api-integration/push-events/community-link-verified) GitBook Assistant Once linked, pass `communityUserId` to supported v2 endpoints to target that player's Sonoran CAD account. GitBook Assistant Option 2: Roblox account linking[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-2-roblox-account-linking) ------------------------------------------------------------------------------------------------------------------------------------------------------------- Use Roblox account linking when the player's Roblox identity is already the source of truth for your integration. GitBook Assistant Players can link their Roblox account directly to their Sonoran account. Our [ER:LC getting started guide](https://docs.sonoransoftware.com/cad/integration-plugins/erlc/getting-started#linking-your-roblox-account) walks through that flow. GitBook Assistant After the account is linked, use the `roblox` parameter on supported v2 endpoints instead of `communityUserId`. GitBook Assistant This is the preferred approach for Roblox-based integrations because it targets the linked Roblox account directly. GitBook Assistant Option 3: Discord account linking[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-3-discord-account-linking) --------------------------------------------------------------------------------------------------------------------------------------------------------------- Use Discord account linking when the player's Discord identity is already the source of truth for your integration. GitBook Assistant Players can link their Discord account directly to their Sonoran account through OAuth. After the account is linked, use the `discord` parameter on supported v2 endpoints instead of `communityUserId`. GitBook Assistant Option 4: account secret key to `accountUuid`[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-4-account-secret-key-to-accountuuid) ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Use an account secret key when you already have a trusted Sonoran account secret and need to resolve it to the user's Sonoran account UUID. GitBook Assistant #### User Secret ID[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#user-secret-id) User's can copy their account's secret ID from the settings panel. GitBook Assistant ![](https://docs.sonoransoftware.com/~gitbook/image?url=https%3A%2F%2F232668649-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-M4pGN81fb4R6zFhodcu%252Fuploads%252FgJUXnhJd7A9apzXoEcpO%252FScreenshot%25202026-04-29%2520at%252012.20.10%25E2%2580%25AFAM.png%3Falt%3Dmedia%26token%3D95d30976-f181-463c-937b-44defd3164ad&width=768&dpr=3&quality=100&sign=df3b2651&sv=2) #### Verify the Secret[](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#verify-the-secret) Use the following endpoint to verify the secret ID and get the user's Sonoran account UUID GitBook Assistant * [Verify Secret](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/general/accounts/verify-secret) GitBook Assistant You can then use `accountUuid` on supported v2 endpoints. GitBook Assistant Support for `accountUuid` is more limited than `communityUserId`, `roblox`, or `discord`, so this should usually be treated as a fallback rather than your primary mapping strategy. Reach out to our development team if more expansion is required for your application. GitBook Assistant [PreviousRetrieving Your Credentials](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials) [Nextv2 API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2) Last updated 8 days ago Was this helpful? * [Option 1: communityUserId](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-1-communityuserid) * [Option 2: Roblox account linking](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-2-roblox-account-linking) * [Option 3: Discord account linking](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-3-discord-account-linking) * [Option 4: account secret key to accountUuid](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id#option-4-account-secret-key-to-accountuuid) Was this helpful? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials.md). # Retrieving Your Credentials ### Retrieving Your Credentials API credentials are shown under \*\*Admin\*\* > \*\*In-Game Integration\*\* > \*\*API\*\* Click to copy your community ID and API key. ![](https://docs.sonoransoftware.com/files/cA21mwa3ArETvZr6V4uM) \--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration/getting-started/retrieving-your-credentials.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id.md). # Map Players to CAD Users Your integration must be able to tell Sonoran CAD which account an in-game player belongs to. There are four main ways to do that. ## Option 1: \`communityUserId\` Use \`communityUserId\` when your game server controls its own player identifier, such as FiveM. This is the default approach used by our \[FiveM integration resource\](/cad/integration-plugins/in-game-integration/fivem-installation.md). Players link their CAD account in-game with \[\`/link\`\](/cad/integration-plugins/in-game-integration/link-user-in-game.md), and Sonoran CAD stores the player's game identifier in the account's \`communityUserId\` field. If you need to go from a CAD push event or API response back to an in-game FiveM player, use that same \`communityUserId\` as your join key. Our FiveM resource documents this flow in \[LINKING\\\_V2.md\](https://github.com/Sonoran-Software/SonoranCADFiveM/blob/master/sonorancad/LINKING\_V2.md) and exposes \`exports.sonorancad:getPlayerCommunityUserId(source)\` for third-party resources. For example, a push event may include \`communityUserId = "license:abc123"\`. Your server can compare that to the value returned by \`getPlayerCommunityUserId(source)\` for connected players, or use it alongside the cached unit payload described in \[GetUnitCache\](/cad/integration-plugins/in-game-integration/framework-development-documentation/server-functions.md#getunitcache). By default, the FiveM resource uses the \`primaryIdentifier\` config value, which is set to \`license\` unless you change it. #### Create Community Link Use the following endpoint to create a 4-character link code and associate it with your game's unique player identifier. \* \[Create Community Link\](/cad/api-integration/api-endpoints-v2/general/accounts/create-community-link.md) #### Complete User Link Users can complete the link verification by logging in and visiting \`sonorancad.com/id?code=1234\`. This completes the link and automatically joins the user to the community (if not already). #### Automatic Link from an Embedded CAD As an alternative to the manual 4-character code, the Sonoran CAD frontend emits a message after every successful community login, re-login, or reconnect when it is displayed inside an iframe: \`\`\`javascript { type: 'scad:account-link', accountUuid: '11111111-1111-1111-1111-111111111111', secretUuid: '22222222-2222-2222-2222-222222222222' } \`\`\` The iframe parent should validate the message source and origin, forward the two UUIDs to its trusted server process, derive the current player's \`communityUserId\`, and call \[Set Community Link\](/cad/api-integration/api-endpoints-v2/general/accounts/set-community-link.md). The frontend event intentionally does not contain the in-game identifier. Keep the secret UUID server-bound: do not log it or store it in the browser, and never expose the community API key to the iframe or game client. See the endpoint documentation for the complete event listener and server-side flow. #### Check User Link Use the following API endpoint and push event to programmatically confirm that a user has completed the link. \* \[Check Community Link\](/cad/api-integration/api-endpoints-v2/general/accounts/check-community-link.md) \* \[Community Link Verified\](/cad/api-integration/push-events/community-link-verified.md) Once linked, pass \`communityUserId\` to supported v2 endpoints to target that player's Sonoran CAD account. ## Option 2: Roblox account linking Use Roblox account linking when the player's Roblox identity is already the source of truth for your integration. Players can link their Roblox account directly to their Sonoran account. Our \[ER:LC getting started guide\](/cad/integration-plugins/erlc/getting-started.md#linking-your-roblox-account) walks through that flow. After the account is linked, use the \`roblox\` parameter on supported v2 endpoints instead of \`communityUserId\`. This is the preferred approach for Roblox-based integrations because it targets the linked Roblox account directly. ## Option 3: Discord account linking Use Discord account linking when the player's Discord identity is already the source of truth for your integration. Players can link their Discord account directly to their Sonoran account through OAuth. After the account is linked, use the \`discord\` parameter on supported v2 endpoints instead of \`communityUserId\`. ## Option 4: account secret key to \`accountUuid\` Use an account secret key when you already have a trusted Sonoran account secret and need to resolve it to the user's Sonoran account UUID. #### User Secret ID User's can copy their account's secret ID from the settings panel.
#### Verify the Secret Use the following endpoint to verify the secret ID and get the user's Sonoran account UUID \* \[Verify Secret\](/cad/api-integration/api-endpoints-v2/general/accounts/verify-secret.md) You can then use \`accountUuid\` on supported v2 endpoints. Support for \`accountUuid\` is more limited than \`communityUserId\`, \`roblox\`, or \`discord\`, so this should usually be treated as a fallback rather than your primary mapping strategy. Reach out to our development team if more expansion is required for your application. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Libraries | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/libraries.md) . The official Sonoran SDK libraries provide package-managed access to Sonoran CAD integrations and v2 API helpers. GitBook Assistant Package Manager Links[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/libraries#package-manager-links) ------------------------------------------------------------------------------------------------------------------------------- * [Sonoran.js on npm](https://www.npmjs.com/package/@sonoransoftware/sonoran.js) GitBook Assistant * [Sonoran.lua on LuaRocks](https://luarocks.org/modules/sonoransoftware/sonoran.lua) GitBook Assistant * [Sonoran.Net on NuGet](https://www.nuget.org/packages/Sonoran.Net) GitBook Assistant * [Sonoran.py on PyPI](https://pypi.org/project/Sonoran.py/) GitBook Assistant [Previousv2 API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2) [NextAuthentication](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/authentication) Last updated 3 months ago Was this helpful? Was this helpful? --- # Emergency | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency.md) . The v2 emergency API includes unit state updates, identifier management, dispatch and 911 call management, custom blips, and emergency configuration endpoints. GitBook Assistant Categories[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency#categories) --------------------------------------------------------------------------------------------------------- [Units](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency/units) [Identifiers](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency/identifiers) [Calls](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency/calls) [Map](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency/map) [Configuration](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency/configuration) [PreviousAuthentication](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/authentication) [NextUnits](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency/units) Last updated 3 months ago Was this helpful? Was this helpful? --- # Emergency | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency.md) . Last updated 4 years ago Was this helpful? Was this helpful? --- # General | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general.md) . Last updated 4 years ago Was this helpful? Was this helpful? --- # Civilian | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/civilian.md) . Last updated 4 years ago Was this helpful? Was this helpful? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/libraries.md). # Libraries The official Sonoran SDK libraries provide package-managed access to Sonoran CAD integrations and v2 API helpers. ## Package Manager Links \* \[Sonoran.js on npm\](https://www.npmjs.com/package/@sonoransoftware/sonoran.js) \* \[Sonoran.lua on LuaRocks\](https://luarocks.org/modules/sonoransoftware/sonoran.lua) \* \[Sonoran.Net on NuGet\](https://www.nuget.org/packages/Sonoran.Net) \* \[Sonoran.py on PyPI\](https://pypi.org/project/Sonoran.py/) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/libraries.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Dispatch and Emergency Calls | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls.md) . Last updated 3 years ago Was this helpful? Was this helpful? --- # Identifiers | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers.md) . Last updated 6 months ago Was this helpful? Was this helpful? --- # Station Alert | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/station-alert.md) . Was this helpful? Was this helpful? --- # Custom Blips | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips.md) . Last updated 3 years ago Was this helpful? Was this helpful? --- # Street Signs | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs.md) . Last updated 1 year ago Was this helpful? Was this helpful? --- # ERS | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/ers.md) . Was this helpful? Was this helpful? --- # Inferno Pagers | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers.md) . Last updated 4 months ago Was this helpful? Was this helpful? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency.md). # Emergency The v2 emergency API includes unit state updates, identifier management, dispatch and 911 call management, custom blips, and emergency configuration endpoints. ## Categories {% content-ref url="/pages/6mpf2PMoc5h0WnQEP5xi" %} \[Units\](/cad/api-integration/api-endpoints-v2/emergency/units.md) {% endcontent-ref %} {% content-ref url="/pages/kYzXvxnoT7g3U8DIJWRl" %} \[Identifiers\](/cad/api-integration/api-endpoints-v2/emergency/identifiers.md) {% endcontent-ref %} {% content-ref url="/pages/890OkClt1PlaKYJ39MIu" %} \[Calls\](/cad/api-integration/api-endpoints-v2/emergency/calls.md) {% endcontent-ref %} {% content-ref url="/pages/HCAyxgkXZjr4rRLp9Rut" %} \[Map\](/cad/api-integration/api-endpoints-v2/emergency/map.md) {% endcontent-ref %} {% content-ref url="/pages/JDM0sCMnFLTTj84jnGpW" %} \[Configuration\](/cad/api-integration/api-endpoints-v2/emergency/configuration.md) {% endcontent-ref %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2/emergency.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Set Identifier | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-identifier.md) . This API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Identifier[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-identifier#set-identifier) ----------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/set_identifier` GitBook Assistant This endpoint allows you to retrieve all unit identifiers for a specified account in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-identifier#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant SET\_IDENTIFIER GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy "Identifier Switched!" GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_IDENTIFIER", "data": [\ {\ "apiId": "Steam:1234", // (OPTION 1): Generally the Steam HEX\ "account": "000-000-000", // (OPTION 2): Sonoran Account UUID\ "identId" 2 // New identifier ID\ }\ ] } Last updated 1 year ago Was this helpful? Was this helpful? --- # Remove Blip | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/remove-blip.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Remove Blip[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/remove-blip#remove-blip) --------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/remove_blip` GitBook Assistant This endpoint allows you to remove a custom blip from the live map. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/remove-blip#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant REMOVE\_BLIP GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Blip 123 removed! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API ENDPOINT IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "REMOVE_BLIP", "data": [\ {\ "ids": [1, 2, 3] // Blip ID\ },\ ] } Last updated 4 years ago Was this helpful? Was this helpful? --- # Kick Unit | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/kick-unit.md) . This API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Kick Unit[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/kick-unit#kick-unit) -------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/kick_unit` GitBook Assistant This endpoint allows you to forcefully kick an active unit back to the community menu. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/kick-unit#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant KICK\_UNIT GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit status objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy UNIT KICKED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "KICK_UNIT", "data": [\ {\ "apiId": "STEAM:1234", // API ID entered in the unit identifiers\ // Typically, this is their STEAM ID\ "reason": "Automated AFK Timer", // "You have been kicked for {REASON}"\ "serverId": 1\ },\ ] } Last updated 5 years ago Was this helpful? Was this helpful? --- # Update Call Postal | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-postal.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Call Postal[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-postal#set-call-postal) ---------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/set_call_postal` GitBook Assistant This endpoint allows you to easily update the postal on a dispatch call. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-postal#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant SET\_CALL\_POSTAL GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy CALL 123 POSTAL SET TO 456 GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_CALL_POSTAL", "data": [\ {\ "serverId": 1, // Default 1 - See guide on setting up multiple servers\ "callId": 100, // Can be retrieved from the GET_CALLS API endpoint\ "postal": "321"\ },\ ] } Last updated 3 years ago Was this helpful? Was this helpful? --- # Unit Panic | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-panic.md) . This API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Toggling a unit's panic status via the API will not send this push event. These events should be listened for locally on the game server. GitBook Assistant Unit Panic[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-panic#unit-panic) ----------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/unit_panic` GitBook Assistant This The unit panic API endpoint allows you to automatically trigger a unit panic from in-game. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-panic#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant UNIT\_PANIC GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following errors may be sent in response: GitBook AssistantAskCopy UNIT PANIC UPDATED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "UNIT_PANIC", "data": [\ {\ "apiId": "STEAM:1234", // (OPTION 1): API ID entered in the unit identifiers\ "account": "000-000-000", // (OPTION 2): Sonoran Account UUID\ "identIds": [123,456], // (Option 3): Identifier IDs\ "isPanic": true,\ }\ ] } Last updated 6 months ago Was this helpful? Was this helpful? --- # Attach Unit | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/attach-units.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Attach Unit[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/attach-units#attach-unit) -------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/attach_unit` GitBook Assistant This endpoint allows you to attach new units to an existing dispatch call. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/attach-units#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant ATTACH\_UNIT GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy UNITS ATTACHED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "ATTACH_UNIT", "data": [\ {\ "serverId": 1, // Default 1 - See guide on setting up multiple servers\ "callId": 100, // Can be retrieved from the GET_CALLS API endpoint\ "units": ["STEAM:1234"], // OPTION 1: Array of API IDs\ // Typically, this is their STEAM Hex\ "account": "000-000-0000", // OPTION 2: Attach unit via account UUID\ "identIds": [1, 2, 3] // Option 3: Attach units via Identifier ID\ },\ ] } Last updated 6 months ago Was this helpful? Was this helpful? --- # Close Dispatch | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/close-call.md) . This API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Close Call[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/close-call#close-call) ---------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/close_call` GitBook Assistant This endpoint allows you to close an existing dispatch call. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/close-call#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant CLOSE\_CALL GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy UNITS ATTACHED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "CLOSE_CALL", "data": [\ {\ "serverId": 1, // Default 1 - See guide on setting up multiple servers\ "callId": 100, // Can be retrieved from the GET_CALLS API endpoint\ },\ ] } Last updated 4 years ago Was this helpful? Was this helpful? --- # Add Blip | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/add-blip.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Add Blip[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/add-blip#add-blip) ------------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/emergency/add_blip` GitBook Assistant This endpoint allows you to add a custom blip to your live map. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/add-blip#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant ADD\_BLIP GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy // Blip object with ID set [\ {\ "id": 1234,\ "coordinates": {\ "x": 0,\ "y": 0\ },\ "icon": "https://example.com/icon.png"\ }\ ] GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API ENDPOINT IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY Last updated 4 years ago Was this helpful? Was this helpful? GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "ADD_BLIP", "data": [\ {\ "serverId": 1, // Server ID\ "blip": {\ "id": -1, // New ID\ "subType": "Example", // Differentiate custom blips\ "coordinates": {\ "x": 123,\ "y": 456\ },\ "radius": 100, // Displays a circle radius\ "icon": "https://example.com/icon.png", // URL or Icon Name\ "color": "#df03fc", // Hex Color Code\ "tooltip": "Example added from the API!", // Blip Tooltip\ "data": [\ {\ "title": "Example 1",\ "text": "123",\ },\ {\ "title": "Example 2",\ "text": "456",\ }\ ]\ }\ },\ ] } --- # Set Available Callouts | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/ers/set-street-sign-config.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Available Callouts[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/ers/set-street-sign-config#set-available-callouts) --------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/SET_AVAILABLE_CALLOUTS` GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/ers/set-street-sign-config#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant SET\_AVAILABLE\_CALLOUTS GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Updated 1234 callouts GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_AVAILABLE_CALLOUTS", "data": { "callouts": [\ {\ "id": "some_callout_name",\ "data": {}\ },\ {\ "id": "some_callout_name_2",\ "data": {}\ }\ ], "serverId": 1 } } Last updated 1 year ago Was this helpful? Was this helpful? --- # Update Call Primary | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Call Primary[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary#set-call-primary) ------------------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/set_call_primary` GitBook Assistant This endpoint allows you to easily update the primary unit on a dispatch call. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant SET\_CALL\_PRIMARY GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy CALL 123 POSTAL SET TO 456 GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_CALL_PRIMARY", "data": [\ {\ "serverId": 1, // Default 1 - See guide on setting up multiple servers\ "callId": 100, // Can be retrieved from the GET_CALLS API endpoint\ "primary": 123, // Identifier ID\ "trackPrimary": false // Toggle unit tracking for in-game with Dispatch Notify plugin\ },\ ] } ### Clearing the Primary Identifier[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary#clearing-the-primary-identifier) If you wish to clear the call's primary identifier, it is recommended to set the value to `-1`. GitBook Assistant Last updated 5 years ago Was this helpful? * [Set Call Primary](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary#set-call-primary) * [Clearing the Primary Identifier](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary#clearing-the-primary-identifier) Was this helpful? --- # Update Street Sign | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/update-street-sign.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Update Street Sign[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/update-street-sign#update-street-sign) ------------------------------------------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/emergency/UPDATE_STREETSIGN` GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/update-street-sign#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant UPDATE\_STREETSIGN GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy API ID(s) set! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "UPDATE_STREETSIGN", "data": [\ {\ "serverId": 1, // Server Id\ "signData": {\ "ids": [1, 2],\ "text1": "",\ "text2": "",\ "text3": ""\ }\ }\ ] } Last updated 5 years ago Was this helpful? Was this helpful? --- # Remove Record | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/remove-record.md) . This API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Remove Record[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/remove-record#remove-record) --------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/remove_record` GitBook Assistant This endpoint allows you to remove any record in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/remove-record#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant REMOVE\_RECORD GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit status objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy REMOVED RECORD {ID} GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "REMOVE_RECORD", "data": [\ {\ "id": 100, // Unique ID - Retrieved from LOOKUP_NAME or LOOKUP_PLATE\ },\ ] } Last updated 5 years ago Was this helpful? Was this helpful? --- # Edit Record | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/edit-record.md) . This API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Edit Record[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/edit-record#edit-record) --------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/edit_record` GitBook Assistant This endpoint allows you to edit an existing custom record to your community. GitBook Assistant GitBook AssistantAskCopy "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "EDIT_RECORD", "data": [\ {\ "user": "STEAM:1234", // API ID or user UUID/GUID that 'owns' this record\ "templateId": 5, // Template ID (shown in Admin menu next to name) or on the record's `recordTypeId` field\ "useDictionary": true, // OPTION 1: Key/Value from template\ "recordId": 123, // OPTION 1: Record ID being modified\ "replaceValues": {\ // Field UID and Value\ "first": "Brian",\ "last": "Sosnowski"\ },\ "record": null, // OPTION 2: Full raw JSON structure\ }\ ] } ### Formatting Data for Custom Records[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/edit-record#formatting-data-for-custom-records) Custom records can be easily modified with a set of key/value pairs, or full raw JSON. GitBook Assistant Learn more about these formatting options below: GitBook Assistant [API Options for Adding and Modifying Records](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/api-options-for-adding-and-modifying-records) Last updated 2 years ago Was this helpful? * [Edit Record](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/edit-record#edit-record) * [Formatting Data for Custom Records](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/edit-record#formatting-data-for-custom-records) Was this helpful? --- # Get Identifiers | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/get-identifiers.md) . This API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Get Account Identifiers[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/get-identifiers#get-account-identifiers) ------------------------------------------------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/emergency/get_identifiers` GitBook Assistant This endpoint allows you to retrieve all unit identifiers for a specified account in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/get-identifiers#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant GET\_IDENTIFIERS GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy { "selectedIdent": 1, "identifiers": [\ {\ "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\ }\ ] } Last updated 2 months ago Was this helpful? Was this helpful? GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "GET_IDENTIFIERS", "data": [\ {\ "apiId": "Steam:1234", // (OPTION 1): Generally the Steam HEX\ "account": "000-000-000" // (OPTION 2): Sonoran Account UUID\ }\ ] } --- # Add Call Note | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Add Call Note[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note#add-call-note) ------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/add_call_note` GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant ADD\_CALL\_NOTE GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy NOTE 'some note here' added to call #123 GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "ADD_CALL_NOTE", "data": [\ {\ "serverId": 1, // Default 1 - See guide on setting up multiple servers\ "callId": 123,\ "label": "A-10", // OPTIONAL (sender of the note)\ "note": "This is a test!" // Note text\ },\ ] } ### Note Object[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note#note-object) Call notes are formatted on dispatch calls with the following object: GitBook Assistant Last updated 3 years ago Was this helpful? * [Add Call Note](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note#add-call-note) * [Note Object](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note#note-object) Was this helpful? GitBook AssistantAskCopy { "time": "12:00:00", "label": "A-10", "type": "text", "content": "This is a note!" } --- # Set Stations | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/station-alert/set-stations.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Stations[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/station-alert/set-stations#set-stations) ------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/SET_STATIONS` GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/station-alert/set-stations#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant SET\_STATIONS GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Updated station config! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_STATIONS", "data": { "serverId": 1, "config": { "locations": [\ {\ "name": "Fire Station One",\ "coordinates": {\ "x": 1234,\ "y": 5678\ },\ "icon": "fa-solid fa-face-smile", // Or a direct HTTPS URL to an image\ "doors": [\ "Bay One",\ "Engine Two"\ ],\ }\ ], "tones": [\ "Tone Name One",\ "Tone Name Two"\ ] } } } Last updated 1 year ago Was this helpful? Was this helpful? --- # Detach Unit | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/detach-unit.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Detach Unit[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/detach-unit#detach-unit) ------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/detach_unit` GitBook Assistant This endpoint allows you to attach new units to an existing dispatch call. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/detach-unit#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant DETACH\_UNIT GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy UNITS DETACHED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "DETACH_UNIT", "data": [\ {\ "serverId": 1, // Default 1 - See guide on setting up multiple servers\ "units": ["STEAN:1234"], // OPTION 1: Array of API IDs\ // Typically, this is their STEAM Hex\ "account": "000-000-0000" // OPTION 2: Attach unit via account UUID\ },\ ] } Last updated 1 year ago Was this helpful? Was this helpful? --- # Set Street Sign Config | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/set-street-sign-config.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Street Sign Config[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/set-street-sign-config#set-street-sign-config) ------------------------------------------------------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/emergency/SET_STREETSIGN_CONFIG` GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/set-street-sign-config#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant SET\_STREETSIGN\_CONFIG GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy API ID(s) set! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_STREETSIGN_CONFIG", "data": [\ {\ "serverId": 1, // Server Id\ "signConfig": [\ {\ "id": 1,\ "label": "Some street sign",\ "text1": "",\ "text2": "",\ "text3": ""\ },\ {\ "id": 2,\ "label": "Another street sign",\ "text1": "",\ "text2": "",\ "text3": ""\ }\ ]\ }\ ] } Last updated 5 years ago Was this helpful? Was this helpful? --- # Remove 911 | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/remove-911.md) . This API endpoint requires the **Standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant This endpoint allows you to remove an existing emergency/911 call from the CAD. GitBook Assistant Remove 911[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/remove-911#remove-911) ---------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/remove_911` GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/remove-911#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant REMOVE\_911 GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy API ID(s) set! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "REMOVE_911", "data": [\ {\ "serverId": 1,\ "callId": 1 // Call ID\ }\ ] } #### Call ID[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/remove-911#call-id) The call ID integer value can be retrieved from the [get calls API endpoint](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/get-calls) , or returned in the response message when [creating a 911 call via an API call](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call) . GitBook Assistant Last updated 4 years ago Was this helpful? Was this helpful? --- # Set Ident Group | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-ident-group.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Update Unit Status[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-ident-group#update-unit-status) -------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/idents_to_group` GitBook Assistant The unit location API endpoint allows you to update a unit's location from in-game. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-ident-group#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant UNIT\_STATUS GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit status objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Set idents 123, 456, 789 to group 'Group 1". GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "IDENTS_TO_GROUP", "data": [\ {\ "serverId": 1, // Server ID\ "identIds": [123, 456, 789], // Array of identifier ID integers\ "account": "000-000-000", // OPTIONAL: Specify the Sonoran account GUID's current identifier to be added to the list of identIds\ "groupName": "Group 1" // Name of group to set the identifiers to. Use an empty string to clear their group.\ },\ ] } Last updated 6 months ago Was this helpful? Was this helpful? --- # Get Map Blips | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/get-map-blips.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Get Blips[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/get-map-blips#get-blips) ------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/get_blips` GitBook Assistant This endpoint allows you to retrieve all custom blips on your live map. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/get-map-blips#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant GET\_BLIPS GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy // Array of blip objects [\ {\ "id": 1,\ "subType": "Example", // Differentiate custom blips types\ "coordinates": {\ "x": 0,\ "y": 0\ },\ "color": "#000FFF",\ "icon": "https://example.com/icon.png",\ "data": [\ {\ "title": "Example 1",\ "text": "123",\ },\ {\ "title": "Example 2",\ "text": "456",\ }\ ]\ }\ ] Last updated 4 years ago Was this helpful? Was this helpful? GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API ENDPOINT IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "GET_BLIPS", "data": [\ {\ "serverId": 1 // Server ID\ },\ ] } --- # Get Record Templates | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/get-record-template.md) . This API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Get Record Templates[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/get-record-template#get-record-templates) ----------------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/get_templates` GitBook Assistant This endpoint allows you to retrieve all custom record and report templates in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/get-record-template#request-body) Name Type Description templateId GitBook Assistant number GitBook Assistant Unique template ID GitBook Assistant id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant GET\_TEMPLATES GitBook Assistant data GitBook Assistant array GitBook Assistant Empty Array GitBook Assistant 200 400 GitBook AssistantAskCopy [{RECORD TEMPLATES}] GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "GET_TEMPLATES", "recordTypeId": 123, // OPTIONAL - Matches a specific record's recordTypeId field } #### Record Formatting[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/get-record-template#record-formatting) Custom records require a strict format with several dozen different data fields. You can view a detailed explanation of [custom record formatting](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records#record-formatting) . GitBook Assistant Last updated 1 year ago Was this helpful? Was this helpful? --- # New Record | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/new-record.md) . This API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant New Record[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/new-record#new-record) ------------------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/general/new_record` GitBook Assistant This endpoint allows you to add a new custom record to your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/new-record#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant NEW\_RECORD GitBook Assistant data GitBook Assistant array GitBook Assistant Array of record objects GitBook Assistant 200 400 GitBook AssistantAskCopy {NEW RECORD OBJECT} GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "NEW_RECORD", "data": [\ {\ "user": "STEAM:1234", // API ID or user UUID/GUID that 'owns' this record\ "useDictionary": true, // OPTION 1: Key/Value from template\ "recordTypeId": 7, // OPTION 1: Custom template ID number\ "replaceValues": {\ // Field UID and Value\ "first": "Brian",\ "last": "Sosnowski"\ },\ "record": null, // OPTION 2: Full raw JSON structure\ "deleteAfterMinutes": 30 // OPTIONAL: Delete record after X minutes (temporary record)\ }\ ] } ### Formatting Data for Custom Records[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/new-record#formatting-data-for-custom-records) Custom records can be easily modified with a set of key/value pairs, or full raw JSON. GitBook Assistant Learn more about these formatting options below: GitBook Assistant [API Options for Adding and Modifying Records](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/api-options-for-adding-and-modifying-records) Last updated 1 year ago Was this helpful? * [New Record](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/new-record#new-record) * [Formatting Data for Custom Records](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/custom-records/new-record#formatting-data-for-custom-records) Was this helpful? --- # Set Pager Config | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/set-pager-config.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Pager Config[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/set-pager-config#set-pager-config) -------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/SET_PAGER_CONFIG` GitBook Assistant This endpoint sets the Inferno Pager configuration for a specific server in your community. If `nodes` is omitted, the existing node tree for that server is preserved. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/set-pager-config#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant SET\_PAGER\_CONFIG GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Updated pager config! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_PAGER_CONFIG", "data": [\ {\ "serverId": 1,\ "natureWords": {\ "Emergency": "Emergency",\ "NonEmergency": "Non-Emergency",\ "Administrative": "Administrative"\ },\ "maxAddresses": 5,\ "maxBodyLength": 250,\ "nodes": [\ {\ "id": "root-1",\ "name": "Fire",\ "description": "Fire services",\ "permission": "fire",\ "address": "FIRE-01",\ "shortCode": "F1",\ "kind": "group",\ "children": []\ }\ ]\ }\ ] } The `nodes` property is optional. If omitted, Sonoran CAD keeps the existing node tree for that `serverId` and only updates the minimal config fields. GitBook Assistant Last updated 4 months ago Was this helpful? Was this helpful? --- # Update Unit Location | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/update-unit-location.md) . iThis API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Unit Location[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/update-unit-location#unit-location) --------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/unit_location` GitBook Assistant The unit location API endpoint allows you to update a unit's location from in-game. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/update-unit-location#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant UNIT\_LOCATION GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit location objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy UNIT LOCATION UPDATED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "UNIT_LOCATION", "data": [\ {\ "apiId": "STEAM:1234", // API ID entered in the unit identifiers\ // Typically, this is their STEAM ID\ "location": "1234 W. Example St.",\ "coordinates": { // X/Y coordinates for live map (floats)\ "x": 1000,\ "y": 2000,\ }\ },\ {\ "apiId": "STEAM:5678",\ "location": "5678 E. Test Ave.",\ "coordinates": {\ "x": 1000,\ "y": 2000,\ }\ }\ ] } #### API ID[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/update-unit-location#api-id) The **apiId** field contains a unique ID that every unit identifier must have specified in Sonoran CAD. Users can set this field in their identifier to properly map unit update API calls to their CAD identifier. For more information, see our guide on setting your unit's API ID: GitBook Assistant [Map Players to CAD Users](https://docs.sonoransoftware.com/cad/api-integration/getting-started/setting-your-api-id) #### Rate Limiting[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/update-unit-location#rate-limiting) To avoid being rate limited when frequently updating multiple unit locations, it is best to group multiple unit location update together into the **data** array field. When compared to making a separate API call with every location update, grouping multiple location updates into a single call every few seconds is more efficient. GitBook Assistant _NOTE:_ We recommend updating unit locations in a group no more frequently than every 5 seconds. GitBook Assistant Last updated 6 months ago Was this helpful? Was this helpful? --- # Unknown \> For the complete documentation index, see \[llms.txt\](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending \`.md\` to page URLs; this page is available as \[Markdown\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency.md). # Emergency - \[Identifiers\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers.md): These API methods allow you to access and modify unit identifiers. - \[Get Identifiers\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/get-identifiers.md): Sonoran CAD allows you to retrieve all account unit identifiers via API endpoint. - \[Modify Identifier\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier.md): This endpoint allows you to add, edit, or remove unit identifiers. - \[Set Identifier\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-identifier.md): This endpoint allows you to set the selected identifier for a unit. - \[Unit Panic\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-panic.md): The Unit Panic API call allows you to automatically trigger a unit panic from in-game. - \[Kick Unit\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/kick-unit.md): This endpoint allows you to forcefully kick an active unit back to the community menu. - \[Unit Status\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-status.md): Update your unit's current status in the CAD via API. - \[Get Active Units\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/get-active-units.md): This endpoint allows you to retrieve all active units in your CAD. - \[Update Unit Location\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/update-unit-location.md): The unit location update call allows you to update a unit's location from in-game. - \[Set Ident Group\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/set-ident-group.md): This endpoint allows you to set, change, or remove the group for one or more unit identifiers. - \[Dispatch and Emergency Calls\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls.md): These endpoints allow you to create, update, and close dispatch and emergency (911) calls. - \[Get Calls\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/get-calls.md): This endpoint allows you to retrieve all active emergency calls, active dispatch calls, and previously closed dispatch calls. - \[New Dispatch\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/new-dispatch.md): This API endpoint allows you to generate and attach units to a new dispatch call. - \[Edit Dispatch\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/edit-dispatch.md): This API endpoint allows you to update an existing dispatch call by changing one or more fields. - \[Attach Unit\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/attach-units.md): This endpoint allows you to attach new units to an existing dispatch call. - \[Detach Unit\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/detach-unit.md): This endpoint allows you to detach a unit from any active dispatch call. - \[Update Call Postal\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-postal.md): This endpoint allows you to easily update the postal on a dispatch call. - \[Add Call Note\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/add-call-note.md): This endpoint allows you to add a new dispatch call note. - \[Update Call Primary\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/update-call-primary.md): This endpoint allows you to update the primary unit identifier on a dispatch call. - \[Close Dispatch\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/close-call.md): This endpoint allows you to close an existing dispatch call. - \[New 911 Call\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call.md): The 911 Call API endpoint allows you to send 911 calls from in-game directly to your dispatchers. - \[Remove 911\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/remove-911.md): This endpoint allows you to remove an existing emergency/911 call from the CAD. - \[Custom Blips\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips.md): Retrieve, add, edit, and remove custom blips from your community's live map! - \[Get Map Blips\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/get-map-blips.md): This endpoint allows you to retrieve all custom blips for a community's live map! - \[Add Blip\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/add-blip.md): This endpoint allows you to add a new custom blip to your community's live map! - \[Modify Blip\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/modify-blip.md): This endpoint allows you to easily update a custom live map blip. - \[Remove Blip\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/remove-blip.md): This endpoint allows you to remove custom blips from your community's live map. - \[Street Signs\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs.md): These endpoints allow you to manage in-game street sign models. - \[Set Street Sign Config\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/set-street-sign-config.md): This endpoint sets your community's street sign configuration. - \[Update Street Sign\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/street-signs/update-street-sign.md): This endpoint allows you to modify existing street signs. - \[ERS\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/ers.md): These endpoints are for Emergency Response Simulator callout integrations - \[Set Available Callouts\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/ers/set-street-sign-config.md): This endpoint sets your community's available ERS callouts. - \[Station Alert\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/station-alert.md): These endpoints are for Station Alert integrations. - \[Set Stations\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/station-alert/set-stations.md): This endpoint sets your community's available fire stations. - \[Inferno Pagers\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers.md): These endpoints are for Inferno Pager integrations. - \[Get Pager Config\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/get-pager-config.md): This endpoint retrieves your community's Inferno Pager configuration for a specific server. - \[Set Pager Config\](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/set-pager-config.md): This endpoint sets your community's Inferno Pager configuration for a specific server. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the \`ask\` query parameter, and the optional \`goal\` query parameter: \`\`\` GET https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency.md?ask=&goal= \`\`\` \`ask\` is the immediate question: it should be specific, self-contained, and written in natural language. \`goal\` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Get Pager Config | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/get-pager-config.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Get Pager Config[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/get-pager-config#get-pager-config) -------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/GET_PAGER_CONFIG` GitBook Assistant This endpoint retrieves the Inferno Pager configuration for a specific server in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/inferno-pagers/get-pager-config#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant GET\_PAGER\_CONFIG GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy { "natureWords": { "Emergency": "Emergency", "NonEmergency": "Non-Emergency", "Administrative": "Administrative" }, "maxAddresses": 5, "maxBodyLength": 250, "nodes": [\ {\ "id": "root-1",\ "name": "Fire",\ "description": "Fire services",\ "permission": "fire",\ "address": "FIRE-01",\ "shortCode": "F1",\ "kind": "group",\ "children": [\ {\ "id": "station-1",\ "name": "Station 1",\ "description": "",\ "permission": "fire.station1",\ "address": "FIRE-ST01",\ "shortCode": "ST1",\ "kind": "node",\ "children": []\ }\ ]\ }\ ] } The returned configuration is always for the requested `serverId`. GitBook Assistant Last updated 4 months ago Was this helpful? Was this helpful? GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "GET_PAGER_CONFIG", "data": [\ {\ "serverId": 1 // Server ID\ }\ ] } --- # Modify Identifier | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier.md) . This API endpoint requires the **Pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Modify Identifier[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier#modify-identifier) -------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/modify_identifier` GitBook Assistant This endpoint allows you to retrieve all unit identifiers for a specified account in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant MODIFY\_IDENTIFIER GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy // 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!" ### Action Enum[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier#action-enum) The `action` property is an enumerator value with the following values: GitBook Assistant Enum (Int) Description 0 GitBook Assistant ADD GitBook Assistant 1 GitBook Assistant EDIT GitBook Assistant 2 GitBook Assistant REMOVE GitBook Assistant Last updated 2 months ago Was this helpful? * [Modify Identifier](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier#modify-identifier) * [Action Enum](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/modify-identifier#action-enum) Was this helpful? GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "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\ }\ ] } --- # Unit Status | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-status.md) . This API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Update Unit Status[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-status#update-unit-status) ---------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/unit_status` GitBook Assistant The unit location API endpoint allows you to update a unit's location from in-game. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-status#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant UNIT\_STATUS GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit status objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy UNIT STATUS UPDATED GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "UNIT_STATUS", "data": [\ {\ "apiId": "STEAM:1234", // (OPTION 1): API ID entered in the unit identifiers\ // Typically, this is their STEAM ID\ "account": "000-000-000", // (OPTION 2): Sonoran Account UUID\ "identIds": [123,456], // (Option 3): Identifier IDs\ "status": 0, // Status Int (ENUM)\ "serverId": 1 // Server ID\ },\ ] } The unit status enumeration values are shown below. These reflect the default unit status options. Your community may have changed the wording with custom [unit status codes](https://docs.sonoransoftware.com/cad/tutorials/customization/unit-status-codes) . GitBook Assistant Integer (Enumeration) Value Status Description 0 GitBook Assistant UNAVAILABLE GitBook Assistant 1 GitBook Assistant BUSY GitBook Assistant 2 GitBook Assistant AVAILABLE GitBook Assistant 3 GitBook Assistant ENROUTE GitBook Assistant 4 GitBook Assistant ON\_SCENE GitBook Assistant Last updated 6 months ago Was this helpful? Was this helpful? --- # Websocket API | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/websocket-api.md) . Use the websocket API for persistent, low-overhead integration traffic. GitBook Assistant For frequent live-map location updates, prefer the websocket API over the HTTP v2 endpoint: GitBook Assistant * Websocket `unitLocation` updates can be sent every `200ms` minimum. In practice, sending every `250ms` is a safe default. GitBook Assistant * HTTP v2 `PATCH /v2/emergency/servers/{serverId}/unit-locations` is rate limited to `12 requests per minute`, which is effectively one request every `5 seconds`. GitBook Assistant Current websocket API features include: GitBook Assistant * Authenticating once and reusing the session for repeated calls GitBook Assistant * Sending frequent `unitLocation` updates for the live map GitBook Assistant * Receiving Sonoran CAD `pushEvent` messages for a specific `serverId`, including normal push-event traffic before HTTP listener fallback is used GitBook Assistant Pages[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api#pages) ---------------------------------------------------------------------------------- * [Authentication](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication) GitBook Assistant * [Unit Locations](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/unit-locations) GitBook Assistant * [Push Events](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/push-events) GitBook Assistant [PreviousNew Station Alert](https://docs.sonoransoftware.com/cad/api-integration/push-events/station-alert/new-station-alert) [NextAuthentication](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication) Last updated 3 months ago Was this helpful? Was this helpful? --- # Development Branch | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/development-branch.md) . The development API, database and website are entirely separate from the current production version. For more information in working with our development team please [contact us](https://support.sonoransoftware.com/) . or join our community [Discord](http://discord.sonorancad.com/) . GitBook Assistant ### Development API Server[](https://docs.sonoransoftware.com/cad/api-integration/development-branch#development-api-server) All API endpoints and requests should be made to the following address: GitBook Assistant GitBook AssistantAskCopy https://staging-api.dev.sonorancad.com ### Development CAD[](https://docs.sonoransoftware.com/cad/api-integration/development-branch#development-cad) The latest CAD development version can be accessed at the following address: GitBook Assistant GitBook AssistantAskCopy https://staging.dev.sonorancad.com ### FiveM Resource[](https://docs.sonoransoftware.com/cad/api-integration/development-branch#fivem-resource) To switch the [SonoranCADFiveM](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/fivem-installation) resource to the development environment, set the core config mode to: GitBook Assistant GitBook AssistantAskCopy "mode": "development" You can also override this with a server convar: GitBook Assistant GitBook AssistantAskCopy setr sonoran_mode development That mode switch automatically updates the resource to use: GitBook Assistant * `https://staging-api.dev.sonorancad.com/` for API requests GitBook Assistant * `https://staging-api.dev.sonorancad.com/apiWsHub` for API websocket traffic GitBook Assistant * `https://staging.dev.sonorancad.com` for CAD link/UI URLs GitBook Assistant ### Development Subscription - Free[](https://docs.sonoransoftware.com/cad/api-integration/development-branch#development-subscription-free) Data will be reset at random times and **this environment is not suitable for production use**. Use only for testing new features when requested by Sonoran Software Development and for developing API based resources. GitBook Assistant While our APIs are not restricted based on subscription level, some specific panels or features may be. Communities on the development branch can be upgraded for free with the following steps: GitBook Assistant 1. Create a new PRO subscription in the development CAD billing portal. GitBook Assistant 2. At checkout enter `4242 4242 4242 4242` as the card number with any CVV and expiration date. GitBook Assistant 3. Apply the subscription to your development testing CAD. GitBook Assistant ### Developer Discord[](https://docs.sonoransoftware.com/cad/api-integration/development-branch#developer-discord) Join our [Discord](http://discord.sonorancad.com/) and access the `#community-development` channel. Here you can discuss API related issues, development, and more. GitBook Assistant [PreviousPush Events](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/push-events) [NextPricing FAQ](https://docs.sonoransoftware.com/cad/pricing/faq) Last updated 3 months ago Was this helpful? * [Development API Server](https://docs.sonoransoftware.com/cad/api-integration/development-branch#development-api-server) * [Development CAD](https://docs.sonoransoftware.com/cad/api-integration/development-branch#development-cad) * [FiveM Resource](https://docs.sonoransoftware.com/cad/api-integration/development-branch#fivem-resource) * [Development Subscription - Free](https://docs.sonoransoftware.com/cad/api-integration/development-branch#development-subscription-free) * [Developer Discord](https://docs.sonoransoftware.com/cad/api-integration/development-branch#developer-discord) Was this helpful? --- # Modify Blip | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/modify-blip.md) . This API endpoint requires the **pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Modify Blip[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/modify-blip#modify-blip) --------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/modify_blip` GitBook Assistant This endpoint allows you to edit a custom blip on your live map. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/custom-blips/modify-blip#request-body) Name Type Description id\* GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key\* GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type\* GitBook Assistant string GitBook Assistant MODIFY\_BLIP GitBook Assistant data\* GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Blip 123 modified! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API ENDPOINT IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "MODIFY_BLIP", "data": [\ {\ "id": 123, // Blip IDm\ "subType": "Example", // OPTIONAL - Differentiate custom types\ "coordinates": { // OPTIONAL - Coordinate Update\ "x": 0,\ "y": 1\ },\ "radius": 100, // OPTIONAL - Displays a circle radius\ "icon": "https://example.com/icon.png" // OPTIONAL - Icon Update\ "color": "#df03fc", // OPTIONAL - Hex Color Code\ "tooltip": "Example added from the API!" // OPTIONAL - Blip Tooltip\ "data": [ // OPTIONAL - Display Data\ {\ "title": "Example 1",\ "text": "123",\ },\ {\ "title": "Example 2",\ "text": "456",\ }\ ]\ },\ ] } Last updated 4 years ago Was this helpful? Was this helpful? --- # Get Version | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/get-version.md) . Get Version[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/get-version#get-version) ------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/general/get_version` GitBook Assistant This API endpoint gets the current plan used by the community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/get-version#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant GET\_VERSION GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy 0 - FREE 1 - STARTER 2 - STANDARD 3 - PLUS 4 - PRO 6 - SONORAN ONE GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "GET_VERSION", "data": [] } Last updated 4 years ago Was this helpful? Was this helpful? --- # Get Servers | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/get-servers.md) . API endpoint requires the **Standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Get Servers[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/get-servers#get-servers) ------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/general/get_servers` GitBook Assistant This endpoint allows you to retrieve your community's server configuration. This contains valuable Live Map configuration data and can be used to ensure correct Live Map configs. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/get-servers#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant GET\_SERVERS GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy { "servers": [\ {\ "id": 1,\ "name": "Server 1",\ "description": "Default server description",\ "signal": null,\ "mapUrl": "https://cadapi.dev.sonoransoftware.com/map/community/map_example/index.html",\ "mapIp": "123.456.78.9",\ "mapPort": "30121",\ "differingOutbound": false, // Different outbound/egress IP than the mapIp\ "outboundIp": "",\ "listenerPort": "0000",\ "enableMap": false,\ "mapType": "POSTAL",\ "isStatic": false\ }\ ] } GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY Last updated 1 year ago Was this helpful? Was this helpful? GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "GET_SERVERS", "data": [] } --- # Auth Street Signs | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/auth-street-signs.md) . This API endpoint requires the **Pro** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Authenticate Street Signs[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/auth-street-signs#authenticate-street-signs) ---------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/auth_streetsigns` GitBook Assistant This endpoint authenticates the use of our integrated street signs plugin. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/auth-street-signs#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant AUTH\_STREETSIGNS GitBook Assistant data GitBook Assistant object GitBook Assistant Request object GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Success GitBook AssistantAskCopy Error: Server ID: x has IP set to: '1.2.3.4' -> your IP: '4.3.2.1' Server not found with ID: 123 GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "AUTH_STREETSIGNS", "data": { "serverId": 1 } } Last updated 5 years ago Was this helpful? Was this helpful? --- # Set Servers | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/set-servers.md) . API endpoint requires the **Plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Set Servers[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/set-servers#set-servers) ------------------------------------------------------------------------------------------------------------------ `POST` `https://api.sonorancad.com/general/set_servers` GitBook Assistant This endpoint allows you to set your community's server configuration and update the live map deployment. This contains additional valuable Live Map configuration data. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/set-servers#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant SET\_SERVERS GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy Server config updated GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "SET_SERVERS", "data": { "servers": [\ {\ "id": 1,\ "name": "Server 1",\ "description": "Main Server",\ "signal": "",\ "mapUrl": "",\ "mapIp": "",\ "listenerPort": 3232,\ "differingOutbound": false, // Different outbound/egress IP than the mapIp\ "outboundIp": "",\ "enableMap": true,\ "isStatic": false,\ "mapType": "NORMAL" // NORMAL, POSTAL, OCRP POSTAL\ }\ ] "deployMap": true // Deploy the Live Map with these server changes }, } Last updated 3 years ago Was this helpful? Was this helpful? --- # Authentication | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication.md) . Websocket Authentication[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#websocket-authentication) --------------------------------------------------------------------------------------------------------------------------------------- ### Authentication Method[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#authentication-method) #### **Method:**[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#method) GitBook AssistantAskCopy authenticatev2 #### **Parameters:**[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#parameters) Parameter Type `communityId` GitBook Assistant String GitBook Assistant `apiKey` GitBook Assistant String GitBook Assistant `serverId` GitBook Assistant Number (Optional) GitBook Assistant ### Response[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#response) GitBook AssistantAskCopy { success: boolean, error: string, count: number } ### serverId[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#serverid) `serverId` is optional for websocket authentication. GitBook Assistant Use it when you want this websocket connection to receive Sonoran CAD push events for a specific configured server. If provided, the `serverId` must match a valid server configured in your CAD. GitBook Assistant If `serverId` is omitted, the websocket session can still call websocket API methods such as `unitLocation`, but it will not be used as a push event destination for a specific server. GitBook Assistant ### Auth JS example (Node.js) Requires:[](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#auth-js-example-node.js-requires) **Add the Microsoft SignalR Library** GitBook Assistant [PreviousWebsocket API](https://docs.sonoransoftware.com/cad/api-integration/websocket-api) [NextUnit Locations](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/unit-locations) Last updated 3 months ago Was this helpful? * [Websocket Authentication](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#websocket-authentication) * [Authentication Method](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#authentication-method) * [Response](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#response) * [serverId](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#serverid) * [Auth JS example (Node.js) Requires:](https://docs.sonoransoftware.com/cad/api-integration/websocket-api/authentication#auth-js-example-node.js-requires) Was this helpful? GitBook AssistantAskCopy npm i @microsoft/signalr GitBook AssistantAskCopy // Import the signalr library for backend connection const signalR = require("@microsoft/signalr"); // Establist the connection object const connection = new signalR.HubConnectionBuilder() .withUrl("https://api.sonorancad.com/apiWsHub", { transport: signalR.HttpTransportType.WebSockets, skipNegotiation: true, }) .withAutomaticReconnect() .build(); // Start the WSS connection await connection.start(); // Replace community ID and API key const auth = await connection.invoke("authenticatev2", "yourCommunityId", "yourApiKey", 1); if (!auth?.success) { throw new Error(`Authentication failed: ${auth?.error || "unknown error"}`); } --- # API Endpoints | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints.md) . API endpoints are not enabled with the free version of Sonoran CAD. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) or view how to check your community [limits](https://docs.sonoransoftware.com/cad/tutorials/getting-started/view-your-limits) . GitBook Assistant Looking for the new header-based API? See [v2 API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2) . GitBook Assistant Looking for VPS, web, or dedicated hosting? Check out our official server hosting! GitBook Assistant Available API Endpoints[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#available-api-endpoints) ---------------------------------------------------------------------------------------------------------------------- ### Emergency Endpoints[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#emergency-endpoints) View all emergency endpoints including unit actions, emergency calls, dispatching, and more! GitBook Assistant [Emergency](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency) ### Civilian Endpoints[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#civilian-endpoints) View all civilian endpoints including creating new characters, modifying licenses, vehicle registrations, and more! GitBook Assistant [Civilian](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/civilian) ### General Endpoints[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#general-endpoints) View all general endpoints for user account actions, administrative actions, and more! GitBook Assistant [General](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general) ### v2 API Endpoints[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#v2-api-endpoints) View the new versioned API with bearer authentication, resource-style routes, and structured error responses. GitBook Assistant [v2 API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints-v2) API Code Examples[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#api-code-examples) ---------------------------------------------------------------------------------------------------------- ### Javascript[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#javascript) This example makes a [unit panic request](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-panic) based on a unit's API ID. This uses the [Axios library](https://www.npmjs.com/package/axios) to help make the HTTP POST request. GitBook Assistant The server response is then logged to console. GitBook Assistant ### Lua[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#lua) This example makes a [unit panic request](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/identifiers/unit-panic) based on a unit's API ID. This uses the [FiveM performHttpRequest native](https://docs.fivem.net/docs/scripting-reference/runtimes/lua/functions/PerformHttpRequest/) to help make the HTTP POST request. GitBook Assistant The server response is then logged to console. GitBook Assistant Last updated 3 months ago Was this helpful? * [Available API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#available-api-endpoints) * [Emergency Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#emergency-endpoints) * [Civilian Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#civilian-endpoints) * [General Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#general-endpoints) * [v2 API Endpoints](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#v2-api-endpoints) * [API Code Examples](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#api-code-examples) * [Javascript](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#javascript) * [Lua](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints#lua) Was this helpful? GitBook AssistantAskCopy // Import Axios library // https://www.npmjs.com/package/axios // Install command: `npm i axios` import axios from 'axios'; // Set the API URL (CAD backend) let baseURL = 'https://api.sonorancad.com'; // Set the `api` object to be used let api = axios.create({ baseURL }); // Format the POST body data // https://info.sonorancad.com/sonoran-cad/api-integration/api-endpoints/emergency/unit-panic const data = { id: 'YOUR_COMMUNITY_ID', key: 'YOUR_API_KEY', type: 'UNIT_PANIC', data: [\ // Data: List (array) of unit panic objects\ // Here, we're specifying one unit to PANIC\ {\ apiId: "STEAM:5678", // Unit with their API ID set as `STEAM:5678`\ isPanic: true, // Panic ON\ }\ ], }; // Send the POST request // Format the data to JSON api.post('/emergency/unit_panic', JSON.stringify(data)) .then((response) => { // Response back from the backend console.log(response); }) .catch((err) => { // Error response back from the backend console.log(err); }); GitBook AssistantAskCopy -- Body payload object local payload = {} -- Specify our community ID, API key, and API method type (Panic) payload["id"] = "YOUR_COMMUNITY_ID" payload["key"] = "YOUR_API_KEY" payload["type"] = "UNIT_PANIC" -- Data: List (array) of unit panic objects -- Here, we're specifying one unit to PANIC local postData = { { ["apiId"] = "STEAM:5678", -- Unit with their API ID set as `STEAM:5678` ["isPanic"] = true -- Panic ON }, } -- Add this data to our payload payload["data"] = postData -- Send POST request with JSON encoded body (payload) PerformHttpRequest("https://api.sonorancad.com/emergency/unit_panic", function(statusCode, res, headers) if statusCode == 200 and res ~= nil then -- Status code 200 (Success) print("result: "..tostring(res)) else -- Error code print(("CAD API ERROR: %s %s"):format(statusCode, res)) end end, "POST", json.encode(payload), {["Content-Type"]="application/json"}) --- # Verify Secret | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/verify-secret.md) . This API endpoint requires the **Standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Get Account[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/verify-secret#get-account) -------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/verify_secret` GitBook Assistant This endpoint verifies a user account's secret ID. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/verify-secret#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant VERIFY\_SECRET GitBook Assistant data GitBook Assistant array GitBook Assistant Array of request objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: GitBook AssistantAskCopy // Dictionary of Account UUID (key) and Secret (value) {"91de0ce8-c571-11e9-9714-5600023b2434" : "41d2169d-3079-4a05-b92d-df2af78e8b3e"} GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "VERIFY_SECRET", "data": [\ {\ "secret": "0000-0000-0000-0000" // GUID/UUID\ },\ ] } Last updated 5 years ago Was this helpful? Was this helpful? --- # New 911 Call | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call.md) . This API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Emergency Call[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#emergency-call) ---------------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/emergency/call_911` GitBook Assistant The 911 call API endpoint allows you to send 911 calls from in-game directly to your dispatchers. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant CALL\_911 GitBook Assistant data GitBook Assistant array GitBook Assistant Array of emergency call objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response GitBook AssistantAskCopy EMERGENCY CALL ADDED ID: {ID} GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "CALL_911", "data": [\ {\ "serverId": 1, // Server ID Integer\ "isEmergency": true, // Displays EMERGENCY or CIVIL type in the CAD\ "caller": "John Doe",\ "location": "1234 E. Test St.",\ "description": "Help, someone is breaking into my house!",\ "metaData": {\ "someKey": "someValue", // OPTIONAL: metaData for API custom storage\ "x": 1000, // OPTIONAL: Live Map X Coordinate\ "y": 1000 // OPTIONAL: Live Map Y Coordinate\ },\ "deleteAfterMinutes": 30 // OPTIONAL: Delete record after X minutes (temporary record)\ }\ ] } ### Server ID[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#server-id) Because Sonoran CAD allows you to separate units and dispatchers into separate servers, the serverId field ensures this emergency call is sent to the appropriate dispatcher. For more information, see our guide on [configuring multiple servers](https://docs.sonoransoftware.com/cad/tutorials/customization/configuring-multiple-servers) . GitBook Assistant ### Meta Data[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#meta-data) The `metaData` object can be used to store custom API data in the 911 call. GitBook Assistant Additionally, the following `metaData` properties will auto-set the dispatch call information: GitBook Assistant Property Type Description `priority` GitBook Assistant Integer GitBook Assistant Dispatch call priority GitBook Assistant Values 1, 2, 3 GitBook Assistant `block` GitBook Assistant String GitBook Assistant Dispatch Call Block GitBook Assistant `postal` GitBook Assistant String GitBook Assistant Dispatch Call Postal GitBook Assistant `code` GitBook Assistant String GitBook Assistant Dispatch Call 10-Code GitBook Assistant Last updated 1 year ago Was this helpful? * [Emergency Call](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#emergency-call) * [Server ID](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#server-id) * [Meta Data](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/emergency/dispatch-and-emergency-calls/911-call#meta-data) Was this helpful? --- # Apply Permission Key | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/apply-permission-key.md) . This API endpoint requires the **plus** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Apply Permission Key[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/apply-permission-key#apply-permission-key) --------------------------------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/apply_permission_key` GitBook Assistant This endpoint allows you to apply a permission key to a user in your community. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/apply-permission-key#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant APPLY\_PERMISSION\_KEY GitBook Assistant data GitBook Assistant array GitBook Assistant Array of user account permission key objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: 404 A non-linked API ID will be met with the following response: GitBook AssistantAskCopy Permission key {{ KEY }} applied! GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API ENDPOINT IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy API ID NOT LINKED TO AN ACCOUNT IN THIS COMMUNITY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "APPLY_PERMISSION_KEY", "data": [\ {\ "apiId": "STEAM:1234", // API ID entered in the unit identifiers\ // Typically, this is their STEAM ID\ "permissionKey": "Key123" // Name of Permission Key\ },\ ] } Learn more about [configuring permission keys](https://docs.sonoransoftware.com/cad/tutorials/getting-started/permissions) . GitBook Assistant Last updated 5 years ago Was this helpful? Was this helpful? --- # Check API ID | CAD | Sonoran Software Documentation For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt) . This page is also available as [Markdown](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/check-api-id.md) . This API endpoint requires the **standard** version of Sonoran CAD or higher. For more information, see our [pricing](https://docs.sonoransoftware.com/cad/pricing/faq) page. GitBook Assistant Check API ID[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/check-api-id#check-api-id) --------------------------------------------------------------------------------------------------------------------- `POST` `https://api.sonorancad.com/general/check_apiid` GitBook Assistant The unit location API endpoint allows you to check if a user has linked their CAD's API ID. GitBook Assistant #### Request Body[](https://docs.sonoransoftware.com/cad/api-integration/api-endpoints/general/check-api-id#request-body) Name Type Description id GitBook Assistant string GitBook Assistant Your community's ID GitBook Assistant key GitBook Assistant string GitBook Assistant Your community's API Key GitBook Assistant type GitBook Assistant string GitBook Assistant CHECK\_APIID GitBook Assistant data GitBook Assistant array GitBook Assistant Array of unit status objects GitBook Assistant 200 A successful call will be met with the following response: 400 The following 400 errors may be sent in response: 404 A non-linked API ID will be met with the following response: GitBook AssistantAskCopy {{ USERNAME }} GitBook AssistantAskCopy INVALID REQUEST TYPE INVALID COMMUNITY ID API IS NOT ENABLED FOR THIS COMMUNITY INVALID API KEY GitBook AssistantAskCopy API ID NOT LINKED TO AN ACCOUNT IN THIS COMMUNITY GitBook AssistantAskCopy { "id": "YOUR_COMMUNITY_ID", "key": "YOUR_API_KEY", "type": "CHECK_APIID", "data": [\ {\ "apiId": "STEAM:1234", // API ID entered in the unit identifiers\ // Typically, this is their STEAM ID\ },\ ] } Last updated 5 years ago Was this helpful? Was this helpful? ---