Set Pager Config

Replace Inferno pager configuration for a server.

PUT https://api.sonorancad.com/v2/emergency/servers/{serverId}/pager-config

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

Replace the Inferno pager configuration for a server. If nodes is omitted, Sonoran CAD preserves the existing node tree for that server.

Path Parameters

Name

Type

Description

serverId

integer

Configured Sonoran CAD server ID.

Request Body

{
  "natureWords": {
    "Emergency": "Emergency",
    "NonEmergency": "Non-Emergency",
    "Administrative": "Administrative"
  },
  "maxAddresses": 5,
  "maxBodyLength": 250,
  "nodes": [
    {
      "id": "root-1",
      "name": "Fire",
      "description": "Fire services",
      "permission": "fire",
      "address": "FIRE-01",
      "shortCode": "F1",
      "kind": "group",
      "children": []
    }
  ]
}

Example Request

-- luarocks install sonoran.lua
-- For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
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:setPagerConfigV2({
    serverId = 1,
    natureWords = {
      Emergency = 'Emergency',
      NonEmergency = 'Non-Emergency',
      Administrative = 'Administrative',
    },
    maxAddresses = 5,
    maxBodyLength = 250,
    nodes = {
      {
        id = 'root-1',
        name = 'Fire',
        description = 'Fire services',
        permission = 'fire',
        address = 'FIRE-01',
        shortCode = 'F1',
        kind = 'group',
        children = {},
      },
    },
  })

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

Use this tab only when calling the v2 API from the server side of an in-game FiveM resource.

Sonoran.lua and Sonoran.js: use the sonorancad export to get the ready CAD client.
Sonoran.Net: FiveM exports do not return a .NET client. Read the Sonoran CAD convars and create a fresh client.
Sonoran.py: FiveM does not run Python resources; use the Python tab for external integrations.

The API key is stored in sonoran_apiKey as a protected FiveM convar. FiveM restricts a convar after add_convar_permission is configured, so only explicitly permitted resources can read it. Grant another resource access with add_convar_permission your-resource-name read sonoran_apiKey. If you change the API key in config.json, fully restart the sonorancad resource before reading the updated convar value.

Sonoran.lua

local cad = exports["sonorancad"]:getCadClient()

Sonoran.js

const cad = exports["sonorancad"].getCadClient();

Sonoran.Net

// dotnet add package Sonoran.Net
using CitizenFX.Core.Native;
using Sonoran;

var communityId = API.GetConvar("sonoran_communityID", "");
var apiKey = API.GetConvar("sonoran_apiKey", "");
var serverIdRaw = API.GetConvar("sonoran_serverId", "1");
var serverId = int.TryParse(serverIdRaw, out var parsedServerId) ? parsedServerId : 1;

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

After getting the Lua export client:

local response = cad:setPagerConfigV2({
    serverId = 1,
    natureWords = {
      Emergency = 'Emergency',
      NonEmergency = 'Non-Emergency',
      Administrative = 'Administrative',
    },
    maxAddresses = 5,
    maxBodyLength = 250,
    nodes = {
      {
        id = 'root-1',
        name = 'Fire',
        description = 'Fire services',
        permission = 'fire',
        address = 'FIRE-01',
        shortCode = 'F1',
        kind = 'group',
        children = {},
      },
    },
  })

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

// npm install @sonoransoftware/sonoran.js
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab for the export-based client.
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.setPagerConfigV2({
    serverId: 1,
    natureWords: {
      Emergency: 'Emergency',
      NonEmergency: 'Non-Emergency',
      Administrative: 'Administrative',
    },
    maxAddresses: 5,
    maxBodyLength: 250,
    nodes: [
      {
        id: 'root-1',
        name: 'Fire',
        description: 'Fire services',
        permission: 'fire',
        address: 'FIRE-01',
        shortCode: 'F1',
        kind: 'group',
        children: [],
      },
    ],
  });
  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.setPagerConfigV2({
    "serverId": 1,
    "natureWords": {
      "Emergency": 'Emergency',
      "NonEmergency": 'Non-Emergency',
      "Administrative": 'Administrative',
    },
    "maxAddresses": 5,
    "maxBodyLength": 250,
    "nodes": [
      {
        "id": 'root-1',
        "name": 'Fire',
        "description": 'Fire services',
        "permission": 'fire',
        "address": 'FIRE-01',
        "shortCode": 'F1',
        "kind": 'group',
        "children": [],
      },
    ],
  })

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

// dotnet add package Sonoran.Net
// For SonoranCADFiveM in-game usage, see the SonoranCADFiveM tab; .NET creates a fresh client from convars.
using System.Collections.Generic;
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.setPagerConfigV2(new SetPagerConfigV2Request
{
    ServerId = 1,
    NatureWords = new Dictionary<string, string>
    {
        ["Emergency"] = "Emergency",
        ["NonEmergency"] = "Non-Emergency",
        ["Administrative"] = "Administrative"
    },
    MaxAddresses = 5,
    MaxBodyLength = 250,
    Nodes = new[]
    {
        new PagerNodeV2
        {
            Id = "root-1",
            Name = "Fire",
            Description = "Fire services",
            Permission = "fire",
            Address = "FIRE-01",
            ShortCode = "F1",
            Kind = "group",
            Children = []
        }
    }
});

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 - Set Pager Config"
  version: "1.0.0"
  description: "Replace Inferno pager configuration for a server."
servers:
  -
    url: "https://api.sonorancad.com"
paths:
  /v2/emergency/servers/{serverId}/pager-config:
    put:
      summary: "Set Pager Config"
      operationId: "setPagerConfig"
      responses:
        200:
          description: "Successful response"
          content:
            application/json:
              schema:
                type: "object"
              example:
                serverId: 1
      parameters:
        -
          description: "Configured Sonoran CAD server ID."
          name: "serverId"
          in: "path"
          schema:
            type: "integer"
          example: 1
          required: true
      security:
        -
          bearerAuth:
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: "object"
            example:
              natureWords:
                Emergency: "Emergency"
                NonEmergency: "Non-Emergency"
                Administrative: "Administrative"
              maxAddresses: 5
              maxBodyLength: 250
              nodes:
                -
                  id: "root-1"
                  name: "Fire"
                  description: "Fire services"
                  permission: "fire"
                  address: "FIRE-01"
                  shortCode: "F1"
                  kind: "group"
                  children: []
components:
  securitySchemes:
    bearerAuth:
      type: "http"
      scheme: "bearer"
      bearerFormat: "JWT"

curl --request PUT \
  --url "https://api.sonorancad.com/v2/emergency/servers/1/pager-config" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --data '{
  "natureWords": {
    "Emergency": "Emergency",
    "NonEmergency": "Non-Emergency",
    "Administrative": "Administrative"
  },
  "maxAddresses": 5,
  "maxBodyLength": 250,
  "nodes": [
    {
      "id": "root-1",
      "name": "Fire",
      "description": "Fire services",
      "permission": "fire",
      "address": "FIRE-01",
      "shortCode": "F1",
      "kind": "group",
      "children": []
    }
  ]
}'

Response

Successful requests return application/json.

{
  "serverId": 1
}

PreviousGet Pager Config

NextSet Stations

Last updated 1 month ago

Was this helpful?