Complete an item in a checklist
Complete Item
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | checklistitems.json | |
| General | Yes | Parameters described in overview | Authorization: Bearer <access_token> header — see Synergist API Authentication | Structure of an API call |
| Action | Yes | The action to perform | action=item_complete | |
| Identifier | Yes | Checklist item UUID | uuid=09BE9E44B80C634A99C91B57DB6684A2 |
Example request (OAuth 2.0):
Authorization: Bearer <access_token>
http://<SERVER>/jsonapi/checklistitems.json?&version=6&action=item_complete&uuid=09BE9E44B80C634A99C91B57DB6684A2
Example request (legacy username/password):
http://<SERVER>/jsonapi/checklistitems.json?&version=6&action=item_complete&uuid=09BE9E44B80C634A99C91B57DB6684A2&user=<username>&password=<password>
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "1 of 1 checklistitems completed.",
"warningmessage": "",
"success": true
}