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
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 recordsINVALID REQUEST TYPE
INVALID COMMUNITY ID
API IS NOT ENABLED FOR THIS COMMUNITY
INVALID API KEY
INVALID EMPTY SEARCHAPI Call Example
API ID
Adding the API ID field is optional, and will send the lookup results to the user's CAD as well.
SearchType Enumerator
The searchType enumerator determines how your value integer is interpreted.
0
IDENTIFIER
1
SUPERVISOR_STATUS
2
ACTIVE_STATUS
3
NUMBER
4
SECRET
5
ACCOUNT
Value Integer
The value integer is the primary search key for the searchType specified.
Identifier (searchType 0)
When specifying an identifier searchType the value represents the unique identifier ID of a specific unit. You can retrieve this unique identifier ID via the Get Identifiers endpoint.
This will return all records associated with the provided unit identifier.
Supervisor Status (searchType 1)
When specifying a supervisor status searchType the value represents the supervisor status of the records being searched.
0
Open: Requires Supervisor Actions
1`
Closed: No Supervisor Actions Needed
Active Status (searchType 2)
When specifying an active status searchType the value represents the record status of the records being searched.
The value integer enumeration here is used particularly to search open/closed warrants and pending/approved/rejected DMV records.
0
Warrant: Open
DMV: Pending
1
Warrant: Closed
DMV: Approved
2
DMV: Rejected
Number (searchType 3)
When specifying a number searchType the value represents the unique record number being searched. You can find the specific record number via any lookup or lookup by value result.
Secret (searchType 4)
When specifying a user account secret ID, the value represents the unique user account secret UUID. Users will find this secret key in their API ID settings menu.
Account (searchType 5)
When specifying a user account ID, the value represents the unique user account UUID. This value is internal, and not exposed to on the UI. The verify_secret or get_account endpoints will allow communities to capture the account UUID programmatically.
Record Type
The record "type" is an enumerator used to distinguish the category of the custom record/report. These integer values are entered as an array in the types field of the lookup call.
The characters object array will always be included with the search. The types filtering only applies to the custom records being returned.
2
Warrant
3
BOLO
4
License
5
Custom Vehicle Registration
7
Custom Character Record
8
Custom Police Record
9
Custom Police Report
10
Custom Medical Record
11
Custom Medical Report
12
Custom Fire Record
13
Custom Fire Report
14
Custom DMV Record
15
Custom Law Record
16
Custom Law Report
Response Object Types
Records Formatting
All record results are returned in an object array. For more information on custom record structuring, see the documentation below:
Custom RecordsLast updated
Was this helpful?