Lookup By Custom Search

Sonoran CAD has additional record lookup capabilities via custom search types.

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_custom

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

{% tab title="200 A successful call will be met with the following response: Detailed contents of the record type arrays can be found further below." %}

[] // Array of records

INVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY
INVALID EMPTY SEARCH

API Call Example

{
    "id": "YOUR_COMMUNITY_ID",
    "key": "YOUR_API_KEY",
    "type": "LOOKUP_INT",
    "data": [
        {
            "map": "ssn", // Unique Field ID for the custom search type
            "value": "Some Search Input",
            "types": [2, 3], // Search only for warrant and BOLO records
            "partial": true // Partial or exact string search from value
        }
    ]
}

Map

The search map is the unique Custom Record Field ID used in your custom search type.

Record Types

Response Object Types