Get an emergency code
Módulo Safety
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.
- Requiere la capacidad safety.incident.read.
- Alcances de OAuth: safety.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| code | string | Sí | Code token.Restricciones: 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.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: EmergencyCode
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| code | string | Sí | Code token.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| label | string | Sí | Code word.Restricciones: length 1 to 300 |
| emergency | string | Sí | The emergency the code announces.Restricciones: length 1 to 300 |
| swatch | string | Sí | Design token of the swatch.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| sort_order | integer | Sí | Canon order.Restricciones: range 1 to any |
{
"code": "CODE_RED",
"label": "Code Red",
"emergency": "Fire Emergency",
"swatch": "ecode-red",
"sort_order": 1
}Ejemplos de código
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