Get an emergency code
Safety module
GET/emergency-codes/{code}emergencyCodes.get
An org emergency code, seeded from the Standard Library and listed in numeric order. Returns one emergency code with its `ETag`. A emergency code the caller may not see returns 404.
- Requires the capability safety.incident.read.
- OAuth scopes: safety.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | Code token.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: EmergencyCode
| Field | Type | Required | Description |
|---|---|---|---|
| code | string | Yes | Code token.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| label | string | Yes | Code word.Constraints: length 1 to 300 |
| emergency | string | Yes | The emergency the code announces.Constraints: length 1 to 300 |
| swatch | string | Yes | Design token of the swatch.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| sort_order | integer | Yes | Canon order.Constraints: range 1 to any |
{
"code": "CODE_RED",
"label": "Code Red",
"emergency": "Fire Emergency",
"swatch": "ecode-red",
"sort_order": 1
}Code samples
curl -X GET "$XOS_BASE_URL/emergency-codes/CODE_RED" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.emergencyCodes.get("CODE_RED");response = xos.emergency_codes.get("CODE_RED")xos emergency-codes get CODE_RED