WOCAT » QCAT

Intro¶

The main reason to implement a new version of the configuration is so the API returns structured data (=from checkboxes) instead of text. It's important to keep the distinction between API version and configuration version in mind; the API version will not change (v2). All current users of the API will be informed about the changes.

Decisions¶

• The structure of the questionnaire data changes depending on the edition. The 'configuration' is a new concept for the API users, so make it explicit.
• The list view by default returns all questionnaires, regardless of their editions.

• A new field on the list indicates the current edition of the questionnaire.

• An optional filter is available to filter specific editions (e.g. "show only questionnaire in edition 2015")
• The configuration version is now a required field / parameter for all questionnaire detail endpoints.
• In order to display 'stable' structure of the data, a request to an 'old' questionnaire should return a 404 / 302 (not found/redirect).
• Maybe: add an endpoint for the configuration object.