Artikel 6 von 8

Was die API zurückgibt

JSON, immer die vollständige Ressource, und ein stabiler Fehlercode, wenn etwas blockiert.

Die Antworten

  • Das Anlegen einer Uhr gibt die Uhr mit ihrer watchId zurück. Diese watchId (nicht id) geben Sie danach an, um die Karte zu verknüpfen.
  • Das Prüfen einer Karte (can-link-card) gibt canLinkCard und einen passportCheck zurück: die gewählte Stufe, die fehlenden Felder, die bereits registrierten Seriennummern.
  • Das Verknüpfen der Karte gibt den erstellten Uhrenpass mit seiner Kartennummer (certificateCardId) zurück.
  • Das Lesen eines Uhrenpasses gibt alle seine Informationen zurück: die Uhr, ihre Fotos, ihre Authentifizierungsstufe, ihren Diebstahlstatus, ihre Garantie, ihren Eigentümer, so wie Sie ihn sehen dürfen.

Listen sind paginiert. Die Bezeichnungen folgen der im Header accept-language angeforderten Sprache (standardmäßig Englisch).

Einen Uhrenpass über Ihre Referenz finden

GET /certificates/by-external-ref/{ref} gibt den für Ihre Referenz erstellten Uhrenpass zurück, dieselbe Antwort wie GET /certificates/{certificateCardId}. Sie sehen nur, was Sie erstellt haben. Die Suche ignoriert Groß- und Kleinschreibung sowie Leerzeichen, und eine Referenz mit / wird als %2F kodiert.

Solange die Karte nicht verknüpft ist, lautet die Antwort 404: GET /watches/by-external-ref/{ref} findet die Uhr in jedem Schritt.

Die Fehler

Ein Fehler gibt einen HTTP-Code zurück und im Body einen stabilen Code (code), eine Meldung in der Sprache der Anfrage (message) und manchmal Details (params). Lesen Sie den Code, nicht die Meldung, die sich ändern kann. Zum Beispiel:

HTTP-CodecodeWas es bedeutet
422PASSPORT_INCOMPLETEEs fehlen Felder: params.missingFields listet sie auf
409PASSPORT_SERIAL_ALREADY_REGISTEREDEin anderer Uhrenpass des Herstellers hat diese Seriennummer
403PASSPORT_AUTHENTICATION_TYPE_NOT_ALLOWEDDiese Authentifizierungsstufe steht Ihrem Berufsfeld nicht offen
400OWNERSHIP_PROFESSIONAL_OWNER_REFUSEDDie als Eigentümer gemeldete Adresse gehört einem Profi
Nächster ArtikelDer Eigentümerwechsel und der Kundendienst