Return a list of checklist items
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | checklistitems.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | v3.9Overview |
| Model Structure | Yes | Name of model required | modelstructure=checklistitemslist | Using data models |
| View | No | Stored filter applied | Using views | |
| Sort | No | Change the view's default sort order | sort=CLIENT | Sorting |
| Filters | No | Filter by a key field | Filters | |
| Company | No | The company number | company=1 | |
| Activity | No | The activity ID - to get a list of all items for activity | activity=8786 | |
| Identifier | Yes | Checklist header ID or UUID | checklistheader=F9ED26457F3ECD4AB55A0B04DF223278 | |
| Identifier | Yes | Checklist item UUID | uuid=F9ED26457F3ECD4AB55A0B04DF223278 |
Example request:
http://<SERVER>/jsonAPI/checklistitems.json?user=user&password=user&version=3.9&company=3&style=modeldata&modelstructure=checklistitemslist&checklistheader=D79C5ECDD09C194EBC411CE10BE90FDC
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 2,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"checklistitemUuid": "81751011112B9242BFC2C72355C601E3",
"checklistitemTimestampModified": 1553079480,
"checklistitemRecordVersionNumber": 1,
"checklistitemChecklistHeaderUUID": "D79C5ECDD09C194EBC411CE10BE90FDC",
"checklistitemComplete": true,
"checklistitemOrder": 1,
"checklistitemDescription": "item 1",
"checklistitemCompleteDate": "2019-03-20",
"checklistitemCompleteDateUTC": "2019-03-20",
"checklistitemCompleteTime": "10:58:00",
"checklistitemCompleteTimeUTC": "10:58:00",
"checklistitemCompleteTimezone": "UTCA",
"checklistitemCompleteUserID": 5,
"checklistitemCompletedBy": "Mike Pender",
"checklistitemCreatedBy": "Mike Pender",
"checklistitemModifiedBy": "Mike Pender",
"checklistitemCreatedDate": "2019-03-20",
"checklistitemCreatedDateUTC": "2019-03-20",
"checklistitemCreatedTime": "10:55:27",
"checklistitemCreatedTimeUTC": "10:55:27",
"checklistitemCreatedTimezone": "UTCA",
"checklistitemCreatedByUserID": 5,
"checklistitemModifiedDate": "2019-03-20",
"checklistitemModifiedTime": "10:55:27",
"checklistitemModifiedTimezone": "UTCA",
"checklistitemModifiedDateUTC": "2019-03-20",
"checklistitemModifiedTimeUTC": "10:55:27",
"checklistitemModifiedByUserID": 5
},