Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
dokumentation_der_restful_api_version_1 [2018-11-06 21:39] admin Formatierung |
dokumentation_der_restful_api_version_1 [2018-11-07 18:04] (aktuell) admin Titel gefixt |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== Dokumentation der Restful API Version 1 ====== | + | ====== Dokumentation der RESTful API Version 1 ====== |
Eine allgemeine Beschreibung der RESTful API finden Sie unter [[apis]]. | Eine allgemeine Beschreibung der RESTful API finden Sie unter [[apis]]. | ||
- | ====== Authentifizierung und Sicherheit ====== | + | ===== Authentifizierung und Sicherheit ===== |
Die Authentifizierung erfolgt per Basic-HTTP-Auth mit Nutzername und | Die Authentifizierung erfolgt per Basic-HTTP-Auth mit Nutzername und | ||
Zeile 12: | Zeile 12: | ||
- | ====== Datentypen, Encoding ====== | + | ===== Datentypen, Encoding ===== |
Zeile 22: | Zeile 22: | ||
- | ====== Verhalten im Fehlerfall ====== | + | ===== Verhalten im Fehlerfall ===== |
- | ===== Genutzte HTTP-Statuscodes ===== | + | ==== Genutzte HTTP-Statuscodes ==== |
Zeile 39: | Zeile 39: | ||
- | ===== Aufbau einer Antwort ===== | + | ==== Aufbau einer Antwort ==== |
Zeile 57: | Zeile 57: | ||
- | ===== Beispiel ===== | + | ==== Beispiel ==== |
Zeile 74: | Zeile 74: | ||
</code> | </code> | ||
- | ====== URLs ====== | + | ===== URLs ===== |
- | ===== Allgemeines ===== | + | ==== Allgemeines ==== |
Zeile 88: | Zeile 88: | ||
- | ===== Übersicht ===== | + | ==== Übersicht ==== |
Zeile 113: | Zeile 113: | ||
- | ===== GET /colors ===== | + | ==== GET /colors ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 122: | Zeile 122: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 138: | Zeile 138: | ||
</code> | </code> | ||
- | ===== GET /features ===== | + | ==== GET /features ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 147: | Zeile 147: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 163: | Zeile 163: | ||
</code> | </code> | ||
- | ===== GET /brands ===== | + | ==== GET /brands ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 172: | Zeile 172: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 191: | Zeile 191: | ||
</code> | </code> | ||
- | ===== GET /brands/{brand_id}/models ===== | + | ==== GET /brands/{brand_id}/models ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 201: | Zeile 201: | ||
- | ==== Parameter ==== | + | === Parameter === |
Zeile 214: | Zeile 214: | ||
- | ==== Fehler ==== | + | === Fehler === |
Zeile 220: | Zeile 220: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 239: | Zeile 239: | ||
</code> | </code> | ||
- | ===== GET /models/{model_id}/submodels ===== | + | ==== GET /models/{model_id}/submodels ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 249: | Zeile 249: | ||
- | ==== Parameter ==== | + | === Parameter === |
Zeile 262: | Zeile 262: | ||
- | ==== Fehler ==== | + | === Fehler === |
Zeile 268: | Zeile 268: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 285: | Zeile 285: | ||
</code> | </code> | ||
- | ===== GET /submodels/{submodel_id}/bodies ===== | + | ==== GET /submodels/{submodel_id}/bodies ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 294: | Zeile 294: | ||
- | ==== Parameter ==== | + | === Parameter === |
Zeile 307: | Zeile 307: | ||
- | ==== Fehler ==== | + | === Fehler === |
Zeile 313: | Zeile 313: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 336: | Zeile 336: | ||
</code> | </code> | ||
- | ===== GET /submodels/{submodel_id}/bodies/{body_id}/engines ===== | + | ==== GET /submodels/{submodel_id}/bodies/{body_id}/engines ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 346: | Zeile 346: | ||
- | ==== Parameter ==== | + | === Parameter === |
Zeile 360: | Zeile 360: | ||
- | ==== Fehler ==== | + | === Fehler === |
Zeile 367: | Zeile 367: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 397: | Zeile 397: | ||
</code> | </code> | ||
- | ===== GET /submodels/{submodel_id}/bodies/{body_id}/engines/{engine_id}/editions ===== | + | ==== GET /submodels/{submodel_id}/bodies/{body_id}/engines/{engine_id}/editions ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 408: | Zeile 408: | ||
- | ==== Parameter ==== | + | === Parameter === |
Zeile 423: | Zeile 423: | ||
- | ==== Fehler ==== | + | === Fehler === |
Zeile 431: | Zeile 431: | ||
- | ==== Beispiel ==== | + | === Beispiel === |
Zeile 458: | Zeile 458: | ||
</code> | </code> | ||
- | ===== GET /calculate/{hsn}/{tsn} ===== | + | ==== GET /calculate/{hsn}/{tsn} ==== |
- | ==== Beschreibung ==== | + | === Beschreibung === |
Zeile 469: | Zeile 469: | ||
- | ==== Parameter ==== | + | === Parameter === |
Zeile 505: | Zeile 505: | ||
- | ==== Fehler ==== | + | === Fehler === |
Zeile 527: | Zeile 527: | ||
</code> | </code> | ||
- | ==== Beispiel ==== | + | === Beispiel === |