Custom Records

Sonoran CAD allows you to access, create, update, and remove highly customize records and reports via API.

Record API Endpoints

All custom records and reports utilize the same common formatting. You can manage custom records via the endpoints shown below.

Retrieve Record Templates

Access your existing custom record types built from the CAD's custom record editor.

Get Record Templates

Create a New Record

Add a new custom record to your community.

New Record

Edit an Existing Record

Modify and update an existing record in your community.

Edit Record

Remove a Record

Remove an existing record from your community.

Remove Record

Record Formatting

Custom records require a strict format with several dozen different data fields. Due to the complexity, it is highly recommended to create a new custom record template in the CAD UI, and then retrieve the record template for adding new records.

{
    "recordTypeId": -1, // This is the unique ID for this record type!
    "id": -1, // This is the individual record ID number (Leave -1 for NEW)
    "syncId": "", // This is used for DB Sync/Merge mapping - Leave Blank
    "name": "Eample Record Type", // This is the name of the record type
    "type": 1, // See TYPE enum
    "sections": [] // Array of custom record "section" objects
}

Record Type ID

This is a unique ID for this record type. It is highly recommended to get all of this data from an existing custom record template that you have created in the CAD.

Record Type

The record "type" is an enumerator used to distinguish the category of the custom record/report.

Enum

Description

2

Custom Warrant

3

Custom BOLO

4

Custom License

5

Custom Vehicle Registration

7

Custom Character

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

Last updated