Get a std emergency code
Canon module
GET/canon/std/emergency-codes/{code}canonStdEmergencyCodes.get
An emergency code. Standard Library row, copied into each new org as editable org data. Returns one std emergency code with its `ETag`. A std emergency code 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
| Field | Type | Required | Description |
|---|---|---|---|
| code | StdCode | Yes | Natural code of a Standard Library row (Section 2.1).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: StdEmergencyCode
| Field | Type | Required | Description |
|---|---|---|---|
| code | StdCode | Yes | Natural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| label | string | Yes | Code name.Constraints: length 1 to 200 |
| emergency | string | Yes | Response procedure.Constraints: length 1 to 20000 |
| swatch | string | Yes | Design token of the swatch.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| sort_order | integer | Yes | Order of first appearance in the Playbook.Constraints: range 0 to any |
{
"code": "SOP-001",
"label": "Medical Assist",
"emergency": "Dispatch the medical team to the location.",
"swatch": "ecode-red",
"sort_order": 1
}Code samples
curl -X GET "$XOS_BASE_URL/canon/std/emergency-codes/SOP-001" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonStdEmergencyCodes.get("SOP-001");response = xos.canon_std_emergency_codes.get("SOP-001")xos canon-std-emergency-codes get SOP-001