POST Batches/respondents
Add respondent data to a Batch.
Use this operation one or more times to add respondent data to the Batch.
You must add at least one respondent to the Batch before you can start the analysis of the Batch.
The maximum request length to this API is 16 MBytes, so if you are adding a large number of respondents
you should use this operation multiple times with only as many respondents in each request as will ensure
that the maximum request length is not exceeded.
Request Information
URI Parameters
None.
Body Parameters
The respondent data.
AddRespondentsRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| Respondents |
The respondents to add. |
Collection of Respondent |
Required |
| BatchKey |
The Batch key. |
integer |
Required |
| InspectionKey |
The Inspection key. |
integer |
Required |
Response Information
Add respondent data to a Batch.
Use this operation one or more times to add respondent data to the Batch.
You must add at least one respondent to the Batch before you can start the analysis of the Batch.
The maximum request length to this API is 16 MBytes, so if you are adding a large number of respondents
you should use this operation multiple times with only as many respondents in each request as will ensure
that the maximum request length is not exceeded.
| Name | Description | Type | Additional information |
|---|---|---|---|
| RespondentsAdded |
The number of respondents added as a result of this request. |
integer |
Required |
| TotalRespondentsAdded |
The total number of respondents in the Batch after processing this request. |
integer |
Required |
| InspectionKey |
The key of the Inspection. |
integer |
Required |
| BatchKey |
The key of the Batch. |
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. |