listings/byphone (GET)

Ressourcen-Pfad

/api_rst/v2/listings/byphone

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

Beschreibung

In dieser Suche können Listings über ihre Telefonnummer gefunden werden.

Parameter

Name Beschreibung Datentyp
phoneNumber Die Telefonnummer, nach der gesucht werden soll; ohne Landesvorwahl, wie zum Beispiel: +49. Bitte die Nummer unformatiert angeben, wie zum Beispiel: 07219638600.
Nur diejenigen Einträge werden zurückgegeben, die genau der Nummer entsprechen, nach der gesucht wurde. Falls Sie ungenau suchen möchten, kontaktieren Sie bitte den Support .
[erforderlich]		 string
isoCountryCode ISO-Angabe des Landes.
[erforderlich]		 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/byphone (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/byphone",
         data: {
            phonenumber: "07219638600",
            isoCountryCode: "de"
         },
         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