Return a list of checklist items
List of checklist items
Parameter | Description | Example | More info |
---|---|---|---|
API | The API area | checklistheader.json | |
Action | Not required | ||
Parameters described in overview | user=user\&password=user\&version=3.3 | [Overview](ref:overview-2) | |
checklistheader | Checklist header ID | \&checklistheader=F9ED26457F3ECD4AB55A0B04DF223278 | |
Company | Company number | \&company= | |
UUID | Checklist item uuid | \&uuid= | |
Modelstructure | Name of model required | Modelstructure=checklistitemslist | [Using data models](ref:using-models) |
Filter by a key field | client=1/F667 | [Filters](ref:filters) | |
Response | Returned data | A JSON string containing the data |
Example request:
Request to return a list of checklist items
http://<SERVER>/jsonAPI/checklistitems.json?user=user&password=user&version=3.3&company=3&style=modeldata&modelstructure=checklistitemslist&checklistheader=D79C5ECDD09C194EBC411CE10BE90FDC
Example response:
{
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"totalrows": 1,
"totalpages": 1,
"responsemessage": "",
"pagerows": 0,
"pagenumber": 1,
"success": true,
"data": [
{
"checklistitemUuid": "F086648A31FBAD4DA9FC4FB79D0046AD",
"checklistitemTimestampModified": 1553785176,
"checklistitemRecordVersionNumber": 0,
"checklistitemChecklistHeaderUUID": "7D975C7575244542B86E03B4BB3FF65A",
"checklistitemComplete": false,
"checklistitemOrder": 1,
"checklistitemDescription": "item 1"
}
]
}