Parameterübersicht

Für die Suchen sind unterschiedliche Parameter erforderlich (einige Parameter sind optional).

Bei den Parametern wird zwischen Groß- und Kleinschreibung unterschieden.

Sicherheitsparameter

Name Beschreibung Datentyp Standardwert
SystemPartner Partnername (wird direkt von YellowMap bereitgestellt) string  
SecurityID Zugangsschlüssel (wird direkt von YellowMap bereitgestellt) string  
Channel Normalerweise leer; kann für die kundeneigene Protokollierung verwendet werden. string

Inhaltsparameter

Name Beschreibung Datentyp Standardwert
Branches

Branchencodes (die Liste aller Branchen kann bei YellowMap angefordert werden). Sollten Branchencodes, welche nicht in der Liste enthalten sind, nachgewiesen werden, wird nach Rücksprache die API auch für diese freigeschaltet.

„OR“- und „AND“-Verknüpfungen sind möglich über „|“ und „&“ (| bindet stärker als &),
zum Beispiel wird „4680&1210|1923“ interpretiert als „4680&(1210|1923)“.

Beachten Sie, dass die Logik von der boolschen Logik abweicht, bei der „AND“ stärker bindet als „OR“.

 string  
Catchwords Die Übergabe mehrerer Stichworte ist möglich. Stichworte werden durch ein Leerzeichen getrennt.
Beipiel: „itservices computer support“.		 string  

Standort-Parameter

Name Beschreibung Datentyp Standardwert
IsoCountryCode Zwei Zeichen langer ISO-Code des Landes, zum Beispiel „DE“ für Deutschland. string DE
IsoLocale Locale des Aufrufs und der Rückgabe – wird für mehrsprachige Inhalte benötigt. Benutzen Sie „de-DE“ für Deutschland (Standard). string de-DE
Location Einschlitzsuche: Straße, PLZ und Stadt können für die Suche verwendet werden. string  
LocX Koordinaten des Längengrads mit Dezimalpunkt, zum Beispiel „8.41876“ für Karlsruhe/Deutschland. uint  
LocY Koordinate des Breitengrads mit Dezimalpunkt, zum Beispiel „49.00923“ für Karlsruhe/Deutschland. uint  
Lux, Luy
Rlx, Rly		 Rechteckkoordinaten für die Suche in einem Rechteck (linke obere und rechte untere Ecke). uint  
CoordFormatIn GEODECIMAL_POINT ("Google-Format", WGS84/GPS-Koordinaten); alternativ MERCATOR und viele weitere. string GEODECIMAL_POINT
Zip

Eine Postleitzahl innerhalb einer Branchen- oder Stichwortsuche, zum Beispiel „76133“ in Deutschland.

Eine oder mehrere Postleitzahlen in einer PLZ-basierten Suche (getrennt durch |).
Falls eine Postleitzahl angegeben wurde, kann sie auch unvollständig sein, zum Beispiel „761“. Falls mehrere Postleitzahlen angegeben werden, müssen sie komplett sein, zum Beispiel „76133|08269“.

 string  
Street Straßenname einschließlich Hausnummer string  
City Stadt string  

Steuer-Parameter

Name Beschreibung Datentyp Standardwert
MaxRadius Radius in Meter; -1 bedeutet unbegrenzt (standardmäßig im Umkreis bis 300 km). int -1
Top Anzahl der gewünschten Ergebnisse uint 20
Page Die gewünschte Seite (falls geblättert werden können soll). uint 1
OrderBy Mögliche Angaben:
COMPANY_NAME,
DISTANCE,
EVENT_START_DATE,
EVENT_START_DATE_DISTANCE,
EVENT_DISTANCE,
NONE,
MATRIX_COMPANY_NAME,
MATRIX_DISTANCE,
PHONE_BOOK_SEARCH_DISTANCE_NAME,
PHONE_BOOK_SEARCH_NAME		 string MATRIX_COMPANY_NAME

Besondere Parameter

Name Beschreibung Datentyp Standardwert
Freefilter Normalerweise leer; wird für spezielle Filter verwendet. (Für zusätzliche eigene Lösungen) string  
Addition Normalerweise leer; hierüber können zusätzliche Parameter übergeben werden. (Für zusätzliche eigene Lösungen) string  

Identifiers

Name Beschreibung Datentyp Standardwert
CustomerID Vom Lieferanten vorgegebener Fremdschlüssel des Datensatzes. string
Identifier YellowMap-eigener Primärschlüssel des Datensatzes (verschlüsselt). string