Get an emergency protocol

Canon module

GET/canon/std/emergency-protocols/{record_key}canonStdEmergencyProtocols.get

An emergency protocol of the Standard Library (Emergency Codes sheet): what one operational domain does when a radio code is called, in numbered steps. Returns one emergency protocol with its `ETag`. A emergency protocol the caller may not see returns 404.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonStdEmergencyProtocols.get: Path and query parameters
Field	Type	Required	Description
record_key	string	Yes	Record identifier of the protocol.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Response 200: CanonStdEmergencyProtocol

canonStdEmergencyProtocols.get: CanonStdEmergencyProtocol
Field	Type	Required	Description
record_key	string	Yes	Record identifier of the protocol.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
code	string	Yes	Radio code the protocol answers (xpms.emergency_code).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
domain	string	Yes	Operational domain the protocol applies to.Constraints: length 1 to 200
department	string \| null	Yes	Department as the sheet names it.Constraints: length 1 to 200
category	string \| null	Yes	Category as the sheet names it.Constraints: length 1 to 200
sub_category	string \| null	Yes	Sub-category as the sheet names it.Constraints: length 1 to 200
steps	array of CanonEmergencyProtocolStep	Yes	The protocol's steps (xpms.emergency_protocol_step), in order.

{
  "record_key": "EMG-001",
  "code": "CODE_RED",
  "domain": "Site Operations",
  "department": "Security & Safety",
  "category": "Emergency Protocols",
  "sub_category": "Incident Response",
  "steps": [
    {
      "step_no": 1,
      "body": "Contact {fire}."
    }
  ]
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/std/emergency-protocols/EMG-001" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.canonStdEmergencyProtocols.get("EMG-001");

response = xos.canon_std_emergency_protocols.get("EMG-001")

xos canon-std-emergency-protocols get EMG-001