Reference
Base URI
Staging - https://staging-api-service.azurewebsites.net/
Production - https://api.peopletray.com
Production (Aus Instance) - https://au1-peopletray-public-api-service.azurewebsites.net
Authentication
The endpoints are secured by the Account Key (available on the Settings page of PeopleTray), passed in the URL.
Checklist Details (Including Questions/Responses)
Gets a list of Checklist Headers along with Questions and Responses.
Returns Checklists from the past 7 days by default, mainly to restrict the large amount of data that this API returns.
Optional custom dates can be passed in for data outside of the default 7 days period.
Endpoint {baseUrl}/api/reporting/{accountKey}/checklistdetails
Method: GET
Parameters:
-
accountKey- GUID - Required - Path Parameter -
workflowTypeId- GUID - Optional - Query Parameter. The value is available on the Web UI on Settings >> Workflow Admin >> Configure Workflow >> Workflow Types - on the Edit Modal. -
fromDate- date - Optional (e.g, 01-Jan-2020) - Query Parameter -
toDate- date - Optional (e.g, 01-Jan-2020) - Query Parameter -
paginationParams:
{
Cursor: autmatically supplied in the NextPageLink of the Response object,
PageSize: optional. The MaxPageSize for this endpoint is 50
}
Response Model:
Contains an array of checklists.
Each Checklist record contains Items that represents an array of Questions/Responses
Example url:
https://api.peopletray.com/api/reporting/2321B899-0907-4D2F-9BDD-66D924E699DD/checklistdetails?workflowtypeid=db1c0af6-5891-475a-bba4-719ee21714b9&fromDate=1-Jan-2020
Example Response:
{
"totalRecords": 181,
"maxPageSize": 50,
"currentPageSize": 50,
"nextPageLink": "https://api-peopletray.azurewebsites.net/api/reporting/2321B899-0907-4D2F-9BDD-66D924E699DD/checklistdetails?workflowtypeid=db1c0af6-5891-475a-bba4-719ee21714b9&fromDate=1-Jan-2020&cursor=13617",
"nextCursor": 13617,
"data": [
{
"checklistInstanceId": 20349,
"checklistTemplateId": 104,
"companyId": 57,
"checklistTypeId": 1,
"workflowTypeId": "db1c0af6-5891-475a-bba4-719ee21714b9",
"name": "Prestart - simple",
"description": "Simple equipment prestart",
"personId": 3198,
"personName": "Bain Chloe",
"checklistDate": "2020-01-15T00:00:00",
"workflowInstanceId": 89329,
"workflowInitiationDate": "2020-01-15T13:05:24.497",
"entityChecklistId": 14856,
"equipmentTypeId": 1,
"equipmentId": 32,
"equipmentName": "A Holden 1",
"projectId": null,
"projectName": null,
"selectedPersonId": null,
"selectedPersonName": null,
"usageFieldLabel": "Kilometres",
"usage": 50000.00,
"isFail": true,
"workgroupId": 1104,
"workgroupName": "Head Office",
"isLeadIndicator": false,
"isTakeFive": false,
"isTakeFiveActSafe": false,
"isSuggestion": false,
"isPlod": false,
"workflowStatusTypeId": 1,
"hasImages": true,
"submittedAtLatitude": "-31.923665200000002",
"submittedAtLongitude": "115.85486399999999",
"corporateCompanyId": null,
"corporateCompanyName": null,
"contractorId": null,
"contractorName": null,
"isScoredChecklist": false,
"checklistScore": null,
"riskRegisterId": null,
"riskRegisterName": null,
"workflowProcessStepId": "6d84cdf5-ca0f-4d7f-ba65-b9e846c0c8fc",
"items": [
{
"checklistInstanceModelId": 12731,
"checklistItemId": 233784,
"pageSequence": 0,
"pageName": "Page 1",
"pageScore": 0.00,
"name": "Is the vehicle safe and in good condition?",
"description": null,
"sequence": 5,
"response": "No",
"responseTypeId": 2,
"comment": "Cracked windscreen.",
"level2Response": "",
"isFail": true,
"itemScore": 0.00,
"checklistPageItemTemplateId": null,
"checklistItemFiles": [],
"checklistItemPeopleModel": [],
"checklistItemEquipmentItemsModel": [],
"id": 141029,
"changedOn": "2020-01-15T05:12:59.727",
"changedBy": "tony24@miningpatch.com"
},
{
"checklistInstanceModelId": 12731,
"checklistItemId": 233786,
"pageSequence": 0,
"pageName": "Page 1",
"pageScore": 0.00,
"name": "Refuel - Diesal Litres",
"description": null,
"sequence": 2,
"response": "50.00",
"responseTypeId": 1,
"comment": null,
"level2Response": "",
"isFail": false,
"itemScore": 0.00,
"checklistPageItemTemplateId": null,
"checklistItemFiles": [],
"checklistItemPeopleModel": [],
"checklistItemEquipmentItemsModel": [],
"id": 141030,
"changedOn": "2020-01-15T05:12:59.727",
"changedBy": "tony24@miningpatch.com"
},
{
"checklistInstanceModelId": 12731,
"checklistItemId": 233785,
"pageSequence": 0,
"pageName": "Page 1",
"pageScore": 0.00,
"name": "Are you ok to drive?",
"description": null,
"sequence": 8,
"response": "Yes",
"responseTypeId": 2,
"comment": null,
"level2Response": "",
"isFail": false,
"itemScore": 0.00,
"checklistPageItemTemplateId": null,
"checklistItemFiles": [],
"checklistItemPeopleModel": [],
"checklistItemEquipmentItemsModel": [],
"id": 141031,
"changedOn": "2020-01-15T05:12:59.727",
"changedBy": "tony24@miningpatch.com"
}
],
"checklistCustomFieldValues": [],
"equipmentItems": [],
"id": 12731,
"changedOn": "2020-07-16T08:42:14.783",
"changedBy": "tony24@miningpatch.com_bulkupdate"
}
]
}