Mercurial > gemma
changeset 229:94a1dd4ed50c
Reworked doc/schnittstellen.
| author | Sascha L. Teichmann <sascha.teichmann@intevation.de> |
|---|---|
| date | Thu, 26 Jul 2018 13:32:49 +0200 |
| parents | bd96611a7555 |
| children | 8a226dc1c6ff |
| files | docs/schnittstellen.txt |
| diffstat | 1 files changed, 26 insertions(+), 27 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/schnittstellen.txt Thu Jul 26 13:10:05 2018 +0200 +++ b/docs/schnittstellen.txt Thu Jul 26 13:32:49 2018 +0200 @@ -1,27 +1,26 @@ -| Route | Methode | Daten | *PUC | Antwort standardmäßig JSON | Anmerkung | | -|----------------------------------+---------+-------------------------------------------------------------------+--------------+-------------------------------------------------------------------+------------------------------------------------+---| -| /api/users | GET | Liste an Usern | | | | | -| /api/users | POST | login, password, role, emailaddress, country, default extent zoom | APUC3, APUC4 | 201, 500 Msg im Body | | | -| /api/users/{id} | GET | | APUC3, APUC4 | login, password, role, emailaddress, countrym default extent zoom | | | -| /api/users/{id} | DELETE | | APUC3 | 204 | | | -| /api/users/{id} | PATCH | je nachdem, was geändert worden ist | APUC3 | token, expires, user, roles | passwordprompt, defaultextent | | -| /api/users/{login}/passwordreset | POST | user: login | GPUC3 | 200, 500 | | | -| /api/login | GET/POST| user, password als Queryparameter (ist aktuell so) | APUC1 | 200 | | | -| /api/logout | GET/POST| ist aktuell so implementiert | APUC2 | 200 | | | -| /api/renew | GET/POST| ist aktuell so implementiert | APUC2 | 200 | | | -| /api/health/hardware | GET | | APUC8 | 200 | Optionale Queryparameter: limit, from, from+to | | -| /api/health/system | GET | | APUC8 | 200 | Optionale Queryparameter: limit, from, from+to | | -| /api/health/access | GET | | APUC8 | 200 | Optionale Queryparameter: limit, from, from+to | | -| /api/sendtestmail | POST | recipients: userids / an SAdmins, an WWAdmins | APUC9 | 200 | !Throttle! | | -| /api/management | GET | aktuelle Konfiguration | APUC10 | 200 | | | -| /api/management | PATCH | zu ändernde Parameter | APUC10 | 200 | | | -| /api/templates | GET | Liste an Templates | APUC6 | 200 | | | -| /api/templates | POST | Daten für ein neues Template | APUC6 | 201 | | | -| /api/templates/{id} | GET | Metadaten für das Template | APUC6 | 200 | | | -| /api/template/{id} | PATCH | zu ändernde Parameter | APUC6 | 200 | | | -| /api/template/{id} | DELETE | | APUC6 | | | | -| /api/maps/print | POST | Metadaten für den Druck(?) | GPUC7 | | | | -| /api/search (?) | POST | Das zu suchende | GPUC10 | | | | -| /api/bottlenecks | GET | | SPUC1 | | Limit? | | -| /api/fairwaydimension | GET | Flusskilometerangabe, Zeitpunkt(?) | SPUC3 | SVG | | | - +| Route | Methode | Daten | *PUC | JSON | HTTP-Code | Anmerkung | +|--------------------------+----------+-------------------------------------------------------+--------------+----------------------------------------------------+---------------+------------------------------------------------+ +| /api/users | GET | Liste an Usern | | | 200, 500 | | +| /api/users | POST | user, password, role, email, country, *extent | APUC3, APUC4 | | 201, 400, 500 | | +| /api/users/{user} | GET | | APUC3, APUC4 | login, password, role, email, country, extent zoom | 201, 500 | | +| /api/users/{user} | DELETE | | APUC3 | | 204, 500 | | +| /api/users/{user} | PUT | user, password, role, email, country, *extent | APUC3 | login, password, role, email, country, extent zoom | 200, 500 | | +| /api/users/passwordreset | POST | user | GPUC3 | user | 200, 500 | | +| /api/login | GET/POST | user, password -> token im Result-JSON | APUC1 | | 200, 500 | | +| /api/logout | GET/POST | | APUC2 | | 200, 500 | | +| /api/renew | GET/POST | | APUC2 | | 200, 500 | | +| /api/health/hardware | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to | +| /api/health/system | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to | +| /api/health/access | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to | +| /api/sendtestmail | POST | recipients: userids / an SAdmins, an WWAdmins | APUC9 | | 200, 500 | !Throttle! | +| /api/management | GET | aktuelle Konfiguration | APUC10 | | 200, 500 | | +| /api/management | PATCH | zu ändernde Parameter | APUC10 | | 200, 500 | | +| /api/templates | GET | Liste an Templates | APUC6 | | 200, 500 | | +| /api/templates | POST | Daten für ein neues Template | APUC6 | | 201, 500 | | +| /api/templates/{id} | GET | Metadaten für das Template | APUC6 | | 200, 500 | | +| /api/template/{id} | PATCH | zu ändernde Parameter | APUC6 | | 200, 500 | | +| /api/template/{id} | DELETE | | APUC6 | | 200, 500 | | +| /api/maps/print | POST | Metadaten für den Druck(?) | GPUC7 | | 200, 500 | | +| /api/search (?) | POST | Das zu suchende | GPUC10 | | 200, 500 | | +| /api/bottlenecks | GET | | SPUC1 | | 200, 500 | Limit? | +| /api/fairwaydimension | GET | Flusskilometerangabe, Zeitpunkt(?) | SPUC3 | | 200, 500 | SVG? |