API / Web Services Definition¶

1. General Requirements¶

1.1. The API is based on RESTful web services¶

1.2. No authentification is needed to query/download published data¶

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.

1.4. Output/Answer¶

The Output formats should selectable between JSON,XML and CSV with JSON as default.

2. Configuration queries¶

2.1. All configurations¶

• Request

GET .../configurations

• Returns:
  • List of all active configurations
  • Items contained:
    • All fields from configuration_configuration table, except 'data'

• Parameter:

   .../configurations/code 

  • 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:
  

   questionnaires=yes 

• Returns:
• List of all active configurations
• Items contained:
  • All fields from configuration_configuration table, except 'data'
  • Array of all linked questionnaires

2.2. Single configuration¶

• Request:
  

  GET ../configuration/<identifier>
  

• Parameters: **

• Returns:
  • A single configuration

• Items

h3.