Web Services:

• /api/search
• /api/tag
• /api/terms
• /api/suggest

/api/search

Pfad:	/api/search
Beschreibung:	Sucheanfrage an TagFinder für OpenStreetMap Tags.
Parameter:	query- Der Suchbegriff vom Typ STRING. (erforderlich) lang- Gibt die Sprache des Suchbegriffs an. Wechselt nur die Reihenfolge, in der zuerst nachgeschlagen wird. Unterstützt: 'de' und 'en'. (optional, default: 'en') format- Bei Wert json_pretty wird die JSON Rückgabe eingerückt. (optional) callback- JSONP Callback Parameter. (optional)
Bemerkung:	Wenn für den Suchbegriff keine Tags gefunden wurden, wird ein leeres ARRAY zurückgegeben. Mit Anführungszeichen um ein Wort kann die Rechtschreibkorrektur und der Übersetzer deaktiviert werden.
Resultat:	: ARRAY OF HASHES Sortierte Liste mit den Resultaten der Suchanfrage.   subject: STRING Weblink zur OpenStreetMap Wiki-Seite des Tags.   isKey: BOOL true falls es sich um einen Schlüssel handelt, false wenn es ein Schlüssel=Wert Paar ist.   isTag: BOOL true falls es ein Schlüssel=Wert Paar ist, false wenn es sich um einen Schlüssel handelt.   prefLabel: STRING Bezeichnung des Tags, im Format: Schlüssel oder Schlüssel=Wert   depiction: STRING Weblink zu einem Bild, dass den Tag auszeichnet.   termRelated: ARRAY OF HASHES     en: ARRAY OF STRING Liste mit englischen, verwandten Begriffen.     de: ARRAY OF STRING Liste mit deutschen, verwandten Begriffen.   scopeNote: ARRAY OF HASHES     en: STRING Englische Kurzbeschreibung.     de: STRING Deutsche Kurzbeschreibung.   countAll: INT Anzahl Total.   node: ARRAY OF HASHES     count: INT Anzahl Punkte.     use: BOOL Soll der Tag Punkten zugeordnet werden?   way: ARRAY OF HASHES     count: INT Anzahl Linien.     use: BOOL Soll der Tag Linien zugeordnet werden?   area: ARRAY OF HASHES     count: INT Anzahl Flächen.     use: BOOL Soll der Tag Flächen zugeordnet werden?   relation: ARRAY OF HASHES     count: INT Anzahl Relationen.     use: BOOL Soll der Tag Relationen zugeordnet werden?   implies: ARRAY OF HASHES     label: STRING Bezeichnung des implizierten Tags, im Format: Schlüssel=* oder Schlüssel=Wert.     link: STRING Weblink zur OpenStreetMap Wiki-Seite des implizierten Tags. Kann null sein.   combines: ARRAY OF HASHES     label: STRING Bezeichnung des häufig kombinierten Tags, im Format: Schlüssel=* oder Schlüssel=Wert.     link: STRING Weblink zur OpenStreetMap Wiki-Seite des häufig kombinierten Tags. Kann null sein.   links: ARRAY OF HASHES     label: STRING Bezeichnung des verlinkten Tags, im Format: Schlüssel=* oder Schlüssel=Wert.     link: STRING Weblink zur OpenStreetMap Wiki-Seite des verlinkten Tags. Kann null sein.   searchMeta: ARRAY OF HASHES     score: INT Sortierbarer Trefferscore, berechnet nach einer Okapi BM25f Variante.     <field>: ARRAY OF STRINGS Liste mit gefundenen Begriffen.<field> ist 'tagPrefLabel', 'termPrefLabel', 'termAltLabel', 'termBroader', 'termNarrower' oder 'tagScopeNote'.
Beispiel:	/api/search?query=Zoo&format=json_pretty&lang=de
UI Beispiel:	/search?query=zoo

Path:	/api/search
Description:	Query TagFinder for OpenStreetMap tags.
Parameters:	query- Search query of type STRING. (required) lang- Defines language of the search term. Only changes lookup order. Currently supported: 'en' and 'de'. (optional, default: 'en') format- With value json_pretty the JSON output gets pretty-printed. (optional) callback- JSONP callback parameter. (optional)
Notes:	If no Tags were found for the search query, an empty ARRAY is returned. Using quotation marks around terms turns off the spell correction and the translator.
Result:	: ARRAY OF HASHES Sorted list containing the results of this query.   subject: STRING Weblink to the OpenStreetMap Wiki of this tag.   isKey: BOOL true if its a key, false if its a key=value pair.   isTag: BOOL true if its a key=value pair, false if its a key.   prefLabel: STRING Label of the tag: key or key=value   depiction: STRING Weblink to the image denoting this tag.   termRelated: ARRAY OF HASHES     en: ARRAY OF STRING List of English related terms.     de: ARRAY OF STRING List of German related terms.   scopeNote: ARRAY OF HASHES     en: STRING Short description in English.     de: STRING Short description in German.   countAll: INT Total count.   node: ARRAY OF HASHES     count: INT Count of nodes.     use: BOOL Is node-use encouraged?   way: ARRAY OF HASHES     count: INT Count of ways.     use: BOOL Is way-use encouraged?   area: ARRAY OF HASHES     count: INT Count of areas.     use: BOOL Is area-use encouraged?   relation: ARRAY OF HASHES     count: INT Count of relations.     use: BOOL Is relation-use encouraged?   implies: ARRAY OF HASHES     label: STRING Label of the implied tag, key=* or key=value.     link: STRING Weblink to the OpenStreetMap Wiki of this implied tag. Can be null.   combines: ARRAY OF HASHES     label: STRING Label of the combined tag, key=* or key=value.     link: STRING Weblink to the OpenStreetMap Wiki of this combined tag. Can be null.   links: ARRAY OF HASHES     label: STRING Label of the linked tag, key=* or key=value.     link: STRING Weblink to the OpenStreetMap Wiki of this linked tag. Can be null.   searchMeta: ARRAY OF HASHES     score: INT Sortable hit score, Okapi BM25f variant.     <field>: ARRAY OF STRINGS List of hit terms.<field> can be 'tagPrefLabel', 'termPrefLabel', 'termAltLabel', 'termBroader', 'termNarrower' or 'tagScopeNote'.
Example:	/api/search?query=Zoo&format=json_pretty&lang=de
UI Example:	/search?query=zoo

/api/tag

Pfad:	/api/tag
Beschreibung:	Erhalte Taginformationen für einen spezifischen Schlüssel oder Schlüssel=Wert Paare.
Parameter:	key- Der Schlüssel des Tags vom Typ STRING. (erforderlich) value- Der Wert des Tags vom Typ STRING. (optional) format- Bei Wert json_pretty wird die JSON Rückgabe eingerückt. (optional) callback- JSONP Callback Parameter. (optional)
Bemerkung:	Es handelt sich hier um einen direkten Zugriff und keine Suchanfrage, d.h. die Gross- und Kleinschreibung muss beachtet werden. Falls der Tag nicht gefunden wurde, wird ein leerer HASH zurückgegeben. Die Rückgabe entspricht sonst der von /api/search ohne 'searchMeta'.
Resultat:	: HASH   subject: STRING Weblink zur OpenStreetMap Wiki-Seite des Tags.   isKey: BOOL true falls es sich um einen Schlüssel handelt, false wenn es ein Schlüssel=Wert Paar ist.   isTag: BOOL true falls es ein Schlüssel=Wert Paar ist, false wenn es sich um einen Schlüssel handelt.   prefLabel: STRING Bezeichnung des Tags, im Format: Schlüssel oder Schlüssel=Wert   depiction: STRING Weblink zu einem Bild, dass den Tag auszeichnet.   termRelated: ARRAY OF HASHES     en: ARRAY OF STRING Liste mit englischen, verwandten Begriffen.     de: ARRAY OF STRING Liste mit deutschen, verwandten Begriffen.   scopeNote: ARRAY OF HASHES     en: STRING Englische Kurzbeschreibung.     de: STRING Deutsche Kurzbeschreibung.   countAll: INT Anzahl Total.   node: ARRAY OF HASHES     count: INT Anzahl Punkte.     use: BOOL Soll der Tag Punkten zugeordnet werden?   way: ARRAY OF HASHES     count: INT Anzahl Linien.     use: BOOL Soll der Tag Linien zugeordnet werden?   area: ARRAY OF HASHES     count: INT Anzahl Flächen.     use: BOOL Soll der Tag Flächen zugeordnet werden?   relation: ARRAY OF HASHES     count: INT Anzahl Relationen.     use: BOOL Soll der Tag Relationen zugeordnet werden?   implies: ARRAY OF HASHES     label: STRING Bezeichnung des implizierten Tags, im Format: Schlüssel=* oder Schlüssel=Wert.     link: STRING Weblink zur OpenStreetMap Wiki-Seite des implizierten Tags. Kann null sein.   combines: ARRAY OF HASHES     label: STRING Bezeichnung des häufig kombinierten Tags, im Format: Schlüssel=* oder Schlüssel=Wert.     link: STRING Weblink zur OpenStreetMap Wiki-Seite des häufig kombinierten Tags. Kann null sein.   links: ARRAY OF HASHES     label: STRING Bezeichnung des verlinkten Tags, im Format: Schlüssel=* oder Schlüssel=Wert.     link: STRING Weblink zur OpenStreetMap Wiki-Seite des verlinkten Tags. Kann null sein.
Beispiel:	/api/tag?key=shop&value=pet
UI (kein Beispiel):	/search?query=shop%3Dpet

Path:	/api/tag
Description:	Get tag information for one specific key or key=value pair.
Parameters:	key- The key of the tag of type STRING. (required) lang- The value of the tag of type STRING. (optional) format- With value json_pretty the JSON output gets pretty-printed. (optional) callback- JSONP callback parameter. (optional)
Notes:	The webservice is case-sensitive: Its using direct access instead of querying it. If no tag is found an empty HASH is returned, otherwise the returned JSON is the same as /api/search without 'searchMeta'.
Result:	: HASH   subject: STRING Weblink to the OpenStreetMap Wiki of this tag.   isKey: BOOL true if its a key, false if its a key-value pair.   isTag: BOOL true if its a key-value pair, false if its a key.   prefLabel: STRING Label of the tag: key or key=value   depiction: STRING Weblink to the image denoting this tag.   termRelated: ARRAY OF HASHES     en: ARRAY OF STRING List of English related terms.     de: ARRAY OF STRING List of German related terms.   scopeNote: ARRAY OF HASHES     en: STRING Short description in English.     de: STRING Short description in German.   countAll: INT Total count.   node: ARRAY OF HASHES     count: INT Count of nodes.     use: BOOL Is node-use encouraged?   way: ARRAY OF HASHES     count: INT Count of ways.     use: BOOL Is way-use encouraged?   area: ARRAY OF HASHES     count: INT Count of areas.     use: BOOL Is area-use encouraged?   relation: ARRAY OF HASHES     count: INT Count of relations.     use: BOOL Is relation-use encouraged?   implies: ARRAY OF HASHES     label: STRING Label of the implied tag, key=* or key=value.     link: STRING Weblink to the OpenStreetMap Wiki of this implied tag. Can be null.   combines: ARRAY OF HASHES     label: STRING Label of the combined tag, key=* or key=value.     link: STRING Weblink to the OpenStreetMap Wiki of this combined tag. Can be null.   links: ARRAY OF HASHES     label: STRING Label of the linked tag, key=* or key=value.     link: STRING Weblink to the OpenStreetMap Wiki of this linked tag. Can be null.
Example:	/api/tag?key=shop&value=pet
UI (no example):	/search?query=shop%3Dpet

/api/terms

Pfad:	/api/terms
Beschreibung:	Erhalte Informationen zu verwandten Begriffen, Ober- und Unterbegriffen.
Parameter:	term- Der Begriff für den Informationen angefordert werden, vom Typ STRING. (erforderlich) format- Bei Wert json_pretty wird die JSON Rückgabe eingerückt. (optional) callback- JSONP Callback Parameter. (optional)
Bemerkung:	Die Gross- und Kleinschreibung des erforderlichen Parameters muss beachtet werden. Falls dazu keine passenden Begriffe gefunden wurden, sind die jeweiligen Listen leer.
Resultat:	: HASH   termRelated: ARRAY OF HASHES     en: ARRAY OF STRING Liste mit englischen, verwandten Begriffen.     de: ARRAY OF STRING Liste mit deutschen, verwandten Begriffen.   termBroader: ARRAY OF HASHES     en: ARRAY OF STRING Liste mit englischen Oberbegriffen.     de: ARRAY OF STRING Liste mit deutschen Oberbegriffen.   termNarrower: ARRAY OF HASHES     en: ARRAY OF STRING Liste mit englischen Unterbegriffen.     de: ARRAY OF STRING Liste mit deutschen Unterbegriffen.
Beispiel:	/api/terms?term=cat&format=json_pretty
UI (kein Beispiel):	/search?query=cat

Path:	/api/terms
Description:	Get information about related, narrower and broader terms.
Parameters:	term- The term to get information for, of type STRING. (required) format- With value json_pretty the JSON output gets pretty-printed. (optional) callback- JSONP callback parameter. (optional)
Notes:	The case of the required parameter needs to be correct. If no appropriate terms are found, the according lists will be empty.
Result:	: HASH   termRelated: ARRAY OF HASHES     en: ARRAY OF STRING List of English related terms.     de: ARRAY OF STRING List of German related terms.   termBroader: ARRAY OF HASHES     en: ARRAY OF STRING List of English broader terms.     de: ARRAY OF STRING List of German broader terms.   termNarrower: ARRAY OF HASHES     en: ARRAY OF STRING List of English narrower terms.     de: ARRAY OF STRING List of German narrower terms.
Example:	/api/terms?term=cat&format=json_pretty
UI (no example):	/search?query=cat

/api/suggest

Pfad:	/api/suggest
Beschreibung:	Gibt Vorschläge für einen Suchbegriff. Es wird eine Fehlerkorrektur verwendet.
Parameter:	query- Der Begriff für den Vorschläge gesucht werden soll, vom Typ STRING. (erforderlich) lang- Gibt die Sprache an, für welche Vorschläge gesucht werden sollen. Unterstützt: 'de' und 'en'. (optional, default: alle) format- Bei Wert json_pretty wird die JSON Rückgabe eingerückt. (optional) callback- JSONP callback parameter. (optional)
Bemerkung:	Falls keine passenden Vorschläge gefunden wurde, wird ein leeres ARRAY zurückgegeben. (Siehe auch: opensearch.xml)
Resultat:	: ARRAY OF STRING Liste mit Vorschlägen zum Suchbegriff.
Beispiel:	/api/suggest?query=tabaco&lang=en

Path:	/api/suggest
Description:	Get suggestions for a term. Uses a spelling correction.
Parameters:	query- The term to get suggestions for, of type STRING. (required) lang- Defines the language of the suggestions to return. Currently supported: 'en' and 'de'. (optional, default: all) format- With value json_pretty the JSON output gets pretty-printed. (optional) callback- JSONP callback parameter. (optional)
Notes:	If no suggestions could be found an empty ARRAY is retuned. (See also: opensearch.xml)
Result:	: ARRAY OF STRING List of suggestions for the query term.
Example:	/api/suggest?query=tabaco&lang=en