Road
Resources
Common
Getting Started
Tools
Versions
Contribute
Drafts
This is a draft. It may be included in Open511 in the future, but is not currently a maintained part of the specification. If you're interested in using it or participating in its development, please get in touch.
Overview
purpose | A road, within a particular jurisdiction. |
method | GET |
Parameters
In addition to the filters described below, some URL parameters are common to all resources: format, version, accept-language, and limit.
Parameter | Required/optional | Description |
---|---|---|
name | optional | Filter on the |
jurisdiction | optional | The ID of a jurisdiction, in order to show only events from a given jurisdiction. Use a comma-separated list to make OR queries. Example: |
Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<open511
xml:lang="en"
xml:base="http://my.city.gov/api/"
version="v1"
>
<roads>
<road>
<name>Mill St.</name>
<id>my.city.gov/mill-st</id>
<link rel="self" href="http://my.city.gov/api/roads/my.city.gov/mill-st/" />
<link rel="jurisdiction" href="http://my.city.gov/api/jurisdiction/my.city.gov/" />
</road>
<road>
<name>Highway 5</name>
<name xml:lang="es">Carretera 5</name>
<id>my.city.gov/hwy-5</id>
<link rel="self" href="http://my.city.gov/api/roads/my.city.gov/hwy-5/" />
<link rel="jurisdiction" href="http://my.city.gov/api/jurisdiction/my.city.gov/" />
<national_road_network_id xmlns="http://roadnetwork.example.gov/open511-extensions">MSG5</national_road_network_id>
</road>
</roads>
<pagination>
<offset>0</offset>
</pagination>
</open511>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"roads": [
{
"url": "http://my.city.gov/api/roads/my.city.gov/mill-st/",
"name": "Mill St.",
"jurisdiction_url": "http://my.city.gov/api/jurisdiction/my.city.gov/",
"id": "my.city.gov/mill-st"
},
{
"url": "http://my.city.gov/api/roads/my.city.gov/hwy-5/",
"name": "Highway 5",
"jurisdiction_url": "http://my.city.gov/api/jurisdiction/my.city.gov/",
"id": "my.city.gov/hwy-5",
"+national_road_network_id": "MSG5"
}
],
"pagination": {
"offset": 0
},
"meta": {
"version": "v1"
}
}
Road data structure
Field | Type | Description |
---|---|---|
name | Free text | Mandatory The name of the road |
id | Open511 ID | Mandatory A globally unique ID for the road, following the Open511 ID format. |
self | Link | Mandatory Self link to the current resource. |
jurisdiction | Link | Mandatory Link to the jurisdiction publishing the road. |