Web Services Definition » History » Version 7
Kurt Gerber, 28 Jan 2016 14:19
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 | 2 | Kurt Gerber | h3. 1.4. *Output/Answer* |
15 | |||
16 | 1 | Kurt Gerber | The Output formats should selectable between JSON,XML and CSV with JSON as default. |
17 | |||
18 | 4 | Kurt Gerber | |
19 | |||
20 | 3 | Kurt Gerber | h2. 2. Configuration queries |
21 | 1 | Kurt Gerber | |
22 | 4 | Kurt Gerber | h3. 2.1. All configurations |
23 | 1 | Kurt Gerber | |
24 | 4 | Kurt Gerber | * *Request* |
25 | |||
26 | <pre> |
||
27 | GET .../configurations |
||
28 | </pre> |
||
29 | |||
30 | 7 | Kurt Gerber | * *Returns:* |
31 | 5 | Kurt Gerber | ** List of all active configurations |
32 | ** *Items contained:* |
||
33 | *** All fields from configuration_configuration table, except _'data'_ |
||
34 | 1 | Kurt Gerber | |
35 | |||
36 | 6 | Kurt Gerber | * *Parameter:* <pre> .../configurations/code </pre> |
37 | 1 | Kurt Gerber | ** code: is the code of a questionnaire |
38 | 7 | Kurt Gerber | |
39 | * *Returns:* |
||
40 | ** List of all configuration versions of _code_, active or inactive |
||
41 | 1 | Kurt Gerber | ** *Items contained:* |
42 | 7 | Kurt Gerber | *** All fields from configuration_configuration table, except 'data' |
43 | 1 | Kurt Gerber | |
44 | 5 | Kurt Gerber | |
45 | 7 | Kurt Gerber | |
46 | * *Parameter:* |
||
47 | <pre> questionnaires=yes </pre> |
||
48 | |||
49 | ** *Returns:* |
||
50 | 5 | Kurt Gerber | ** List of all active configurations |
51 | ** *Items contained:* |
||
52 | *** All fields from configuration_configuration table, except _'data'_ |
||
53 | *** Array of all linked questionnaires |
||
54 | |||
55 | 1 | Kurt Gerber | h3. 2.2. Single configuration |
56 | 5 | Kurt Gerber | |
57 | * *Request:* |
||
58 | <pre> |
||
59 | GET ../configuration/<identifier> |
||
60 | </pre> |
||
61 | |||
62 | * *Parameters:* |
||
63 | ** |
||
64 | 4 | Kurt Gerber | |
65 | * *Returns:* |
||
66 | ** A single configuration |
||
67 | |||
68 | 3 | Kurt Gerber | * *Items* |
69 | |||
70 | |||
71 | |||
72 | |||
73 | |||
74 | |||
75 | |||
76 | |||
77 | 1 | Kurt Gerber | h3. |