GET method returns a list of objects, PATCH accepts and returns a single object
Query String Parameters (GET)
| Name | Description | Required | Example |
|---|---|---|---|
survey_id | The ID of a survey | Yes | ?id=1 |
rduds | Comma delimited value of the Response IDs being retrieved | No | ?rduds=1,2,3 |
statuses | Comma delimited value of the URL-encoded statuses associated with the Responses being retrieved. | No | ?statuses=complete,security termination |
page | Integer value of the page being retrieved | No; if omitted, the value defaults to 1 | ?page=2 |
page_size | Integer value dictating the number of objects returned per page. | No; if omitted, the value defaults to 50 | ?page_size=100 |
Response Object Definition
| Parameter | Required on PATCH | Description |
|---|---|---|
rdud | Yes | The ID of the associated Response object. |
status | System Assigned | The status associated with the Response object. |
reconciliation_status | Yes Note: Can only be Accepted or Rejected | The reconciliation status of a Response object. |
buyer_cpi | System Assigned | The price this respondent cost if it was complete. |
qualification_attributes | System Assigned | What qualification(s) the respondent had. |
quota_attributes | System Assigned | Which quota(s) the respondent fell under. |
Authorizations
Authentication token to be sent directly in the Authorization header (no '' prefix).