Browse Source

Add places endpoint to API docs

pull/204/head
Julian Simioni 10 years ago committed by Julian Simioni
parent
commit
a976b7b258
  1. 9
      DOCS.md

9
DOCS.md

@ -89,14 +89,15 @@ The reverse geocoding endpoint; matches a point on the planet to the name of tha
* `details` (default: `true`) * `details` (default: `true`)
## /doc ## /place
The endpoint for retrieving one or more elasticsearch documents with specific ids. The endpoint for retrieving one or more places with specific ids. These correspond
directly with Elasticsearch documents.
#### Required Parameters #### Required Parameters
* one of `id` or `ids` * one of `id` or `ids`
* `id`: * `id`:
* unique id of the document to be retrieved * unique id of the places to be retrieved
* should be in the form of type:id, for example: `geoname:4163334` * should be in the form of type:id, for example: `geoname:4163334`
* `ids`: * `ids`:
* if multiple docs are to be fetched in bulk, an array of ids * if multiple places are to be fetched in bulk, an array of ids

Loading…
Cancel
Save