mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-03-09 11:34:07 +00:00
Some docs for the entrances output
This commit is contained in:
@@ -105,6 +105,13 @@ grouped by type.
|
|||||||
|
|
||||||
Include geometry of result.
|
Include geometry of result.
|
||||||
|
|
||||||
|
| Parameter | Value | Default |
|
||||||
|
|-----------| ----- | ------- |
|
||||||
|
| entrances | 0 or 1 | 0 |
|
||||||
|
|
||||||
|
When set to 1, include the tagged entrances in the result.
|
||||||
|
|
||||||
|
|
||||||
### Language of results
|
### Language of results
|
||||||
|
|
||||||
| Parameter | Value | Default |
|
| Parameter | Value | Default |
|
||||||
|
|||||||
@@ -77,6 +77,12 @@ that is available in the database, e.g. wikipedia link, opening hours.
|
|||||||
When set to 1, include a full list of names for the result. These may include
|
When set to 1, include a full list of names for the result. These may include
|
||||||
language variants, older names, references and brand.
|
language variants, older names, references and brand.
|
||||||
|
|
||||||
|
| Parameter | Value | Default |
|
||||||
|
|-----------| ----- | ------- |
|
||||||
|
| entrances | 0 or 1 | 0 |
|
||||||
|
|
||||||
|
When set to 1, include the tagged entrances in the result.
|
||||||
|
|
||||||
|
|
||||||
### Language of results
|
### Language of results
|
||||||
|
|
||||||
|
|||||||
@@ -60,6 +60,8 @@ The possible fields are:
|
|||||||
* `namedetails` - dictionary with full list of available names including ref etc.
|
* `namedetails` - dictionary with full list of available names including ref etc.
|
||||||
* `geojson`, `svg`, `geotext`, `geokml` - full geometry
|
* `geojson`, `svg`, `geotext`, `geokml` - full geometry
|
||||||
(only with the appropriate `polygon_*` parameter)
|
(only with the appropriate `polygon_*` parameter)
|
||||||
|
* `entrances` - array of objects representing tagged entrances for the object, or
|
||||||
|
null if none are found (only with `entrances=1`)
|
||||||
|
|
||||||
## JSONv2
|
## JSONv2
|
||||||
|
|
||||||
@@ -87,6 +89,8 @@ The properties object has the following fields:
|
|||||||
* `extratags` - dictionary with additional useful tags like `website` or `maxspeed`
|
* `extratags` - dictionary with additional useful tags like `website` or `maxspeed`
|
||||||
(only with `extratags=1`)
|
(only with `extratags=1`)
|
||||||
* `namedetails` - dictionary with full list of available names including ref etc.
|
* `namedetails` - dictionary with full list of available names including ref etc.
|
||||||
|
* `entrances` - array of objects representing tagged entrances for the object, or
|
||||||
|
null if none are found (only with `entrances=1`)
|
||||||
|
|
||||||
Use `polygon_geojson` to output the full geometry of the object instead
|
Use `polygon_geojson` to output the full geometry of the object instead
|
||||||
of the centroid.
|
of the centroid.
|
||||||
@@ -110,6 +114,8 @@ The following feature attributes are implemented:
|
|||||||
* `admin` - list of localised names of administrative boundaries (only with `addressdetails=1`)
|
* `admin` - list of localised names of administrative boundaries (only with `addressdetails=1`)
|
||||||
* `extra` - dictionary with additional useful tags like `website` or `maxspeed`
|
* `extra` - dictionary with additional useful tags like `website` or `maxspeed`
|
||||||
(only with `extratags=1`)
|
(only with `extratags=1`)
|
||||||
|
* `entrances` - array of objects representing tagged entrances for the object, or
|
||||||
|
null if none are found (only with `entrances=1`)
|
||||||
|
|
||||||
|
|
||||||
Use `polygon_geojson` to output the full geometry of the object instead
|
Use `polygon_geojson` to output the full geometry of the object instead
|
||||||
@@ -162,8 +168,8 @@ The place information can be found in the `result` element. The attributes of th
|
|||||||
The full address of the result can be found in the content of the
|
The full address of the result can be found in the content of the
|
||||||
`result` element as a comma-separated list.
|
`result` element as a comma-separated list.
|
||||||
|
|
||||||
Additional information requested with `addressdetails=1`, `extratags=1` and
|
Additional information requested with `addressdetails=1`, `extratags=1`,
|
||||||
`namedetails=1` can be found in extra elements.
|
`namedetails=1`, and `entrances=1` can be found in extra elements.
|
||||||
|
|
||||||
### Search and Lookup
|
### Search and Lookup
|
||||||
|
|
||||||
@@ -224,9 +230,9 @@ be more than one. The attributes of that element contain:
|
|||||||
When `addressdetails=1` is requested, the localised address parts appear
|
When `addressdetails=1` is requested, the localised address parts appear
|
||||||
as subelements with the type of the address part.
|
as subelements with the type of the address part.
|
||||||
|
|
||||||
Additional information requested with `extratags=1` and `namedetails=1` can
|
Additional information requested with `extratags=1`, `namedetails=1`, and
|
||||||
be found in extra elements as sub-element of `extratags` and `namedetails`
|
`entrances=1` can be found in extra elements as sub-element of `extratags`,
|
||||||
respectively.
|
`namedetails`, and `entrances` respectively.
|
||||||
|
|
||||||
|
|
||||||
## Notes on field values
|
## Notes on field values
|
||||||
@@ -303,3 +309,19 @@ with a designation label. Per default the following labels may appear:
|
|||||||
|
|
||||||
They roughly correspond to the classification of the OpenStreetMap data
|
They roughly correspond to the classification of the OpenStreetMap data
|
||||||
according to either the `place` tag or the main key of the object.
|
according to either the `place` tag or the main key of the object.
|
||||||
|
|
||||||
|
### entrances
|
||||||
|
|
||||||
|
Entrance details in the xml and json formats return the latitude and longitude
|
||||||
|
of the entrance, the osm node ID, the [type of
|
||||||
|
entrance](https://wiki.openstreetmap.org/wiki/Key:entrance), and any extra tags
|
||||||
|
associated with the entrance node.
|
||||||
|
|
||||||
|
* osm_id
|
||||||
|
* type
|
||||||
|
* lat
|
||||||
|
* lon
|
||||||
|
* extratags
|
||||||
|
|
||||||
|
They roughly correspond to the classification of the OpenStreetMap data
|
||||||
|
according to either the `place` tag or the main key of the object.
|
||||||
|
|||||||
@@ -98,6 +98,12 @@ that is available in the database, e.g. wikipedia link, opening hours.
|
|||||||
When set to 1, include a full list of names for the result. These may include
|
When set to 1, include a full list of names for the result. These may include
|
||||||
language variants, older names, references and brand.
|
language variants, older names, references and brand.
|
||||||
|
|
||||||
|
| Parameter | Value | Default |
|
||||||
|
|-----------| ----- | ------- |
|
||||||
|
| entrances | 0 or 1 | 0 |
|
||||||
|
|
||||||
|
When set to 1, include the tagged entrances in the result.
|
||||||
|
|
||||||
|
|
||||||
### Language of results
|
### Language of results
|
||||||
|
|
||||||
|
|||||||
@@ -136,6 +136,12 @@ that is available in the database, e.g. wikipedia link, opening hours.
|
|||||||
When set to 1, include a full list of names for the result. These may include
|
When set to 1, include a full list of names for the result. These may include
|
||||||
language variants, older names, references and brand.
|
language variants, older names, references and brand.
|
||||||
|
|
||||||
|
| Parameter | Value | Default |
|
||||||
|
|-----------| ----- | ------- |
|
||||||
|
| entrances | 0 or 1 | 0 |
|
||||||
|
|
||||||
|
When set to 1, include the tagged entrances in the result.
|
||||||
|
|
||||||
|
|
||||||
### Language of results
|
### Language of results
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user