Hide Completed Items

Hide completed items

Hide Completed Items

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areachecklistheader.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
CompanyYesThe company numbercompany=1
ActionYesThe action to performaction=completed_hide
IdentifierYesChecklist UUIDuuid=1E78E968D52160428B123B48978F4F40

Example request (OAuth 2.0):

Authorization: Bearer <access_token>
http://&lt;SERVER&gt;/jsonapi/checklistheader.json?&version=6&uuid=1E78E968D52160428B123B48978F4F40&action=completed_hide

Example request (legacy username/password):

http://&lt;SERVER&gt;/jsonapi/checklistheader.json?&version=6&uuid=1E78E968D52160428B123B48978F4F40&action=completed_hide&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "Checklist header completed items show/hide changed. ",
  "warningmessage": "",
  "success": true
}