Skip to content

List std emergency code rows

Canon module

GET/canon/std/emergency-codescanonStdEmergencyCodes.list

An emergency code. Standard Library row, copied into each new org as editable org data. Returns a cursor page of std emergency code rows the caller may see. Coded list: the default order is numeric code order by `code`. Supports sparse fieldsets and the filter grammar.

  • Requires the capability canon.taxonomy.read.
  • OAuth scopes: canon.
  • Cursor-paginated: limit, cursor, fields, sort and filter apply.
  • Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonStdEmergencyCodes.list: Path and query parameters
FieldTypeRequiredDescription
limitLimitNoPage size. Default 50, maximum 200.Constraints: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
fieldsFieldsNoSparse 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_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of StdEmergencyCode

canonStdEmergencyCodes.list: StdEmergencyCode
FieldTypeRequiredDescription
codeStdCodeYesNatural code of a Standard Library row (Section 2.1).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
labelstringYesCode name.Constraints: length 1 to 200
emergencystringYesResponse procedure.Constraints: length 1 to 20000
swatchstringYesDesign token of the swatch.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
sort_orderintegerYesOrder of first appearance in the Playbook.Constraints: range 0 to any
{
  "data": [
    {
      "code": "10",
      "label": "Medical Assist",
      "emergency": "Dispatch the medical team to the location.",
      "swatch": "ecode-red",
      "sort_order": 1
    },
    {
      "code": "20",
      "label": "Medical Assist",
      "emergency": "Dispatch the medical team to the location.",
      "swatch": "ecode-red",
      "sort_order": 1
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/std/emergency-codes" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.canonStdEmergencyCodes.listAll()) {
  console.log(row);
}
for row in xos.canon_std_emergency_codes.list_all():
    print(row)
xos canon-std-emergency-codes list --all