view docs/server-interface.txt @ 2549:9bf6b767a56a

client: refactored and improved splitscreen for diagrams To make different diagrams possible, the splitscreen view needed to be decoupled from the cross profiles. Also the style has changed to make it more consistent with the rest of the app. The standard box header is now used and there are collapse and expand animations.
author Markus Kottlaender <markus@intevation.de>
date Fri, 08 Mar 2019 08:50:47 +0100
parents 815f5e2ed974
children
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/system/log/{service}/{file} | GET      |                                               | APUC8        | path, content                                      | 200, 500      | Later: add limiting parameters                 |
| /api/system/hardware             | GET      |                                               | APUC8        |                                                    | 200, 500      | Optionale Queryparameter: limit, from, from+to |
| /api/system/system               | GET      |                                               | APUC8        |                                                    | 200, 500      | Optionale Queryparameter: limit, from, from+to |
| /api/system/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?                                           |