Lookup By Value

Sonoran CAD has additional record lookup capabilities via specific values for unit identifiers, record or supervisor status, and more!

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

API response times may be increased slightly for communities with Database Sync enabled, depending upon the speed, latency and size of your in-game database.

Lookup By Value

POST https://api.sonorancad.com/general/lookup_value

The lookup name endpoint allows you to retrieve all records associated with a specific value.

Request Body

Name
Type
Description

id

string

Your community's ID

key

string

Your community's API Key

type

string

LOOKUP_INT

data

array

Array containing a lookup information object

[] // Array of records

API Call Example

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "LOOKUP_INT",
    "data": [
        {
            "apiId": "STEAM:1234", // OPTIONAL FIELD - Will return results to user's CAD
            "searchType": 0, // See the "Search Type" enum
            "value": 1, // See the "Value" information
            "types": [2, 3], // Search only for warrant and BOLO records
            "limit": 10, // OPTIONAL: Only the 10 most recent records
            "offset": 0, // OPTIONAL: Start from the first page of (10) records
        }
    ]
}

API ID

Adding the API ID field is optional, and will send the lookup results to the user's CAD as well.

Last updated