This is an old version of this document, from version 0.9 of the Open511 spec. You should probably visit the current version of our documentation.

Overview

purposeThe jurisdiction represents a government entity (city, state/province department of transportation, agency, etc.) publishing Open511 data.
methodGET

Parameters and filters

The jurisdiction resource does not support any URL parameter or filter besides format selection and language negotiation.

Example

Example of the XML and JSON representations of the jurisdiction resource

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<open511
    xml:lang="en"
    xml:base="http://my.city.gov/open511"
    version="v0"
>
  <jurisdictions>  
    <jurisdiction>
      <link rel="self" href="/api/jurisdictions/my.city.gov/" />   
      <id>my.city.gov</id>
      <name>My City</name>
      <email>mayor@my.city.gov</email>
      <phone>+1 555-555-0000</phone>
      <description>Official traffic data (construction) from My City</description>
      <link rel="description" href="http://my.city.gov/open511/presentation.html" />
      <timezone>America/New_York</timezone>
      <link rel="geography" href="/jurisdictions/my.city.gov/geography/"/>
      <link rel="license" href="http://my.city.gov/opendatalicense/"/>
      <languages>
        <language>fr</language>
        <language>en</language>
      </languages>
    </jurisdiction>
  </jurisdictions>
</open511>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
    "jurisdictions": [
        {
            "id": "my.city.gov", 
            "name": "My City",
            "url": "/api/jurisdictions/my.city.gov/",
            "description": "Official traffic data (construction) from My City", 
            "description_url": "http://my.city.gov/open511/presentation.html", 
            "geography_url": "/jurisdictions/my.city.gov/geography/", 
            "languages": [
                "fr", 
                "en"
            ], 
            "phone": "+1 555-555-0000", 
            "license_url": "http://my.city.gov/opendatalicense/", 
            "timezone": "America/New_York", 
            "email": "mayor@my.city.gov"
        }
    ],
    "meta": {
        "version": "v0"
    }
}

Jurisdiction data structure

The jurisdiction follows the formatting guidelines of an individual item.

FieldTypeDescription
selfLink

Mandatory

Self link to the current resource.

idString

Mandatory

Unique identifier for the jurisdiction. It’s expected to be unique across all Open511 implementations. It must take the form of a hostname within a domain owned by the government entity. The hostname doesn’t necessarily need to resolve in DNS; for example, if Roadsville owns roadsville.gov, it’s fine to create agency1.roadsville.gov and agency2.roadsville.gov jurisdictions, even if those don’t resolve to IP addresses.

nameFree text

Mandatory

Name of the jurisdiction.

emailString

Mandatory

Valid email that can be used to contact the department or person in charge of the data provided by the Open511 API

descriptionLink

Optional

Link pointing to a human readable resource (web page, pdf file, etc) providing details about the Open511 service and the jurisdiction covered.

phoneString

Optional

Phone number to contact the department or person in charge of the data provided by the Open511 API

descriptionFree text

Optional

Free text that can be used by a client application to provide some information about the Open511 service and the jurisdiction covered.

geographyLink

Mandatory

The geography field links an open511 jurisdiction geography resource providing the jurisdiction boundaries.

timezonetimezone

Optional

The timezone of the jurisdiction; will be used as the default for events belonging to this jurisdiction. Should always be provided, except in cases where a jurisdiction spans multiple timezones.

distance_unitEnum

Optional

The unit this jurisdiction uses to measure distances. Can be KILOMETRES or MILES, but kilometres are the default and so jurisdictions using kilometres need not specify a distance_unit.

licenseLink

Mandatory

Link to a resource containing the license covering the data provided in the API.

languagesCollection of language

Optional

List of languages supported by this endpoint. A language element should be provided for each language supported

— language

Enum

Mandatory

Multiple occurrences supported. The values supported are the same as the language negotiation feature