Data Structures
This page documents the data structures used by PR exports and API payloads.
Page Request (Server)
Used by:
request.addresses
request.players
request.nature
request.body
- addresses
- players
- nature
- body
string[]
List of capcodes/addresses to send the page to.
Example: { "emg.fire.bc", "emg.ems.bc" }
number[]
Optional list of player server IDs to directly page.
Example: { 1, 2, 3 }
PageNature as lowercase string or enum number
The page type/nature.
Example: administrative or 2
string
Page message body.
Must not be empty and must respect the configured max length.
Local Page Request (Client)
Used by:
request.nature
request.body
- nature
- body
PageNature as lowercase string or enum number
The page type/nature.
Example: administrative or 2
string
Page message body.
Page Message
Used by:
page.read
page.nature
page.timestamp
page.body
- read
- nature
- timestamp
- body
bool
Whether the message has been read.
Will be omitted in server-side payloads.
number (PageNature enum value)
The page type/nature as an enum value.
Example: 0 (emergency)
string
ISO 8601 timestamp string (round-trip format).
Example: 2026-03-26T04:05:06.7890000+00:00
string
The page message body text, in uppercase.
Page Nature
Used by:
nature
emergencyor0nonemergencyor1administrativeor2
Even if the nature types are renamed in the language file, they will still need to be written as above. If you plan to rename the natures, we suggest using the enum values to avoid confusion.