Web Services Definition » History » Version 3
Kurt Gerber, 25 Jan 2016 17:22
| 1 | 2 | Kurt Gerber | h1. API / Web Services Definition |
|---|---|---|---|
| 2 | |||
| 3 | h2. 1. General Requirements |
||
| 4 | |||
| 5 | h3. 1.1. *The API is based on RESTful web services* |
||
| 6 | |||
| 7 | h3. 1.2. *No authentification is needed to query/download published data* |
||
| 8 | |||
| 9 | h3. 1.3. *The API has a version* |
||
| 10 | |||
| 11 | This can either be done through a parameter or a path. Preferably part of the path to force version idication. |
||
| 12 | |||
| 13 | 3 | Kurt Gerber | |
| 14 | |||
| 15 | |||
| 16 | 2 | Kurt Gerber | h3. 1.4. *Output/Answer* |
| 17 | |||
| 18 | The Output formats should selectable between JSON,XML and CSV with JSON as default. |
||
| 19 | 3 | Kurt Gerber | |
| 20 | h2. 2. Configuration queries |
||
| 21 | |||
| 22 | h3. 2.1 querying all configurations |
||
| 23 | |||
| 24 | * *Returns:* |
||
| 25 | ** List of all configurations and all their versions |
||
| 26 | |||
| 27 | * *Items:* |
||
| 28 | ** Configuration name (identifier) |
||
| 29 | ** Configuration version |
||
| 30 | ** Date of creation / last update |
||
| 31 | ** (Short description ?) |
||
| 32 | |||
| 33 | |||
| 34 | |||
| 35 | |||
| 36 | |||
| 37 | |||
| 38 | |||
| 39 | |||
| 40 | |||
| 41 | h3. |