--- title: "Get checklist responses for a work order" method: GET path: "/workorders/{workOrderId}/checklists-responses" tags: ["WorkOrders"] --- # Get checklist responses for a work order `GET /workorders/{workOrderId}/checklists-responses` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/workorders/{workOrderId}/checklists-responses` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) [Returns checklist responses](/guides/checklists/get-checklist-responses-for-a-wo/) submitted for the specified work order. ## Path parameters - `workOrderId` integer, required ## Query parameters - `getAll` boolean ## Response `200` Checklist responses for the specified work order are returned. - ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesGetResponsesByWorkOrderResponse: Object for checklist responses submitted for a work order. - `Responses` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesCheckListResponseExtended[]: Responses to checklist questions submitted for a work order. - `Pictures` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistPictureResponse[]: Files attached to the checklist response. - `Id` integer: ID of the file attached to the checklist response. - `CheckListResponseId` integer: ID of the checklist response the attachment is submitted for. - `DocumentName` string: Attachment name. - `DocumentPath` string: Attachment path. - `ThumbnailPath` string: Attachment thumbnail path. - `HasThumbnail` boolean: Defines whether a thumbnail is available for the attachment. - `UpdatedBy` integer: User Id. - `Question` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesCheckListDetailQuestionsExtendedResponse: Checklist question details. - `CheckListCreatedDate` string, date-time: Date and time when the checklist was created. - `CheckListName` string: Name of the checklist the question belongs to. - `Id` integer: Checklist question ID. - `CheckListId` integer: ID of the checklist the question belongs to. - `Question` string: Checklist question that a technician is prompted to answer when working on a service request. - `ShortDescription` string: Not applicable to checklists. - `AnswerRequired` boolean: Defines whether answering this checklist question is mandatory. - `PictureFlag` 'Optional' | 'No' | 'Required': Defines whether a technician is required to upload an attachment when answering the question: • 0 — Adding an attachment is optional. • 1 — An attachment is not required. • 2 — Uploading an attachment is mandatory. - `Sequence` integer: Not applicable to checklists. - `QuestionType` 'CheckBox' | 'RadioButton' | 'TextEntry' | 'TriState' | 'NumericInput': [Checklist question type](/guides/checklists/types-of-checklist-questions/): • 0 — **Acknowledgement**: Represents an on/off toggle prompting a technician to give a positive or negative response to a question. • 1 — **Selector**: Provides multiple configured answer options to choose from. • 2 — **Text Entry**: Allows entering a text answer. • 4 — **Numeric Input**: Prompts to submit a number as a response. - `CheckListQuestionOptions` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistQuestionOptionResponse[]: Answer options for questions of the Selector type. - `Id` integer: ID of the answer option for a checklist question of the **Selector** type. - `Answer` string: Answer option for a checklist question of the **Selector** type. A technician can select from a list of configured options when answering the question. - `Sequence` integer: Not applicable to checklists. - `IsConditionalFollowUp` boolean: Defines whether a technician is prompted to add a comment to the selected answer option. A comment is mandatory if answering the checklist question is required. - `ResponseResultInFailure` boolean: Option for a checklist question of the **Selector** type. - `AnswerCanPersist` boolean: Defines whether the answer to this question can persist. If the answer is persistent, the last submitted response populates on the question. A technician can either opt for the current response or update it. - `CheckListTimingType` 'CheckIn' | 'CheckOut': Defines the checklist segment the question belongs to: 1 — check-in segment, 2 — check-out segment. - `AcknowledgeUrl` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesCheckListAcknowledgeUrlResponse - `Url` string - `Required` boolean - `AllowMultiSelect` boolean: AllowMultiSelect - `ChecklistFailure` boolean: ChecklistFailure - `AssetTypeIds` integer[]: Asset type IDs that the question is applicable to - `ChecklistQuestionNumericType` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistQuestionNumericType: The object defines the failure criteria used to evaluate answers for the **Numeric Input** question - `Id` integer: ID of the failure criteria object. - `Type` 'LessThan' | 'MoreThan' | 'InBetween': Defines the type of failure criteria used to evaluate the response to a question. - `SingleValue` integer: The threshold value used to evaluate the answer to a question for the LessThan or MoreThan criterion. - `MinValue` integer: The lower threshold value used to evaluate the response to the question for the InBetween criterion. - `MaxValue` integer: The upper threshold value used to evaluate a question's response to the InBetween criterion. - `QuestionOptions` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistQuestionOptionResponse[]: List of the answer options configured for a checklist question of the **Selector** type where multiple options can be selected. - `Id` integer: ID of the answer option for a checklist question of the **Selector** type. - `Answer` string: Answer option for a checklist question of the **Selector** type. A technician can select from a list of configured options when answering the question. - `Sequence` integer: Not applicable to checklists. - `IsConditionalFollowUp` boolean: Defines whether a technician is prompted to add a comment to the selected answer option. A comment is mandatory if answering the checklist question is required. - `ResponseResultInFailure` boolean: Option for a checklist question of the **Selector** type. - `QuestionOption` ServiceChannelServicesWebApiModelsResponseChecklistsChecklistResponsesChecklistQuestionOptionResponse: Answer option configured for a checklist question of the **Selector** type. - `Id` integer: ID of the answer option for a checklist question of the **Selector** type. - `Answer` string: Answer option for a checklist question of the **Selector** type. A technician can select from a list of configured options when answering the question. - `Sequence` integer: Not applicable to checklists. - `IsConditionalFollowUp` boolean: Defines whether a technician is prompted to add a comment to the selected answer option. A comment is mandatory if answering the checklist question is required. - `ResponseResultInFailure` boolean: Option for a checklist question of the **Selector** type. - `IsCurrentChecklist` boolean: Is current checklist flag. - `IsFrequencyChecklist` boolean: Is PM frequency checklist flag. - `CreatedBy` integer: ID of the user on whose behalf the response was submitted. - `AssetId` integer: ID of the asset for which the response was submitted. - `Id` integer: Checklist response ID. - `Answer` string: Answer to a checklist question. - `FreeTextAnswer` string: Comment to an answer option with the `IsConditionalFollowUp` attribute. Answer options are configured for questions of the **Selector** type. - `EntityId` integer: ID of the work order the response was submitted for. - `EntityTypeId` integer: ID of the entity the response was submitted for. 0 is returned for work orders. - `Attempt` integer: Order of a technician’s on-site visit when the response was submitted. - `ProviderId` integer: ID of the provider on whose behalf the response was submitted. - `TechnicianId` integer: ID of the technician on whose behalf the response was submitted. - `UpdatedDate` string, date-time: Date and time when the response was last updated set in EST. The format is `YYYY-MM-DDThh:mm:ss.sss`. - `UpdatedDateStr` string: Date and time when the response was last updated set in the location’s time zone. The format is `Month Day Year hh:mm`. - `UpdatedDateDto` string, date-time: Date and time when the response was last updated set in the location’s time zone with the UTC offset. The format is `YYYY-MM-DDThh:mm:ss.sss±hh:mm`. - `IsPassed` boolean: Indicates whether the response avoids the failure criteria. - `LinkedWorkOrderId` integer: ID of the linked work order if the response results in a failure and generates a linked work order. Null if the response does not result in a failure or if the failure does not generate a linked work order. ## Other responses - `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
Error codes: 502 — Work order is not found - `401`: The request is not authorized.
Error codes: 504 — API call rejected by security permissions - `500`: The server was unable to complete the request due to an internal error. --- [API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)