survey/cancel_assignment
Cancel an assignment if it can not be completed
Important: An API Key is required to work with these API Calls
Important: This API Call requires information to be sent in via POST
http://api.verifiapp.com/survey/cancel_assignment/{API-KEY}/{ASSIGNMENT-ID}
A 'comment' field needs to be Posted to the API function. For example:
$_POST["comment"] = "a sample comment"
Also, a completion code can be attached to the cancellation of the assignment:
$_POST["completion_code_id"] = 1
Sample Successful Response
{
result: "success"
error: "Assignment {ASSIGNMENT-ID} cancelled"
}
Successful Response Reference
A successful response will return the following items in a JSON array
| Preference | Description |
|---|---|
| result | success |
| results | The assignment ID that has been cancelled |
Unsuccessful Response Reference
A unsuccessful response will return the following items in a JSON array
| Preference | Description | Sample response |
|---|---|---|
| result | error | |
| error | The specific error is described in the response |