home api list

Hexostore API Documentation

questionnaire

/api/questionnaire/

List methods: get

Detail methods: options, get

Allow to get a specific questionnaire with /api/questionnaire// or return all questionnaires if no id is provided.
A questionnaire is a field resource used in a survey that contains multiple questions
For more information, Click here.
For more information on what is a survey, check the study section here
For more information on how to submit a survey response, check surveyanswers or csvsurveyanswers

Fields

id: CharField

This field is readonly.

status: SerializerMethodField

draft | active | retired | unknown More information

This field is readonly.

subjectType: SerializerMethodField

Resource that can be subject of QuestionnaireResponse More information

This field is readonly.

resourceType: SerializerMethodField

Should be "Questionnaire"

This field is readonly.

item: SerializerMethodField

Questions and sections within the Questionnaire More information

This field is readonly.

url: RelatedUrlField

Canonical identifier for this questionnaire, represented as a URI (globally unique) More information

This field is readonly.

name: CharField

Name for this questionnaire (computer friendly) More information

This field will default to: '' (empty string)

title: CharField

Name for this questionnaire (human friendly) More information

This field will default to: '' (empty string)

description: CharField

Natural language description of the questionnaire More information

This field may be blank

This field will default to: '' (empty string)

Filtering Options

id: exact, in, gt, gte, lt, lte, range

Sorting Options

No sorting supported

© 2024 by CarrĂ© Technologies Inc.