PUT Responses/{QuestionKey}

Add or update Responses in the specified Question.
If the Question does not have a Response stored in Ascribe with the specified respondent id, then the response will be added.
Otherwise, the Response stored in Ascribe will be updated if any of the properties of in the request differ from the values of the current properties of the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
QuestionKey

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

integer

Required

Body Parameters

The Responses to add or update.

PutResponsesRequest
NameDescriptionTypeAdditional information
responses

The responses to be added or updated.
All strings in these responses will be trimmed of leading and trailing white space.

Collection of PutResponse

Required

Response Information

Add or update Responses in the specified Question.
If the Question does not have a Response stored in Ascribe with the specified respondent id, then the response will be added.
Otherwise, the Response stored in Ascribe will be updated if any of the properties of in the request differ from the values of the current properties of the response.

PutResponsesResponse
NameDescriptionTypeAdditional information
responsesAdded

The count of Responses added to the Question.
This is the number of responses in the PutResponsesRequest that had rid values that were not already present in this Question.

integer

Required

existingResponsesUpdated

The count of existing Responses updated.
This is the number of responses in the PutResponsesRequest that had rid values that were already present in this Question, and for which any of the text, translation, transcription, or notes values were specified in the request and differed from the existing value in the Response.

integer

Required

existingResponsesUnchanged

The count of existing Responses unchanged.
This is the number of responses in the PutResponsesRequest that had rid values that were already present in this Question, and for which all of the text, translation, transcription, or notes values were either not specified in the request or identical to the existing value in the Response.

integer

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.