latestOpenAPI 3.0.12026-08-10254561.9 KB

2ea4b8555197

Questions

Get the Questions in a Study

Retrieves by default all of the Questions in the Study.

You can optionally retrieve only a sub-set of the questions, filtering by the question type or the tasks assigned to the question.

get/Questions/{studyKey}

Path parameters

studyKeyinteger required

The key of the Study, which must be an integer value.

Query parameters

typesstring

Optional filter by Question type.

        If omitted, Questions of all types are returned.

        If present, a string containing these characters, the presence of which specifies the type of Question desired:

<ul><li>c: Closed </li><li>d: Data </li><li>o: Open </li><li>s: Other/Specify </li><li>v: Value </li></ul> For example, the value 'so' (or 'os') returns Open and Other/Specify Questions.

tasksstring

Optional filter by task.

If omitted, Questions are not filtered by task.

If present, a string containing these characters, the presence of which specified the task assigned to a Question:

<ul><li>c: Code this Question </li><li>x: Crosstab this Question </li><li>b: Transcribe this Question </li><li>t: Translate this Question </li></ul> For example, the value ('ct' or 'tc') returns Questions with the Code or Translate tasks set.

Response

errorMessagestring nullable