GET Responses/{QuestionKey}?includeText={includeText}&status={status}

Get the Responses in the specified Question, including the keys of Codes applied to the Responses.
For coded responses the keys of the applied codes are returned for each response.
These keys can be matched to the keys of the codes returned in a query for the codebook to find the details of each of the applied codes.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
QuestionKey

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

integer

Required

includeText

If true, the text of each Response is returned.
If false or omitted the text is not returned.

boolean

Default value is False

status

If omitted, all Responses for the Question are returned.
If present, one of these values:

  • coded: return only Responses with at least one Code applied.
  • uncoded: return only Responses with no Code applied.

string

None.

Body Parameters

None.

Response Information

Get the Responses in the specified Question, including the keys of Codes applied to the Responses.
For coded responses the keys of the applied codes are returned for each response.
These keys can be matched to the keys of the codes returned in a query for the codebook to find the details of each of the applied codes.

GetResponsesResponse
NameDescriptionTypeAdditional information
responses

The requested responses in the Question.

Collection of ExistingResponse

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.