Lookup By Custom Search

Search records by a custom mapped field.

POST https://api.sonorancad.com/v2/general/lookups/custom

Rate limit: 30 requests per minute Authenticated v2 endpoints are rate limited per API key rather than per IP address.

Search records by a custom lookup mapping.

Request Body

{
  "map": "drivers_license",
  "value": "D1234567",
  "types": [7],
  "partial": false
}

Example Request

-- luarocks install sonoran.lua
local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CAD,
  communityId = "YOUR_COMMUNITY_ID",
  apiKey = "YOUR_API_KEY",
  defaultServerId = 1
})

local response = sonoran.cad:lookupCustomV2({
    map = 'vehicle',
    value = 'ABC123',
    types = {1},
    partial = true,
  })

-- Inspect response.success, response.data, or response.reason as needed.
print(response.success)

Call from a server-side FiveM resource using the exported CAD client:

local cad = exports["sonorancad"]:getCadClient()
local response = cad:lookupCustomV2({
  map = "vehicle",
  value = "ABC123",
  types = { 1 },
  partial = true
})
print(response.success)

JavaScript resources can use exports.sonorancad.getCadClient(). For .NET, construct a client from the protected CAD convars. Python is for external integrations, not FiveM resources.

// npm install @sonoransoftware/sonoran.js
const Sonoran = require('@sonoransoftware/sonoran.js');

(async () => {
  const instance = new Sonoran.Instance({
    communityId: 'YOUR_COMMUNITY_ID',
    apiKey: 'YOUR_API_KEY',
    product: Sonoran.productEnums.CAD,
    serverId: 1,
  });

  const response = await instance.cad.lookupCustomV2({
    map: 'vehicle',
    value: 'ABC123',
    types: [1],
    partial: true,
  });
  console.log(response);
})();

# pip install Sonoran.py
# Sonoran.py is for external Python integrations; FiveM resources should use the SonoranCADFiveM tab.
from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CAD,
    serverId=1,
)

response = instance.cad.lookupCustomV2({
    "map": 'vehicle',
    "value": 'ABC123',
    "types": [1],
    "partial": True,
  })

print(response.success)
print(response.data if response.success else response.reason)

// dotnet add package Sonoran.Net
using Sonoran;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CAD,
    communityId = "YOUR_COMMUNITY_ID",
    apiKey = "YOUR_API_KEY",
    defaultServerId = 1
});

var response = await sonoran.Cad.lookupCustomV2(new LookupCustomV2Request
{
    Map = "license_number",
    Value = "DL-12345",
    Types = new[] { 7 },
    Partial = true
});

Console.WriteLine(response.success);
Console.WriteLine(response.data);

Import this YAML into Postman with Import -> Raw text to create a single-endpoint request collection for this route.

openapi: "3.0.3"
info:
  title: "Sonoran CAD v2 - Lookup By Custom Search"
  version: "1.0.0"
  description: "Search records by a custom mapped field."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/general/lookups/custom:
    post:
      summary: "Lookup By Custom Search"
      operationId: "lookupByCustomSearch"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                recordTypeId: 7
                id: 2451
                syncId: "citizen:1234"
                name: "John Doe"
                type: 7
                sections:
                  category: 0
                  label: "Civilian Info"
                  fields:
                    label: "First Name"
                    value: "John"
                    uid: "first_name"
      security:
        -
          bearerAuth:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: "object"
            example:
              map: "drivers_license"
              value: "D1234567"
              types: 7
              partial: false
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request POST \
  --url "https://api.sonorancad.com/v2/general/lookups/custom" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "map": "drivers_license",
  "value": "D1234567",
  "types": [7],
  "partial": false
}'

Response

Successful requests return application/json.

[
  {
    "recordTypeId": 7,
    "id": 2451,
    "syncId": "citizen:1234",
    "name": "John Doe",
    "type": 7,
    "sections": [
      {
        "category": 0,
        "label": "Civilian Info",
        "fields": [
          {
            "label": "First Name",
            "value": "John",
            "uid": "first_name"
          }
        ]
      }
    ]
  }
]

PreviousLookup By Value

NextConfiguration

Last updated 1 month ago

Was this helpful?