view 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
line wrap: on
line source

| 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?                                           |