annotate docs/server-interface.txt @ 715:23b68cd4bed3

client: re-enable loading of full river bank marks * Remove the bboxFilter that restricted loading of external distance_marks to the extend of the Austrian Danbue. Because of the improved loading strategy, this is more feasable, but still there maybe issue when trying to display everything.
author Bernhard Reiter <bernhard@intevation.de>
date Fri, 21 Sep 2018 13:57:40 +0200
parents 56897dd9a2b2
children 815f5e2ed974
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
229
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
1 | Route | Methode | Daten | *PUC | JSON | HTTP-Code | Anmerkung |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
2 |--------------------------+----------+-------------------------------------------------------+--------------+----------------------------------------------------+---------------+------------------------------------------------+
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
3 | /api/users | GET | Liste an Usern | | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
4 | /api/users | POST | user, password, role, email, country, *extent | APUC3, APUC4 | | 201, 400, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
5 | /api/users/{user} | GET | | APUC3, APUC4 | login, password, role, email, country, extent zoom | 201, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
6 | /api/users/{user} | DELETE | | APUC3 | | 204, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
7 | /api/users/{user} | PUT | user, password, role, email, country, *extent | APUC3 | login, password, role, email, country, extent zoom | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
8 | /api/users/passwordreset | POST | user | GPUC3 | user | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
9 | /api/login | GET/POST | user, password -> token im Result-JSON | APUC1 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
10 | /api/logout | GET/POST | | APUC2 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
11 | /api/renew | GET/POST | | APUC2 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
12 | /api/health/hardware | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
13 | /api/health/system | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
14 | /api/health/access | GET | | APUC8 | | 200, 500 | Optionale Queryparameter: limit, from, from+to |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
15 | /api/sendtestmail | POST | recipients: userids / an SAdmins, an WWAdmins | APUC9 | | 200, 500 | !Throttle! |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
16 | /api/management | GET | aktuelle Konfiguration | APUC10 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
17 | /api/management | PATCH | zu ändernde Parameter | APUC10 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
18 | /api/templates | GET | Liste an Templates | APUC6 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
19 | /api/templates | POST | Daten für ein neues Template | APUC6 | | 201, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
20 | /api/templates/{id} | GET | Metadaten für das Template | APUC6 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
21 | /api/template/{id} | PATCH | zu ändernde Parameter | APUC6 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
22 | /api/template/{id} | DELETE | | APUC6 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
23 | /api/maps/print | POST | Metadaten für den Druck(?) | GPUC7 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
24 | /api/search (?) | POST | Das zu suchende | GPUC10 | | 200, 500 | |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
25 | /api/bottlenecks | GET | | SPUC1 | | 200, 500 | Limit? |
94a1dd4ed50c Reworked doc/schnittstellen.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 226
diff changeset
26 | /api/fairwaydimension | GET | Flusskilometerangabe, Zeitpunkt(?) | SPUC3 | | 200, 500 | SVG? |