Get a canon jurisdiction

Canon module

GET/canon/jurisdictions/{jurisdiction_id}canonJurisdictions.get

A jurisdiction. An unpopulated jurisdiction returns no answer for permit and code questions. Returns one canon jurisdiction with its `ETag`. A canon jurisdiction the caller may not see returns 404.

Requires the capability canon.taxonomy.read.
OAuth scopes: canon.
Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

canonJurisdictions.get: Path and query parameters
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]+)*$
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: CanonJurisdiction

canonJurisdictions.get: 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

{
  "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."
}

Code samples

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

const { data, etag } = await xos.canonJurisdictions.get("US-FL");

response = xos.canon_jurisdictions.get("US-FL")

xos canon-jurisdictions get US-FL