Area
Resources
Common
Getting Started
Tools
Versions
Contribute
Drafts
Overview
purpose | A geographical area: a city, district, neighbourhood, etc. |
method | GET |
Parameters and filters
The area 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 area resource in the context of a list.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<open511
xml:lang="en"
xml:base="http://my.city.gov/open511/"
version="v1"
>
<areas>
<area>
<name>Anaheim</name>
<id>geonames.org/5323810</id>
<link rel="self" href="http://geonames.org/5323810/" />
</area>
<area>
<name>Orange County</name>
<id>geonames.org/5379524</id>
<link rel="self" href="http://geonames.org/5379524/" />
</area>
</areas>
<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
{
"areas": [
{
"url": "http://geonames.org/5323810/",
"name": "Anaheim",
"id": "geonames.org/5323810"
},
{
"url": "http://geonames.org/5379524/",
"name": "Orange County",
"id": "geonames.org/5379524"
}
],
"pagination": {
"offset": 0
},
"meta": {
"version": "v1"
}
}
Area item data structure
The areas resource is a list of items. (A single area is not assigned its own resource URL in Open511, though it has a URL at GeoNames.) So the overall data structure follows the list structure as defined in the formatting guidelines. What follows defines a single area
item.
Field | Type | Description |
---|---|---|
name | Free text | Mandatory The name of the area |
id | Open511 ID | Mandatory Unique identifier for the area. If the area is a standard political division (city, state, province, county, etc.) you must use the ID from the GeoNames database, in the form of e.g. If (and only if) the area is defined internally by your jurisdiction, and is neither a standard political division nor already in GeoNames, assign a unique ID within your own jurisdiction: |
self | Link | Optional URL to a human-readable Web page with information about the area. For GeoNames areas, use |