Saltar al contenido

Get a std emergency code

Módulo Canon

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.

  • Requiere la capacidad canon.taxonomy.read.
  • Alcances de OAuth: canon.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

canonStdEmergencyCodes.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
codeStdCodeSíNatural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
fieldsFieldsNoSparse 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: StdEmergencyCode

canonStdEmergencyCodes.get: StdEmergencyCode
CampoTipoObligatorioDescripción
codeStdCodeSíNatural code of a Standard Library row (Section 2.1).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
labelstringSíCode name.Restricciones: length 1 to 200
emergencystringSíResponse procedure.Restricciones: length 1 to 20000
swatchstringSíDesign token of the swatch.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
sort_orderintegerSíOrder of first appearance in the Playbook.Restricciones: range 0 to any
{
  "code": "SOP-001",
  "label": "Medical Assist",
  "emergency": "Dispatch the medical team to the location.",
  "swatch": "ecode-red",
  "sort_order": 1
}

Ejemplos de código

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