Complete Item

Complete an item in a checklist

Complete Item

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areachecklistitems.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=item_complete
IdentifierYesChecklist item UUIDuuid=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
}