Return a list of checklists
List of checklist headers
Parameter | Description | Example | More info |
---|---|---|---|
API | The API area | checklistheader.json | |
Action | Not required | ||
<General> | Parameters described in overview | user=user&password=user&version=3.3 | |
<input mandatory>Company | Company number | &company=1 | |
<input optional>uuid | Checklist uuid | &uuid= | |
<input optional>activityID | Checklist ActivityID | &activityid=7078 | |
Modelstructure | Name of model required | Modelstructure=checklistheaderslist | |
<Filters> | Filter by a key field | client=1/F667 | |
Response | Returned data | A JSON string containing the data |
Example request:
Request to return a list of checklists
http://<SERVER>/jsonAPI/checklistheader.json?user=user&password=user&version=3.3&company=1&style=modeldata&modelstructure=checklistheaderslist&activityid=7078
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 2,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"checklistUuid": "7D975C7575244542B86E03B4BB3FF65A",
"checklistTimestampModified": 1553785167,
"checklistRecordVersionNumber": 0,
"checklistTitle": "My checklist header1",
"checklistActivityID": 3565,
"checklistOrder": 1,
"checklistHideCompletedItems": false
},
{
"checklistUuid": "54B64BE772B2D74D9595CACD7C089981",
"checklistTimestampModified": 1553785203,
"checklistRecordVersionNumber": 0,
"checklistTitle": "My checklist header 2",
"checklistActivityID": 3565,
"checklistOrder": 2,
"checklistHideCompletedItems": false
}
]
}