Mercurial > gemma
changeset 171:61f6c0add246
docs: Added raw API - documentation under /docs
| author | Thomas Junk <thomas.junk@intevation.de> |
|---|---|
| date | Tue, 10 Jul 2018 14:30:06 +0200 |
| parents | 9f1b84b712a8 |
| children | a422471db08a |
| files | docs/schnittstellen.txt |
| diffstat | 1 files changed, 26 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/schnittstellen.txt Tue Jul 10 14:30:06 2018 +0200 @@ -0,0 +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 * | user, password als Queryparameter (ist aktuell so) | APUC1 | 200 | | | +| /api/logout | GET * | 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 | | | +