WOCAT » QCAT

h1. Questionnaire Structure

h2. Terminology

* *Questionnaire Data* (how the data of a questionnaire is saved in the DB and submitted to the API)

* *Questionnaire Configuration* (how the questionnaire is built, which questions are available in which categories etc.)

* *Questiongroup*: A group of questions belonging together. Example: Image, Caption, Location, Name of photographer. Questiongroups can be repeated, for example if multiple Images are available.

h2. Questionnaire Data

* The entire data of a questionnaire is stored in a single JSON field in the database.

* The format is as flat as possible: It contains questiongroups and questions (no categories or other Questionnaire Configuration data)

* Sample 1: Questionnaire Data, shortened and with comments (in Python syntax)

* Sample 2: Questionnaire Data, complete in JSON

h2. Questionnaire Configuration

* The configuration of a questionnaire consists of multiple levels:

  * @sections@ (actually not used anymore)

    * @categories@ (Example: 1. General information)

      * @subcategories@ (Example: 1.1 Name of the SLM Technology (hereafter referred to as the Technology))

        * @questiongroups@ (Example: Name and Locally used name) - not always directly visible in the form

          * @questions@ (Example: Name)

* The structure of the Questionnaire Configuration can be extracted using a management command (under development). This might eventually become an API endpoint at one point?

* Sample: Questionnaire Configuration of Technologies form, edition 2015.

h2. API Endpoint to create Questionnaires

* Accepts data in the *Questionnaire Data* format.

* Validates the data, creates links to other models (e.g. users) and saves a new questionnaire.

* Needs to be created.