listings/at (GET)

Ressourcen-Pfad

/api_rst/v2/listings/at

http://www.yellowmap.de/api_rst/v2/listings/at

Beschreibung

Such mithilfe von Koordinaten. Die folgenden Sucharten werden unterstützt:

1. Such im Umkreis einer Koordinate
2. Suche in einem Rechteck

Entweder eine Koordinate mit Umkreis oder ein Rechteck werden benötigt. Beide Angaben können mit einer oder mehreren Branchen oder mit einem oder mehreren Stichworten kombiniert werden.

Parameter

Name Beschreibung Datentyp
point Angabe des Suchpunkts.
Beispiel-Koordinate: 49.08,8.35
[Erforderlich, falls eine Suche nach Koordinaten durchgeführt werden soll.]		 string
rectangle Angabe des Rechtecks.
Beispiel-Rechteck: 12.3,45.6,78.9,10.2
[Erforderlich, falls eine Suche in einem Rechteck durchgeführt werden soll.]		 string
coordFormat COORD_FORMAT
isoCountryCode ISO-Angabe des Landes.
[erforderlich]		 string
maxRadius Suchradius (Standard: 1000 Meter)
maxRadius = -1 bedeutet: keine Suchradius-Begrenzung; es findet eine automatische Suchoptimierung statt.		 uint
branches Branchencodes, nach denen man suchen kann.
Mehrere Branchen können über UND oder ODER logisch verknüpft werden. Klammern werden nicht unterstützt. Beachten Sie bitte, dass ODER stärker ist als UND.
Beispiel: A|B|C&B|C|D
Falls Stichworte und Branchen angegeben sind, wird eine reine Branchensuche durchgeführt.		 string
catchwords Stichworte, nach denen gesucht werden soll. Mehrere Stichworte werden durch Komma getrennt.
Falls Stichworte und Branchen angegeben sind, wird eine reine Branchensuche durchgeführt.		 string
freefilter Zusätzlicher Filter, der unter bestimmten Bedingungen eingesetzt werden kann. string
top Die Anzahl an Listings, die zurückkommen werden sollen (Standard: 10). uint
orderBy Gibt an, wie das Ergebnis sortiert werden soll (Standard: DISTANCE_COMPANY_NAME). SORT_CONDITIONS
page Seite, die zurückgegeben werden soll (Standard: 1). uint
perPage Gibt an, wie viele Listings pro Seite zurückgegeben werden sollen. uint
isoLocale ISO-Angabe der angeforderten Kultur (Locale). string
localIsoCountryCode ISO-Landcode der Webseite, auf der Inhalte angezeigt werden. string
channel Optionaler Parameter für die Protokollierung. string
coordFormatOut Koordinatenformat im Ausgabcontainer (Standard: GEODECIMAL_POINT). COORD_FORMAT
version Gibt an, dass ein Container mit der versionsabhängigen Struktur zurückgegeben werden soll (siehe Versionierung). string
addition Parameter, über den zusätzliche Angaben übergeben werden können (nur sinnvoll unter bestimmten Bedingungen).
Bei Bedarf teilen wir Ihnen die notwendigen Übergabeparameter mit: Kontakt 		string

Request Header

Name Beschreibung
Authorization Siehe Autorisierung

Rückgabe (application/json)

Der Rückgabecontainer ist vom Typ SearchListingResponse.

Beispiel

Codebeispiel: listings/at (GET)

<html>
   <script src="https://code.jquery.com/jquery-1.11.1.min.js"></script>
   <script>
      $.ajax({
         url: "http://www.yellowmap.de/api_rst/v2/listing/at",
         data: {
            point: 49.08,8.35,
            branches: "GAUT"
         },
         type: "GET",
         headers: {
            Authorization: "YM SYSTEM_PARTNER:SECURITY_ID"
         }
      }).done(function(data) {
         alert("Count of results: " + data.length);
         })
   </script>
</html>

Fehler

Fehler sind vom Typ ErrorResponse.

Fehlercode Beschreibung
400
BAD REQUEST, die Anfrage wurde falsch gestellt.
401
UNAUTHORIZED, ungültige Kombination aus systemPartner und securityId.
403
FORBIDDEN, systemPartner und securityId sind korrekt, aber der Zugriff auf die gewünschten Daten ist nicht
erlaubt.
404 NOT FOUND
500 SERVER ERROR, es ist etwas Unvorhergesehenes eingetreten.
Bitte setzen Sie sich mit uns in Verbindung: Support