Mercurial > gemma

comparison docs/schnittstellen.txt @ 171:61f6c0add246

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
docs: Added raw API - documentation under /docs
author Thomas Junk <thomas.junk@intevation.de>
date Tue, 10 Jul 2018 14:30:06 +0200
parents
children 63dd5216eee4
comparison
equal deleted inserted replaced
170:9f1b84b712a8 171:61f6c0add246
1 | Route | Methode | Daten | *PUC | Antwort standardmäßig JSON | Anmerkung | |
2 |----------------------------------+---------+-------------------------------------------------------------------+--------------+-------------------------------------------------------------------+------------------------------------------------+---|
3 | /api/users | GET | Liste an Usern | | | | |
4 | /api/users | POST | login, password, role, emailaddress, country, default extent zoom | APUC3, APUC4 | 201, 500 Msg im Body | | |
5 | /api/users/{id} | GET | | APUC3, APUC4 | login, password, role, emailaddress, countrym default extent zoom | | |
6 | /api/users/{id} | DELETE | | APUC3 | 204 | | |
7 | /api/users/{id} | PATCH | je nachdem, was geändert worden ist | APUC3 | token, expires, user, roles | passwordprompt, defaultextent | |
8 | /api/users/{login}/passwordreset | POST | user: login | GPUC3 | 200, 500 | | |
9 | /api/login | GET * | user, password als Queryparameter (ist aktuell so) | APUC1 | 200 | | |
10 | /api/logout | GET * | ist aktuell so implementiert | APUC2 | 200 | | |
11 | /api/health/hardware | GET | | APUC8 | 200 | Optionale Queryparameter: limit, from, from+to | |
12 | /api/health/system | GET | | APUC8 | 200 | Optionale Queryparameter: limit, from, from+to | |
13 | /api/health/access | GET | | APUC8 | 200 | Optionale Queryparameter: limit, from, from+to | |
14 | /api/sendtestmail | POST | recipients: userids / an SAdmins, an WWAdmins | APUC9 | 200 | !Throttle! | |
15 | /api/management | GET | aktuelle Konfiguration | APUC10 | 200 | | |
16 | /api/management | PATCH | zu ändernde Parameter | APUC10 | 200 | | |
17 | /api/templates | GET | Liste an Templates | APUC6 | 200 | | |
18 | /api/templates | POST | Daten für ein neues Template | APUC6 | 201 | | |
19 | /api/templates/{id} | GET | Metadaten für das Template | APUC6 | 200 | | |
20 | /api/template/{id} | PATCH | zu ändernde Parameter | APUC6 | 200 | | |
21 | /api/template/{id} | DELETE | | APUC6 | | | |
22 | /api/maps/print | POST | Metadaten für den Druck(?) | GPUC7 | | | |
23 | /api/search (?) | POST | Das zu suchende | GPUC10 | | | |
24 | /api/bottlenecks | GET | | SPUC1 | | Limit? | |
25 | /api/fairwaydimension | GET | Flusskilometerangabe, Zeitpunkt(?) | SPUC3 | SVG | | |
26