Mercurial > gemma

comparison docs/server-interface.txt @ 388:56897dd9a2b2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: Rename schnittstellen.txt to server-interface.txt * Rename filename to be English.
author Bernhard Reiter <bernhard@intevation.de>
date Mon, 13 Aug 2018 15:09:26 +0200
parents docs/schnittstellen.txt@94a1dd4ed50c
children 815f5e2ed974
comparison
equal deleted inserted replaced
387:0f78b13f4a9a 388:56897dd9a2b2
1 | Route | Methode | Daten | *PUC | JSON | HTTP-Code | Anmerkung |
2 |--------------------------+----------+-------------------------------------------------------+--------------+----------------------------------------------------+---------------+------------------------------------------------+
3 | /api/users | GET | Liste an Usern | | | 200, 500 | |
4 | /api/users | POST | user, password, role, email, country, *extent | APUC3, APUC4 | | 201, 400, 500 | |
5 | /api/users/{user} | GET | | APUC3, APUC4 | login, password, role, email, country, extent zoom | 201, 500 | |
6 | /api/users/{user} | DELETE | | APUC3 | | 204, 500 | |
7 | /api/users/{user} | PUT | user, password, role, email, country, *extent | APUC3 | login, password, role, email, country, extent zoom | 200, 500 | |
8 | /api/users/passwordreset | POST | user | GPUC3 | user | 200, 500 | |
9 | /api/login | GET/POST | user, password -> token im Result-JSON | APUC1 | | 200, 500 | |
10 | /api/logout | GET/POST | | APUC2 | | 200, 500 | |
11 | /api/renew | GET/POST | | APUC2 | | 200, 500 | |
12 | /api/health/hardware | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
13 | /api/health/system | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
14 | /api/health/access | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
15 | /api/sendtestmail | POST | recipients: userids / an SAdmins, an WWAdmins | APUC9 | | 200, 500 | !Throttle! |
16 | /api/management | GET | aktuelle Konfiguration | APUC10 | | 200, 500 | |
17 | /api/management | PATCH | zu ändernde Parameter | APUC10 | | 200, 500 | |
18 | /api/templates | GET | Liste an Templates | APUC6 | | 200, 500 | |
19 | /api/templates | POST | Daten für ein neues Template | APUC6 | | 201, 500 | |
20 | /api/templates/{id} | GET | Metadaten für das Template | APUC6 | | 200, 500 | |
21 | /api/template/{id} | PATCH | zu ändernde Parameter | APUC6 | | 200, 500 | |
22 | /api/template/{id} | DELETE | | APUC6 | | 200, 500 | |
23 | /api/maps/print | POST | Metadaten für den Druck(?) | GPUC7 | | 200, 500 | |
24 | /api/search (?) | POST | Das zu suchende | GPUC10 | | 200, 500 | |
25 | /api/bottlenecks | GET | | SPUC1 | | 200, 500 | Limit? |
26 | /api/fairwaydimension | GET | Flusskilometerangabe, Zeitpunkt(?) | SPUC3 | | 200, 500 | SVG? |