GET Questions/{StudyKey}?types={types}&tasks={tasks}

Get the Questions in a Study, with optional filters.
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.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
StudyKey

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

integer

Required

types

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:

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

string

None.

tasks

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:

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

string

None.

Body Parameters

None.

Response Information

Get the Questions in a Study, with optional filters.
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.

GetQuestionsResponse
NameDescriptionTypeAdditional information
questions

A list of Questions.

Collection of Question

Required

errors

If null the request was processed without error. If not null errors occurred while processing the request. The array contains the error messages.

Collection of string

None.