The following methods can be used to read the metadata and other contents of the survey.
This method provides access to the metadata of a survey.
URL |
/api/v2/surveys |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Method |
GET |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter |
page, limit |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return |
JSON |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Return values |
|
Languages
This method can be used to list all the languages in a survey.
URL |
/api/v2/surveys/languages |
|||||||||||||||
Method |
GET |
|||||||||||||||
Parameter |
surveyid, page, limit |
|||||||||||||||
Return |
JSON |
|||||||||||||||
Return values |
|
Pages
This method gives access to the pages that were created for surveys. A special feature here is the welcome page (id: -1) and the closing page (id: -2). The surveyid parameter is mandatory for this method!
URL |
/api/v2/surveys/pages |
|||||||||||||||
Method |
GET |
|||||||||||||||
Parameter |
surveyid (required), page, limit |
|||||||||||||||
Return |
JSON |
|||||||||||||||
Return values |
|
Questions and elements
This method provides access to the questions and elements that are assigned to a survey. The structure is strictly hierarchical. The individual levels of the elements and the IDs available there correspond to the results from /api/v2/results as follows:
- Level: questionid
- Level: answerid
- Level: levelid
The surveyid parameter is mandatory for this method!
URL |
/api/v2/surveys/questions |
||||||||||||||||||||||||||||||||||||||||||||||||
Method |
GET |
||||||||||||||||||||||||||||||||||||||||||||||||
Parameter |
surveyid (required), pageid, page, limit |
||||||||||||||||||||||||||||||||||||||||||||||||
Return |
JSON |
||||||||||||||||||||||||||||||||||||||||||||||||
Return values |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Element Object |
|