Web Services Definition » History » Revision 8
Revision 7 (Kurt Gerber, 28 Jan 2016 14:19) → Revision 8/40 (Sebastian Manger, 09 Feb 2016 11:34)
h1. API / Web Services Definition
h2. 1. General Requirements
h3. 1.1. *The API is based on RESTful web services*
h3. 1.2. *No authentification is needed to query/download published data*
h3. 1.3. *The API has a version*
This can either be done through a parameter or a path. Preferably part of the path to force version idication.
h3. 1.4. *Output/Answer*
The Output formats should selectable between JSON,XML and CSV with JSON as default.
h2. 2. Configuration queries
h3. 2.1. All configurations
* *Request*
<pre>
GET .../configurations
</pre>
* *Returns:*
** List of all active configurations
** *Items contained:*
*** All fields from configuration_configuration table, except _'data'_
* *Parameter:* <pre> .../configurations/code </pre>
** code: is the code of a questionnaire
* *Returns:*
** List of all configuration versions of _code_, active or inactive
** *Items contained:*
*** All fields from configuration_configuration table, except 'data'
* *Parameter:*
<pre> questionnaires=yes </pre>
** *Returns:*
** List of all active configurations
** *Items contained:*
*** All fields from configuration_configuration table, except _'data'_
*** Array of all linked questionnaires
h3. 2.2. Single configuration
* *Request:*
<pre>
GET ../configuration/<identifier>
</pre>
* *Parameters:*
**
* *Returns:*
** A single configuration
* *Items*
h3. Meeting notes (9. Feb. 2016)
- portal of portals:
- übersichtsdienst, welcher alles holt
- titel
- abstract
- <more>
- link
- filter: wocat / unccd
- filter: approach / technology
- mit auth
- plus logging für abfragen pro auth token
- detail
- später