Get Checklist Responses for a WO
Once you have submitted or updated checklist responses for a work order, you can retrieve them via the API.
GET /workorders/{workOrderId}/checklists-responses
| Parameter | Parameter type | Example value |
|---|---|---|
| workOrderId | Path | 180088351 |
GET https://sb2api.servicechannel.com/v3//workorders/180088351/checklists-responses HTTP/1.1
Authorization: Bearer {access_token}
Example response
{
"Responses": [
{
"Pictures": [
{
"Id": 114012,
"CheckListResponseId": 1932333,
"DocumentName": "protective-gear.jpg",
"DocumentPath": "https://scitappsprod.blob.core.windows.net/workorders/02619396-ae81-471d-8a78-f80b4d805bad?sv=2019-02-02&sr=b&sig=78sIb7nh7s5%2BG9VjH8vdS5D5DJIklcPkesWF3O9YHmQ%3D&se=2021-06-07T15%3A04%3A23Z&sp=r",
"ThumbnailPath": "https://scitappsprod.blob.core.windows.net/workorders/21417c6f-83b0-4a50-90e9-b372c4a6b0f8?sv=2019-02-02&sr=b&sig=op43hX1cbgl22nvRbru%2Bpdbtp6disuvDm5dMeZUi84c%3D&se=2021-06-07T15%3A04%3A23Z&sp=r",
"HasThumbnail": true
}
],
"Question": {
"CheckListCreatedDate": "2021-06-01T17:01:45.92",
"CheckListName": "Outdoor Lighting Checklist",
"Id": 3834,
"CheckListId": 496,
"Question": "Are you wearing protective gear?",
"ShortDescription": null,
"AnswerRequired": false,
"PictureFlag": 2,
"Sequence": 0,
"QuestionType": 0,
"CheckListQuestionOptions": [],
"AnswerCanPersist": true,
"CheckListTimingType": null
},
"QuestionOption": {
"Id": 0,
"Answer": null,
"Sequence": 0,
"IsConditionalFollowUp": null
},
"Id": 1932333,
"Answer": "on",
"EntityId": 180088351,
"EntityTypeId": 0,
"Attempt": 1,
"ProviderId": 2000090505,
"TechnicianId": 371122,
"UpdatedDate": "2021-06-07T09:50:05.893",
"UpdatedDateStr": "Jun 07 2021 09:50",
"UpdatedDateDto": "2021-06-07T09:50:05.893-04:00",
"FreeTextAnswer": null
},
{
"Pictures": [],
"Question": {
"CheckListCreatedDate": "2021-06-01T17:01:45.92",
"CheckListName": "Outdoor Lighting Checklist",
"Id": 3835,
"CheckListId": 496,
"Question": "Are all entrance lights functioning properly?",
"ShortDescription": null,
"AnswerRequired": true,
"PictureFlag": 0,
"Sequence": 0,
"QuestionType": 1,
"CheckListQuestionOptions": [],
"AnswerCanPersist": false,
"CheckListTimingType": null
},
"QuestionOption": {
"Id": 4857,
"Answer": "No (please explain)",
"Sequence": 0,
"IsConditionalFollowUp": true
},
"Id": 1932655,
"Answer": "No (please explain)",
"EntityId": 180088351,
"EntityTypeId": 0,
"Attempt": 1,
"ProviderId": 2000090505,
"TechnicianId": 371122,
"UpdatedDate": "2021-06-07T10:20:48.073",
"UpdatedDateStr": "Jun 07 2021 10:20",
"UpdatedDateDto": "2021-06-07T10:20:48.073-04:00",
"FreeTextAnswer": "One light is blinking"
},
{
"Pictures": [],
"Question": {
"CheckListCreatedDate": "2021-06-01T17:01:45.92",
"CheckListName": "Outdoor Lighting Checklist",
"Id": 3836,
"CheckListId": 496,
"Question": "Please specify if you see any dark areas in the parking lot that could be a safety risk.",
"ShortDescription": null,
"AnswerRequired": false,
"PictureFlag": 1,
"Sequence": 0,
"QuestionType": 2,
"CheckListQuestionOptions": [],
"AnswerCanPersist": false,
"CheckListTimingType": null
},
"QuestionOption": {
"Id": 0,
"Answer": null,
"Sequence": 0,
"IsConditionalFollowUp": null
},
"Id": 1932663,
"Answer": "no dark areas",
"EntityId": 180088351,
"EntityTypeId": 0,
"Attempt": 1,
"ProviderId": 2000090505,
"TechnicianId": 371122,
"UpdatedDate": "2021-06-07T10:21:46.94",
"UpdatedDateStr": "Jun 07 2021 10:21",
"UpdatedDateDto": "2021-06-07T10:21:46.94-04:00",
"FreeTextAnswer": null
},
{
"Pictures": [
{
"Id": 114062,
"CheckListResponseId": 1932693,
"DocumentName": "light-bulbs.jpg",
"DocumentPath": "https://scitappsprod.blob.core.windows.net/workorders/dee30b9f-1cec-45f3-a47c-ad6f9c75b1dd?sv=2019-02-02&sr=b&sig=Cvlhpf5DRdpainx7LSrW4kz5PujG2nJY0HsQr5oaDSU%3D&se=2021-06-07T15%3A04%3A23Z&sp=r",
"ThumbnailPath": "https://scitappsprod.blob.core.windows.net/workorders/7f3cdd5c-b325-4927-a864-cb7f808f470d?sv=2019-02-02&sr=b&sig=hBuuP17btU58pGYmIRHI0h%2B7FHuhXbSRK7WvgXuLFOk%3D&se=2021-06-07T15%3A04%3A23Z&sp=r",
"HasThumbnail": true
}
],
"Question": {
"CheckListCreatedDate": "2021-06-01T17:01:45.92",
"CheckListName": "Outdoor Lighting Checklist",
"Id": 3837,
"CheckListId": 496,
"Question": "How many lights need repair or replacement?",
"ShortDescription": null,
"AnswerRequired": true,
"PictureFlag": 0,
"Sequence": 0,
"QuestionType": 4,
"CheckListQuestionOptions": [],
"AnswerCanPersist": false,
"CheckListTimingType": null
},
"QuestionOption": {
"Id": 0,
"Answer": null,
"Sequence": 0,
"IsConditionalFollowUp": null
},
"Id": 1932693,
"Answer": "2",
"EntityId": 180088351,
"EntityTypeId": 0,
"Attempt": 1,
"ProviderId": 2000090505,
"TechnicianId": 371122,
"UpdatedDate": "2021-06-07T10:32:05.84",
"UpdatedDateStr": "Jun 07 2021 10:32",
"UpdatedDateDto": "2021-06-07T10:32:05.84-04:00",
"FreeTextAnswer": null
}
]
}
Response code: HTTP/1.1 200 OK
This is how checklist responses appear on the Checklist tab of the work order details page in Service Automation.
To view the answers in the ServiceChannel Mobile app, go to the Check In/Out tab of the work order details screen, and then tap Completed Tasks.
Navigate to ServiceChannel University to learn more about viewing checklist answers.