# Server Functions
### CadIsPlayerLinked
Checks if a specific CAD API ID exists by sending a request to the API and executing a callback with the result.
```lua
exports.sonorancad.CadIsPlayerLinked(apiId, callback)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
apiId | string | The CAD API ID to check. If empty or nil, the function assumes the ID does not exist. |
callback | function | A function executed after the check completes. Receives a single parameter: exists (boolean). |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. Instead, the result of the API check is passed to the `callback` function.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Checking if a CAD API ID exists
local function onApiIdCheck(exists)
if exists then
print("API ID exists!")
else
print("API ID does not exist.")
end
end
exports.sonorancad.CadIsPlayerLinked("123456", onApiIdCheck) -- Output depends on API response
exports.sonorancad.CadIsPlayerLinked("", onApiIdCheck) -- Output: "API ID does not exist."
```
{% endtab %}
{% endtabs %}
***
### GetPluginConfig
Provides access to a specific plugin's configuration using the plugin name.
```lua
exports.sonorancad.GetPluginConfig(submoduleName)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
submoduleName | string | The name of the submodule whose configuration is to be retrieved. |
{% endtab %}
{% tab title="Returns" %}
| Type | Description |
|---|
table or nil | - A table containing the configuration for the specified plugin.
- Returns
nil if the plugin name is invalid or if no configuration exists.
|
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Retrieving a plugin's configuration
local pluginConfig = exports.sonorancad.GetPluginConfig("callcommands")
if pluginConfig then
print("Plugin Config:", json.encode(pluginConfig))
else
print("Plugin not found or no configuration available.")
end
```
{% endtab %}
{% endtabs %}
***
### GetUnitByPlayerId
Retrieves the unit information associated with a player based on their identifiers.
```lua
exports.sonorancad.GetUnitByPlayerId(player)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
player | PlayerSource | The player ID for whom the associated unit is being retrieved. |
{% endtab %}
{% tab title="Returns" %}
| Type | Description |
|---|
table or nil | - A table representing the unit information for the player if found in
UnitCache. nil if no associated unit is found.
|
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Getting the unit associated with a player
local unit = GetUnitByPlayerId(1)
if unit then
print("Unit found:", json.encode(unit))
else
print("No unit associated with this player.")
end
```
{% endtab %}
{% endtabs %}
### GetUnitCache
Returns the global `UnitCache` table containing unit data.
```lua
exports['sonorancad']:GetUnitCache(includeDispatchers)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
| -------------------- | --------- | ---------------------------------------------- |
| `includeDispatchers` | `boolean` | Include an array of active dispatchers as well |
| {% endtab %} | | |
{% tab title="Returns" %}
| Type | Description |
|---|
table | - The entire
UnitCache table, which stores unit-related data. - If
UnitCache is empty or uninitialized, an empty table is returned. - If
includeDispatchers is true, will return arg1 - Standard UnitCache table, arg2- Array of dispatchers online. If false will only return standard UnitCache array. - Dispatchers will be shown regardless if they are in-game or not. To check if a dispatcher is also in-game use the
isInGame flag (boolean) on the unit
|
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Retrieving and inspecting the UnitCache
local unitCache = exports['sonorancad']:GetUnitCache()
if next(unitCache) then
print("UnitCache contains data:", json.encode(unitCache))
else
print("UnitCache is empty or uninitialized.")
end
-- Getting dispatchers as well
local unitCache, dispatchers = exports['sonorancad']:GetUnitCache(true)
if next(unitCache) then
print("UnitCache contains data:", json.encode(unitCache))
else
print("UnitCache is empty or uninitialized.")
end
if next(dispatchers) then
print("Dispatchers contains data: ", json.encode(dispatchers))
else
print("There are no dispatchers online.")
end
```
{% endtab %}
{% endtabs %}
Each cached unit payload now includes `unit.data.communityUserId` when the CAD account was linked through the v2 community link flow. That gives third-party resources a stable way to map a CAD unit or push event back to an in-game player without relying on legacy API IDs.
To understand where that value comes from, see [Map Players to CAD Users](/cad/api-integration/getting-started/setting-your-api-id.md) and the FiveM resource's [LINKING\_V2.md](https://github.com/Sonoran-Software/SonoranCADFiveM/blob/master/sonorancad/LINKING_V2.md).
Typical pattern:
```lua
local unitCache = exports['sonorancad']:GetUnitCache()
for _, unit in pairs(unitCache) do
if unit.data and unit.data.communityUserId == "license:abc123" then
print(("Matched CAD unit %s to linked player"):format(unit.data.unitNum))
end
end
```
### registerEndpoints
Registers API endpoints for use with the `sonorancad` resource.
```lua
exports.sonorancad.registerEndpoints()
```
{% tabs %}
{% tab title="Parameters" %}
None
{% endtab %}
{% tab title="Returns" %}
This function does not return a value. It registers API endpoints with `sonorancad`.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Registering the endpoints
exports.sonorancad.registerEndpoints()
print("SonoranCAD API endpoints registered.")
```
{% endtab %}
{% endtabs %}
### addBlip
Adds a new blip to the map using the SonoranCAD integration.
```lua
exports.sonorancad.addBlip(coords, colorHex, subType, toolTip, icon, dataTable, cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
coords | vec2 (table) | A table containing x and y coordinates for the blip location. |
colorHex | string | The hexadecimal color code (e.g., "#FF0000") for the blip. |
subType | string | The subtype of the blip (e.g., police, fire, etc.). |
toolTop | string | The tooltip text that appears when hovering over the blip. |
icon | string | The icon for the blip (e.g., a specific image or identifier for visual context). |
dataTable | table | Additional data associated with the blip, stored in a custom table. |
cb | function | (Optional) A callback function executed with the API response. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the API request is passed to the `cb` callback function if provided.
{% endtab %}
{% tab title="Usage Example" %}
```lua
-- Example: Adding a new blip to the map
exports.sonorancad.addBlip(
{ x = 123.45, y = 678.90 },
"#FF0000",
"police",
"Police Station",
"police-icon",
{ info = "Main Headquarters" },
function(response)
if response.success then
print("Blip successfully added!")
else
print("Failed to add blip:", response.error)
end
end
)
```
{% endtab %}
{% endtabs %}
### addBlips
Adds multiple blips to the map using the SonoranCAD integration.
```lua
exports.sonorancad.addBlips(blips, cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
blips | table | A table containing multiple blip data objects to be added. (See addBlip for blip structure) |
cb | function | (Optional) A callback function executed with the API response. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the API request is passed to the `cb` callback function if provided.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Adding multiple blips to the map
local blips = {
{
blip = {
id = -1,
subType = "police",
coordinates = { x = 123.45, y = 678.90 },
icon = "police-icon",
color = "#FF0000",
tooltip = "Police Station",
data = { info = "Main Headquarters" }
}
},
{
blip = {
id = -1,
subType = "fire",
coordinates = { x = 321.65, y = 987.10 },
icon = "fire-icon",
color = "#FFA500",
tooltip = "Fire Department",
data = { info = "Fire HQ" }
}
}
}
exports.sonorancad.addBlips(blips, function(response)
if response.success then
print("Blips successfully added!")
else
print("Failed to add blips:", response.error)
end
end)
```
{% endtab %}
{% endtabs %}
### removeBlip
Removes one or more blips from the map using the SonoranCAD integration.
```lua
exports.sonorancad.removeBlip(ids, cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
ids | table | A table containing the IDs of the blips to be removed. |
cb | function | (Optional) A callback function executed with the API response. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the API request is passed to the `cb` callback function if provided.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Removing blips by their IDs
local blipIds = { 101, 102, 103 }
exports.sonorancad.removeBlip(blipIds, function(response)
if response.success then
print("Blips successfully removed!")
else
print("Failed to remove blips:", response.error)
end
end)
```
{% endtab %}
{% endtabs %}
### modifyBlipd
Modifies an existing blip's data on the map using the SonoranCAD integration.
```lua
exports.sonorancad.modifyBlipd(blipId, dataTable)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
blipId | number | The unique ID of the blip to be modified. |
dataTable | table | A table containing the new data for the blip. See addBlip for blip data structure |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value. The request is sent to the `MODIFY_BLIP` endpoint.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Modifying an existing blip's data
local blipId = 101
local newData = {
color = "#00FF00",
tooltip = "Updated Tooltip",
coordinates = { x = 200.0, y = 300.0 }
}
exports.sonorancad.modifyBlipd(blipId, newData)
print("Blip modification request sent.")
```
{% endtab %}
{% endtabs %}
### getBlips
Fetches the list of all active blips from the SonoranCAD system.
```lua
exports.sonorancad.getBlips(cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
cb | function | (Optional) A callback function executed with the API response containing the blips. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the API request is passed to the `cb` callback function if provided.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Fetching all active blips
exports.sonorancad.getBlips(function(response)
if response.success then
print("Active Blips:", json.encode(response.data))
else
print("Failed to fetch blips:", response.error)
end
end)
```
{% endtab %}
{% endtabs %}
### removeWithSubtype
Removes all blips of a specific subtype from the map using the SonoranCAD system.
```lua
exports.sonorancad.removeWithSubtype(subType, cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
subType | string | The subtype of the blips to be removed (e.g., police, fire, etc.). |
cb | function | (Optional) A callback function executed with the API response containing the blips. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the `removeBlip` API request is passed to the `cb` callback function if provided.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Removing all police blips
exports.sonorancad.removeWithSubtype("police", function(response)
if response.success then
print("Police blips successfully removed!")
else
print("Failed to remove blips:", response.error)
end
end)
```
{% endtab %}
{% endtabs %}
### call911
The `call911` function facilitates the creation of a 911 emergency call within the SonoranCAD system by sending a structured API request.
```lua
exports.sonorancad.call911(caller, location, description, postal, plate, cb, coords, customMeta, deleteAfter)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
caller | string | Name of the individual initiating the call. |
location | string | Description of the call's location (e.g., street address). |
description | string | Detailed information about the emergency situation. |
postal | string | Postal code corresponding to the call's location. |
plate | string | (Optional) License plate number associated with the call, if applicable. |
cb | function | (Optional) Callback function to handle the API response. |
coords | table | A table containing the X and Y coordinates of the emergency call's location, typically sourced from in-game player or vehicle position. This is used to place the call accurately on the live map in CAD systems or dispatch plugins. |
customMeta | table | A flexible table for including any custom metadata relevant to the emergency call. |
deleteAfter | int | Number of minutes to automatically remove the call from CAD after |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the API request is passed to the `cb` callback function, if provided.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Initiating a 911 call
exports.sonorancad.call911(
"Jane Doe",
"1234 Elm Street",
"There is a fire in the building.",
"56789",
nil,
function(response)
if response.success then
print("911 call successfully placed.")
else
print("Failed to place 911 call:", response.error)
end
end,
{ x = 84.49, y = 953.593 },
{
someMetaData = "yes this is metadata"
}
)
```
{% endtab %}
{% endtabs %}
### addTempBlipData
Temporarily modifies a blip's data in the SonoranCAD system and then reverts it back to its original data after a specified duration.
```lua
exports.sonorancad.addTempBlipData(blipId, blipData, waitSeconds, returnToData)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
blipId | number | The unique ID of the blip to modify. |
blipData | table | A table containing the temporary data to apply to the blip. See addBlip for blip data structure |
waitSeconds | number | The duration in seconds for which the temporary data will be applied. |
returnToData | table | A table containing the original data to revert the blip to after the duration expires. See addBlip for blip data structure |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The data modification happens asynchronously using API requests.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Temporarily modifying a blip's color and tooltip
local tempData = {
color = "#FF0000",
tooltip = "Temporary Alert"
}
local originalData = {
color = "#00FF00",
tooltip = "Original Tooltip"
}
exports.sonorancad.addTempBlipData(101, tempData, 10, originalData)
print("Blip temporarily modified; it will revert in 10 seconds.")
```
{% endtab %}
{% endtabs %}
### addTempBlipColor
Temporarily changes a blip's color in the SonoranCAD system and reverts it to its original color after a specified duration.
```lua
exports.sonorancad.addTempBlipData(blipId, color, waitSeconds, returnToColor)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
blipId | number | The unique ID of the blip to modify. |
color | string | The temporary hexadecimal color code to apply to the blip (e.g., "#FF0000") |
waitSeconds | number | The duration in seconds for which the temporary data will be applied. |
returnToColor | string | The original hexadecimal color code to revert the blip to after the duration expires |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The color modification happens asynchronously using API requests.
{% endtab %}
{% tab title="Example Usage" %}
-- Example: Temporarily changing a blip's color to red
local tempColor = "#FF0000"
local originalColor = "#00FF00"
exports.sonorancad.addTempBlipColor(101, tempColor, 10, originalColor)
print("Blip color temporarily changed; it will revert in 10 seconds.")
{% endtab %}
{% endtabs %}
### remove911
Removes an active 911 call from the SonoranCAD system.
```lua
exports.sonorancad.remove911(callId)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
callId | string | The unique ID of the 911 call to be removed. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value. The removal of the 911 call is handled asynchronously through the API request.
{% endtab %}
{% tab title="Example Usage" %}
-- Example: Removing a 911 call
local callId = "12345"
exports.sonorancad.remove911(callId)
print("Request to remove 911 call sent.")
{% endtab %}
{% endtabs %}
### addCallNote
Adds a note to an existing 911 call in the SonoranCAD system.
```lua
exports.sonorancad.addCallNote(callId, note)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
callId | string | The unique ID of the 911 call to be removed. |
note | string | The content of the note to be added, typically describing the caller. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value. The addition of the call note is handled asynchronously through the API request.
{% endtab %}
{% tab title="Example Usage" %}
```
-- Example: Adding a note to an existing 911 call
local callId = "12345"
local note = "Caller reported a fire at the intersection of 5th and Main."
exports.sonorancad.addCallNote(callId, note)
print("Request to add note to 911 call sent.")
```
{% endtab %}
{% endtabs %}
### setCallPostal
Updates the postal code of an existing 911 call in the SonoranCAD system.
```lua
exports.sonorancad.setCallPostal(callId, postal)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
callId | string | The unique ID of the 911 call to be removed. |
postal | string | The new postal code to assign to the 911 call. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value. The postal code update is handled asynchronously through the API request.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Updating the postal code of an existing 911 call
local callId = "12345"
local postal = "56789"
exports.sonorancad.setCallPostal(callId, postal)
print("Request to update postal code sent.")
```
{% endtab %}
{% endtabs %}
### performLookup
Performs a lookup in the SonoranCAD system for information associated with a license plate.
```lua
exports.sonorancad.performLookup(plate, cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
|---|
plate | string | The license plate number to look up in the SonoranCAD system. |
cb | function | (Optional) A callback function executed with the API response. |
{% endtab %}
{% tab title="Returns" %}
This function does not return a value directly. The response from the API request is passed to the `cb` callback function if provided.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Performing a lookup for a license plate
local plate = "ABC123"
exports.sonorancad.performLookup(plate, function(response)
if response.success then
print("Lookup successful:", json.encode(response.data))
else
print("Lookup failed:", response.error)
end
end)
```
{% endtab %}
{% endtabs %}
### createDispatchCall
Creates a dispatch call in SonoranCAD
```lua
exports.sonorancad.createDispatchCall(origin, status, priority, block, address, postal, title, code, primary, trackPrimary, description, notes, metaData, units, cb)
```
{% tabs %}
{% tab title="Parameter" %}
| Parameter | Type | Description |
| -------------- | ---------- | ---------------------------------------------------------------------------------------- |
| `origin` | `number` | Source of the dispatch call (see ORIGIN enum in SonoranCAD documentation). Typically `0` |
| `status` | `number` | Initial call status (see STATUS enum). Typically `0` |
| `priority` | `number` | Call priority: `1` (high), `2` (medium), `3` (low). |
| `block` | `string` | Block or unit number of the incident location. |
| `address` | `string` | Full address or street description of the incident. |
| `postal` | `string` | Postal code corresponding to the call’s location. |
| `title` | `string` | Short title of the dispatch call (e.g., "Traffic Stop"). |
| `code` | `string` | CAD signal or code (e.g., "10-39 - Traffic Stop"). |
| `primary` | `number` | Identifier of the primary unit assigned to the call. |
| `trackPrimary` | `boolean` | Whether to track the primary unit on the live map. |
| `description` | `string` | Detailed description of the situation. |
| `notes` | `array` | Array of note objects related to the call. Optional. |
| `metaData` | `array` | Custom key-value metadata for internal tracking or display. Optional. |
| `units` | `array` | Array of unit API IDs (e.g., Steam hex IDs) to assign to the call. |
| `cb` | `function` | Callback function to handle the API response. |
| {% endtab %} | | |
{% tab title="Return" %}
This function does not return a value directly. The data modification happens asynchronously using API requests.
{% endtab %}
{% tab title="Example Usage" %}
```lua
-- Example: Creating a dispatch call
createDispatchCall(
0, -- origin
0, -- status
1, -- priority (1 = High)
"123", -- block number
"1234 Elm Street", -- address
"56789", -- postal
"Structure Fire", -- title
"10-70 - Structure Fire", -- code
456, -- primary unit ID
true, -- trackPrimary
"Caller reports flames visible from second floor window.", -- description
{}, -- notes (optional)
{ severity = "high", buildingType = "residential" }, -- custom metaData
{ "STEAM:110000112345678" }, -- units (API IDs)
function(response)
if response.success then
print("Dispatch call successfully created.")
else
print("Failed to create dispatch call:", response.error)
end
end
)
```
{% endtab %}
{% endtabs %}
### cadNameLookup
Perform a name lookup in CAD (Requires "Lookups" submodule to be enabled)
{% hint style="danger" %}
This function will not work if you do not have the "Lookups" submodule enabled. The submodule is enabled by default.
{% endhint %}
```lua
exports.sonorancad.cadNameLookup(first, last, mi, callback, autoLookup)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
| ------------ | ---------- | ------------------------------------------------------------------ |
| `first` | `string` | First Name |
| `last` | `string` | Last Name |
| `mi` | `string` | Middle Initial |
| `callback` | `function` | Callback function to handle the API response. |
| `autoLookup` | `string` | API ID of the user to perform a lookup via API ID rather than name |
| {% endtab %} | | |
{% tab title="Return" %}
This function will return the custom records related to the name as denoted in the [Custom Records](/cad/api-integration/api-endpoints/general/custom-records.md) section
{% endtab %}
{% tab title="Example Usage" %}
exports.sonorancad.cadNameLookup("Jordan", "Green", "J", function(record)
print(json.encode(record))
end, "123456789123456789")
{% endtab %}
{% endtabs %}
### cadPlateLookup
Perform a plate lookup in CAD (Requires "Lookups" submodule to be enabled)
{% hint style="danger" %}
This function will not work if you do not have the "Lookups" submodule enabled. The submodule is enabled by default.
{% endhint %}
```lua
exports.sonorancad.cadPlateLookup(plate, basicFlag, callback, autoLookup)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
| ------------ | ---------- | ------------------------------------------------------------------ |
| `plate` | `string` | Plate number to lookup |
| `basicFlag` | `null` | Depreciated parameter, can be set to `nil` |
| `callback` | `function` | Callback function to handle the API response. |
| `autoLookup` | `string` | API ID of the user to perform a lookup via API ID rather than name |
| {% endtab %} | | |
{% tab title="Return" %}
This function will return the custom records related to the plate as denoted in the [Custom Records](/cad/api-integration/api-endpoints/general/custom-records.md) section
{% endtab %}
{% tab title="Example Usage" %}
```lua
exports.sonorancad.cadPlateLookup("ABC123", function(record)
print(json.encode(record))
end, "123456789123456789")
```
{% endtab %}
{% endtabs %}
### cadGetPlateInformation
Retrieve parsed registration, vehicle, owner, BOLO, and warrant data for a single plate while reusing the shared plate-information cache. This is the same lookup path used by the WraithV2 integration.
{% hint style="info" %}
This function requires the `lookups` submodule to be enabled. Results are cached by normalized plate number for 60 seconds by default unless you override or bypass the cache in the options table.
{% endhint %}
```lua
exports.sonorancad.cadGetPlateInformation(plate, callback, options)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
| ---------------------- | ---------- | ---------------------------------------------------------------------------------------------- |
| `plate` | `string` | Plate number to look up. Leading and trailing whitespace is trimmed before caching and lookup. |
| `callback` | `function` | Callback invoked as `callback(regData, vehData, charData, boloData, warrantData)`. |
| `options` | `table` | Optional settings for CAD popup behavior and cache control. |
| `options.autoLookup` | `string` | Community user ID to trigger the CAD-side auto-open lookup behavior. |
| `options.cacheTtlMs` | `number` | Override the cache lifetime in milliseconds. Defaults to `60000`. |
| `options.bypassCache` | `boolean` | When `true`, skips cache reads and writes for this request. |
| `options.forceRefresh` | `boolean` | When `true`, ignores any existing cached entry and refreshes it from CAD. |
| {% endtab %} | | |
{% tab title="Returns" %}
This function does not return values directly. The callback receives five parsed arrays:
* `regData`: matching registration records
* `vehData`: matching vehicle record data
* `charData`: matching owner/civilian record data
* `boloData`: active BOLO flags for the plate
* `warrantData`: active warrant flags for the plate
{% endtab %}
{% tab title="Example Usage" %}
```lua
exports.sonorancad.cadGetPlateInformation("ABC123", function(regData, vehData, charData, boloData, warrantData)
print(("Registrations: %s"):format(json.encode(regData)))
print(("Vehicles: %s"):format(json.encode(vehData)))
print(("Owners: %s"):format(json.encode(charData)))
print(("BOLO flags: %s"):format(json.encode(boloData)))
print(("Warrant flags: %s"):format(json.encode(warrantData)))
end, {
autoLookup = "123456789123456789",
cacheTtlMs = 60000
})
```
{% endtab %}
{% endtabs %}
### getAllWarrantsAndBolos
Retrieve all active and inactive warrants and bolos with pagination support
```lua
exports.sonorancad.getAllWarrantsAndBolos(options, cb)
```
{% tabs %}
{% tab title="Parameters" %}
| Parameter | Type | Description |
| ---------------------------------------------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options` | `table` | Options for pagination and filtering. If omitted, defaults are used (Optional) |
| `options.pageSize` / `options.limit` | `number` | Page size per API request. Default `100` |
| `options.offset` | `number` | Starting offset for pagination. Default `0` |
| `options.maxPages` / `options.pageLimit` / `options.pages` | `number` | Max number of pages to fetch before stopping (caps total results). Default: no cap |
| `options.statuses` / `options.status` | `table` \| `string` \| `number` | Status filter(s). Defaults to `{0, 1}` (open + closed). Accepts numeric values or strings: `"open"`, `"active"`, `"closed"`, `"inactive"`, `"pending"`, `"approved"`, `"rejected"` |
| `options.types` | `table` | Record types to include. Default `{2, 3}` (Warrant + BOLO) |
| `cb` | `function` | Callback invoked as `cb(records, meta)` where records is the aggregated list and `meta` includes paging info or an error. |
| {% endtab %} | | |
{% tab title="Example Usage" %}
```lua
exports['sonorancad']:getAllWarrantsAndBolos(function(records, meta)
print(json.encode(records))
print(json.encode(meta))
end)
```
{% endtab %}
{% tab title="Returns" %}
```lua
-- records (array)
{
{
id = 12345,
type = 3, -- BOLO
name = "BOLO",
sections = {
{
category = 1,
label = "Flags",
fields = {
{ uid = "flags", data = { flags = { "Armed", "Violent" } } }
}
},
{
category = 0,
label = "Vehicle Information",
fields = {
{ uid = "plate", value = "ABC123" },
{ uid = "make", value = "Dodge" },
{ uid = "model", value = "Charger" },
{ uid = "color", value = "Black" }
}
}
}
},
{
id = 67890,
type = 2, -- Warrant
name = "Warrant",
sections = {
{
category = 1,
label = "Flags",
fields = {
{ uid = "flags", data = { flags = { "Felony", "No Bond" } } }
}
},
{
category = 0,
label = "Civilian Information",
fields = {
{ uid = "first", value = "Jane" },
{ uid = "last", value = "Doe" },
{ uid = "dob", value = "01/01/1990" }
}
}
}
}
}
-- meta
{
ok = true,
pages = 2,
limit = 100,
offset = 0,
statuses = { 0, 1 }
}
```
{% endtab %}
{% endtabs %}
---
# Agent Instructions: 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:
```
GET https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/framework-development-documentation/server-functions.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.