Browse Source

Merge pull request #131 from pelias/add_new_layers

Update and make the list of layers consistent
pull/132/head
Julian Simioni 8 years ago committed by GitHub
parent
commit
5d952c4611
  1. 28
      autocomplete.md
  2. 6
      data-sources.md
  3. 5
      reverse.md
  4. 5
      search.md

28
autocomplete.md

@ -84,20 +84,20 @@ without `sources=openaddresses` you will find the most popular Pennsylvanias fir
### Layers
The type of record is referred to as its `layer`. All records are indexed into the following layers:
* `venue`
* `address`
* `microhood`
* `neighbourhood`
* `macrohood`
* `county`
* `macrocounty`
* `localadmin`
* `locality`
* `borough`
* `region`
* `country`
You can also refer to all the administrative hierarchy layers with a single alias, `coarse`.
|layer|description|
|----|----|
|`venue`|points of interest, businesses, things with walls|
|`address`|places with a street address|
|`country`|places that issue passports, nations, nation-states|
|`macroregion`|a related group of regions. Mostly in Europe|
|`region`|states and provinces|
|`macrocounty`|a related group of counties. Mostly in Europe.|
|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region|
|`locality`|towns, hamlets, cities|
|`localadmin`|local administrative boundaries|
|`borough`| a local administrative boundary, currently only used for New York City|
|`neighbourhood`|social communities, neighbourhoods|
|`coarse`|alias for simultaneously using all administrative layers (everything except `venue` and `address`)|
> [/v1/autocomplete?api_key=search-TeXrSTX&__layers=coarse__&text=starbuck](https://search.mapzen.com/v1/autocomplete?api_key=search-TeXrSTX&layers=coarse&text=starbuck)

6
data-sources.md

@ -29,8 +29,9 @@ Layers:
- `region`
- `macrocounty`
- `county`
- `locality`
- `localadmin`
- `locality`
- `borough`
- `neighbourhood`
- `coarse` (alias for simultaneously using all the above)
@ -71,10 +72,11 @@ Layers:
- `venue`
- `country`
- `macroregion`
- `region`
- `county`
- `locality`
- `localadmin`
- `locality`
- `neighbourhood`
- `coarse` (alias for simultaneously using all the above)

5
reverse.md

@ -62,12 +62,15 @@ Without specifying further, reverse geocoding doesn't restrict results to a part
|`venue`|points of interest, businesses, things with walls|
|`address`|places with a street address|
|`country`|places that issue passports, nations, nation-states|
|`macroregion`|a related group of regions. Mostly in Europe|
|`region`|states and provinces|
|`macrocounty`|a related group of counties. Mostly in Europe.|
|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region|
|`locality`|towns, hamlets, cities|
|`localadmin`|local administrative boundaries|
|`borough`| a local administrative boundary, currently only used for New York City|
|`neighbourhood`|social communities, neighbourhoods|
|`coarse`|alias for simultaneously using `country`, `region`, `county`, `locality`, `localadmin`, and `neighbourhood`|
|`coarse`|alias for simultaneously using all administrative layers (everything except `venue` and `address`)|
>[/v1/reverse?api_key=search-TeXrSTX&point.lat=48.858268&point.lon=2.294471&___layers=locality___](https://search.mapzen.com/v1/reverse?api_key=search-TeXrSTX&point.lat=48.858268&point.lon=2.294471&layers=locality)

5
search.md

@ -336,12 +336,15 @@ In Mapzen Search, place types are referred to as `layers`, ranging from fine to
|`venue`|points of interest, businesses, things with walls|
|`address`|places with a street address|
|`country`|places that issue passports, nations, nation-states|
|`macroregion`|a related group of regions. Mostly in Europe|
|`region`|states and provinces|
|`macrocounty`|a related group of counties. Mostly in Europe.|
|`county`|official governmental area; usually bigger than a locality, almost always smaller than a region|
|`locality`|towns, hamlets, cities|
|`localadmin`|local administrative boundaries|
|`borough`| a local administrative boundary, currently only used for New York City|
|`neighbourhood`|social communities, neighbourhoods|
|`coarse`|alias for simultaneously using `country`, `region`, `county`, `locality`, `localadmin`, and `neighbourhood`|
|`coarse`|alias for simultaneously using all administrative layers (everything except `venue` and `address`)|
> [/v1/search?api_key=search-TeXrSTX&text=YMCA&___layers=venue,address___](https://search.mapzen.com/v1/search?api_key=search-TeXrSTX&text=YMCA&layers=venue,address)

Loading…
Cancel
Save