From: Sarah Hoffmann Date: Sun, 26 Aug 2018 14:40:52 +0000 (+0200) Subject: add docs for class parameter in /details X-Git-Tag: v3.2.0~2 X-Git-Url: https://git.openstreetmap.org./nominatim.git/commitdiff_plain/e09c42a78af66b6b8f004444dc2b8982b42e0161?hp=28d7e11e4fb377fc91e3271d424310f3ca7c7b85 add docs for class parameter in /details --- diff --git a/docs/api/Details.md b/docs/api/Details.md index 66b52409..027138a9 100644 --- a/docs/api/Details.md +++ b/docs/api/Details.md @@ -10,12 +10,18 @@ Lookup details about a single place by id. The default output is HTML for debugg The details API supports the following two request formats: ``` - https://nominatim.openstreetmap.org/details?osmtype=[N|W|R]&osmid= + https://nominatim.openstreetmap.org/details?osmtype=[N|W|R]&osmid=&class= ``` -Both parameters are required, the type is one of node(N), way(W) or relation(R). - -Or +`osmtype` and `osmid` are required parameter. The type is one of node (N), way (W) +or relation (R). The id must be a number. The `class` parameter is optional and +allows to distinguish between entries, when the corresponding OSM object has more +than one main tag. For example, when a place is tagged with `tourism=hotel` and +`amenity=restaurant`, there will be two place entries in Nominatim, one for a +restaurant, one for a hotel. You need to specify `class=tourism` or `class=amentity` +to get exactly the one you want. If there are multiple places in the database +but the `class` parameter is left out, then one of the places will be chosen +at random and displayed. ``` https://nominatim.openstreetmap.org/details?placeid=