GET Responses/{QuestionKey}?includeText={includeText}&status={status}&codedAfter={codedAfter}&codedBefore={codedBefore}&loadedAfter={loadedAfter}&loadedBefore={loadedBefore}

Get the Responses in the specified Question
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.

The optional date query parameters are UTC date/time values.
These should be specified in the form:
YYYY-MM-DDThh:mm:ss
Where the hour ranges from 0 to 23. For example:
2020-02-23T16:05:17
If the time portion of the date/time value is omitted it is assumed to be 00:00:00 GMT.

Request Information

URI Parameters

Name	Description	Type	Additional 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.
codedAfter	If present, only responses with a code applied on or after the specified date/time are returned.	date	None.
codedBefore	If present, only responses with a code applied before the specified date/time are returned.	date	None.
loadedAfter	If present, only responses loaded on or after the specified date/time are returned.	date	None.
loadedBefore	If present, only responses loaded before the specified date/time are returned.	date	None.

Body Parameters

None.

Response Information

Get the Responses in the specified Question
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.

The optional date query parameters are UTC date/time values.
These should be specified in the form:
YYYY-MM-DDThh:mm:ss
Where the hour ranges from 0 to 23. For example:
2020-02-23T16:05:17
If the time portion of the date/time value is omitted it is assumed to be 00:00:00 GMT.

GetResponsesResponse

Name	Description	Type	Additional 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.