Project

General

Profile

Web Services Definition » History » Version 4

Kurt Gerber, 25 Jan 2016 17:27

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
* *Parameters:*
31
32 3 Kurt Gerber
* *Returns:* 
33
** List of all configurations and all  their versions
34
35 4 Kurt Gerber
* *Answer items:*
36 3 Kurt Gerber
** Configuration name (identifier)
37 1 Kurt Gerber
** Configuration version
38
** Date of creation / last update
39
** (Short description ?)
40
41 4 Kurt Gerber
42
h3. 2.2. Single configuration
43
44
* *Returns:*
45
** A single configuration 
46
47
* *Items*
48 3 Kurt Gerber
49
50
 
51
52
53
54
55
56
h3.