Web Services Definition » History » Revision 5
Revision 4 (Kurt Gerber, 25 Jan 2016 17:27) → Revision 5/40 (Kurt Gerber, 28 Jan 2016 12:23)
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:* * *Parameters:* * *Returns:* ** List of all active configurations and all their versions * *Answer items:* ** *Items contained:* Configuration name (identifier) *** All fields from configuration_configuration table, except _'data'_ * *Parameter:* <pre> configurations/code </pre> ** code: is the code of a questionnaire Configuration version * *Request* <pre> GET .../configurations/code </pre> **Returns:* ** List Date of all configuration versions of <code>, active or inactive creation / last update ** *Items contained:* *** All fields from configuration_configuration table, except _'data'_ (Short description ?) * *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.