...
| HTTP-Verb | Beschreibung |
|---|---|
HEAD | Wird benutzt, um nur die HTTP-Header für eine Ressource abzufragen |
GET | Wird für das Abfragen von Ressourcen genutzt |
POST | Wird benutzt, um neue Ressourcen anzulegen |
PATCH | Wird verwendet, um Ressourcen mit partiellen JSON-Objekten zu aktualisieren |
PUT | Wird aktuell nicht von der REST-API verwendet |
DELETE | Wird benutzt, um Ressourcen zu löschen |
Fehler
Wenn eine Anfrage an die URN-Service API fehlschlägt, enthält die Antwort ein JSON-Objekt mit einer genaueren Fehlermeldung:
| Codeblock |
|---|
{
"code": "40001",
"developerMessage": "Invalid JSON",
"status": 400
} |
Aus technischen Gründen werden Fehler allerdings teilweise auch als HTML-Dokument ausgeliefert.
Hypermedia
Die URN-Service API verwendet URLs für Referenzen zwischen Ressourcen. Sie dienen dazu, explizite URLs anzbieten, die API-Clients verwenden können, sodass sie keine eigenen URLs konstruieren müssen.
...
Zum vereinfachten Blättern durch die Ergebnislisten, enthalten die Antworten der URN-Service API einen HTTP Link-Header, der Links zur ersten, vorhergehenden, folgenden und zur letzten Seite enthält. Links zur ersten Seite und zur Vorgängerseite sind erst ab der zweiten Seite enthalten. Der Link auf die erste, letzte, vorhergehende und folgende Ergebnisseite verweisen:letzte Seite ist optional und aus technischen Gründen nicht immer enthalten.
| Codeblock |
|---|
Link: <http://api.nbn-resolving.org/v2/urns?offset=0&count=20>; rel="first", <http://api.nbn-resolving.org/v2/urns?offset=0&count=20>; rel="previous", <http://api.nbn-resolving.org/v2/urns?offset=40&count=20>; rel="next",<http://api.nbn-resolving.org/v2/urns?offset=0&count=20>; rel="last" |
Referenz
Eine detaillierte Übersicht über alle Befehle der REST-API wird als Teil der REST-API unter docs/index.html angeboten.
...