Return a list of checklists
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | checklistheader.json | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
| Model Structure | Yes | Name of model required | modelstructure=checklistheaderslist | 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 | Yes | The company number | company=1 | |
| Identifier | No | Attachment ID or UUID | activityid=7078 |
Example request:
http://<SERVER>/jsonAPI/checklistheader.json?user=user&password=user&version=3.9&company=1&style=modeldata&modelstructure=checklistheaderslist&activityid=7078
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 33,
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 33,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"checklistUuid": "FA1F7D646AA4604EA2837CCBBC9DEA62",
"checklistTimestampModified": 1552475175,
"checklistRecordVersionNumber": 0,
"checklistTitle": "My Checklist 1",
"checklistActivityID": 5964,
"checklistOrder": 1,
"checklistHideCompletedItems": false,
"checklistCreatedDate": "2019-03-13",
"checklistCreatedDateUTC": "2019-03-13",
"checklistCreatedTime": "11:06:15",
"checklistCreatedTimeUTC": "11:06:15",
"checklistCreatedTimezone": "UTCA",
"checklistCreatedUserID": 3,
"checklistCreatedBy": "SYN_Jon",
"checklistModifiedBy": "SYN_Jon",
"checklistModifiedDate": "2019-03-13",
"checklistModifiedTime": "11:06:15",
"checklistModifiedTimezone": "UTCA",
"checklistModifiedDateUTC": "2019-03-13",
"checklistModifiedTimeUTC": "11:06:15",
"checklistModifiedUserID": 3
},
{
"checklistUuid": "6DAF95A26E921C44A03033B50B5D9891",
"checklistTimestampModified": 1539600889,
"checklistRecordVersionNumber": 4,
"checklistTitle": "My Checklist 1z",
"checklistActivityID": 7078,
"checklistOrder": 1,
"checklistHideCompletedItems": false,
"checklistCreatedDate": "2018-10-12",
"checklistCreatedDateUTC": "2018-10-12",
"checklistCreatedTime": "15:21:07",
"checklistCreatedTimeUTC": "14:21:07",
"checklistCreatedTimezone": "UTCA",
"checklistCreatedUserID": 0,
"checklistCreatedBy": "",
"checklistModifiedBy": "",
"checklistModifiedDate": "2018-10-15",
"checklistModifiedTime": "11:54:49",
"checklistModifiedTimezone": "UTCA",
"checklistModifiedDateUTC": "2018-10-15",
"checklistModifiedTimeUTC": "10:54:49",
"checklistModifiedUserID": 0
},
{ etc etc