listing/{id} (GET)
Ressourcen-Pfad
/api_rst/v2/listing/{id}
http://www.yellowmap.de/api_rst/v2/listing/{id}
Beschreibung
Gibt den Eintrag zur ID zurück.
Parameter
Name | Beschreibung | Datentyp |
---|---|---|
id |
ID des Eintrags. [erforderlich] |
string |
isoCountryCode |
ISO-Angabe des Landes. [erforderlich] |
string |
isoLocale |
ISO-Angabe der angeforderten Kultur (Locale). | string |
localIsoCountryCode |
ISO-Landcode der Webseite, auf der Inhalte angezeigt werden. | string |
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: listing/{id} (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/C-wWpEMvbzjkpkavNGqHrw3D3D",
data: {
isoCountryCode: "de",
},
type: "GET",
headers: {
Authorization: "YM SYSTEM_PARTNER:SECURITY_ID",
Accept:"application/json"
}
}).done(function(data) {
alert(data);
})
</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 nichterlaubt. |
404 | NOT FOUND |
500 | SERVER ERROR, es ist etwas Unvorhergesehenes eingetreten. Bitte setzen Sie sich mit uns in Verbindung: Support |