List canon jurisdiction rows

Canon module

GET/canon/jurisdictionscanonJurisdictions.list

A jurisdiction. An unpopulated jurisdiction returns no answer for permit and code questions. Returns a cursor page of canon jurisdiction rows the caller may see. The default order is `jurisdiction_id` ascending. 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

canonJurisdictions.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort 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_])*$
filter	Filter	No	Filter 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 CanonJurisdiction

canonJurisdictions.list: CanonJurisdiction
Field	Type	Required	Description
jurisdiction_id	JurisdictionId	Yes	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
level	string	Yes	Jurisdiction level.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
country	string	Yes	ISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$
parent	JurisdictionId	Yes	Jurisdiction identifier from `xpms.dim_jurisdiction`. An unpopulated jurisdiction returns no answer.Constraints: pattern ^[A-Z]{2}(-[A-Z0-9]+)*$
unit_system	string \| null	Yes	Unit system.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
currency	string \| null	Yes	Default currency of the jurisdiction.Constraints: pattern ^[A-Z]{3}$
status	string	Yes	Population status of the jurisdiction's rules.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
note	string \| null	Yes	Note from the Bible.Constraints: length 1 to 20000

{
  "data": [
    {
      "jurisdiction_id": "US-FL",
      "level": "region",
      "country": "US",
      "parent": "US-FL",
      "unit_system": "imperial",
      "currency": "USD",
      "status": "populated",
      "note": "Florida amendments to the model codes."
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/canon/jurisdictions" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.canonJurisdictions.listAll()) {
  console.log(row);
}

for row in xos.canon_jurisdictions.list_all():
    print(row)

xos canon-jurisdictions list --all