ServiceChannel CheckLists API

The CheckLists API from ServiceChannel — 9 operation(s) for checklists.

OpenAPI Specification

servicechannel-checklists-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours CheckLists API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: CheckLists
paths:
  /checklists/CheckListResponse:
    post:
      tags:
      - CheckLists
      summary: Submit a response to a checklist question
      description: Creates a response to the specified checklist question. Learn more about [submitting checklist responses](/guides/checklists/submit-a-checklist-response/).
      operationId: POSTv3_checklists_CheckListResponse?version={version}
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: version
        in: query
        description: Version of the response object. The default value is V1. Specify V2 to receive the response object that contains a list of attachments instead of a single attachment.
        required: false
        type: string
        enum:
        - V1
        - V2
      - name: CheckListResponseRequest
        in: formData
        description: "Request to create a response to a checklist question. Retrieve checklist parameters using the [GET /checklists/detail](/swagger/ui/index?version=3#/CheckLists/GETv3_checklists_detail_tradeid__tradeid__checklistid__checklistid__categoryid__categoryid__subscriberId__subscriberId__tradeName__tradeName__checkListName__checkListName__categoryName__categoryName__locationId__locationId__storeId__storeId_) method to make sure you pass valid values.\r\n            <br />Pass the following parameters in the request:\r\n             • **CheckListQuestionId** *(Required)*: ID of the checklist question to submit a response for.\r\n             • **CheckListQuestionOptionIds**: List of the checklist question option Ids selected to a **Selector** type question where multiple options can be selected.\r\n             • **CheckListQuestionOptionId**: ID of the answer option configured for a checklist question of the **Selector** type.\r\n             • **ProviderId** *(Required)*: ID of the provider on whose behalf you are submitting a response.\r\n             • **TechnicianID**: ID of the technician on whose behalf you are submitting a response.\r\n             • **AuthUserId**: Single sign-on (SSO) ID of the technician on whose behalf you are submitting a response.\r\n             • **Answer**: Answer to a checklist question of the following types:\r\n              ◦ **Acknowledgement**. Valid values: `on`, `off`, `1`, `0`, `true`, `false`, `yes`, `no`.\r\n              ◦ **Text Entry**. Enter a text answer. The maximum length is 500 characters.\r\n              ◦ **Numeric Input**. Submit a number.\r\n             • **FreeTextAnswer**: Comment to an answer option with the `IsConditionalFollowUp` attribute. Answer options are configured for questions of the **Selector** type.\r\n             • **EntityId** *(Required)*: Unique ID of the work order for which you are creating a response to a checklist question.\r\n             • **Attempt** *(Required)*: Order of a technician’s on-site visit to submit a checklist response for.\r\n             • **Attachments**: List of pre-uploaded attachments to associate with the response. Upload files first via POST /checklists/ChecklistResponse/attachments and use the returned `DocumentPath`.\r\n              ◦ **DocumentName**: Name of the uploaded file.\r\n              ◦ **DocumentPath**: Storage path returned by the upload endpoint.\r\n            <br />**Example Object for the Acknowledgement Question**\r\n            \r\n                {\r\n                  \"CheckListQuestionID\": 3834,\r\n                  \"ProviderID\": 2000090505,\r\n                  \"TechnicianID\": 270592,\r\n                  \"AuthUserId\": 141,\r\n                  \"Answer\": \"on\",\r\n                  \"EntityID\": 179826000,\r\n                  \"Attempt\": 1,\r\n                  \"Attachments\": [\r\n                       {\r\n                           \"DocumentName\": \"test_att#1.jpg\",\r\n                           \"DocumentPath\": \"workorders/5ef9829b-5aec-4a3e-8c6d-c4a2b49a7317\"\r\n                        },\r\n                       {\r\n                           \"DocumentName\": \"test_att#2.jpg\",\r\n                           \"DocumentPath\": \"workorders/9gd1234b-8c6d-4a3e-5aec-c4a2b49a1234\"\r\n                        }\r\n                   ]\r\n                }"
        required: false
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.Checklists.ChecklistResponses.AddChecklistResponseRequest'
        type: application/json
      - name: file
        in: formData
        description: File to attach to the response to a checklist question. Required for questions with the `PictureFlag` parameter set to 2.
        required: false
        type: file
      responses:
        '201':
          description: 'For response version V1: A response to a checklist question is created. A checklist response object and an attachment object are returned.'
          schema:
            $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.CreateChecklistResponseWithPicture'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            502 — Work order is not found\r\n            503 — Bad request\r\n            503 — Not all required parameters were specified\r\n            503 — The FreeTextAnswer is required\r\n            503 — The picture is required\r\n            503 — Checkbox responses only support next values: on, off, 1, 0, true, false, yes, no\r\n            503 — The required URL view acknowledgement checkbox only supports the next values: on, 1, true, yes\r\n            503 - The answer is required!\r\n            503 — The Answer is invalid. It must be a number or a string representing a number\r\n            503 — Multiple answers are not allowed to a non-selector type question\r\n            503 — Multiple answer is not allowed to selector type question where AllowMultiSelect is disabled\r\n            503 — The active checklist with specified question (questionId: #) for the specified work order (workOrderId: #) is not found\r\n            503 — AssetIds are required for this checklist question\r\n            503 — There are no checklists for the specified work order. WorkOrderId: {#}\r\n            503 — Question (id: {#}) was not found.\r\n            503 — CheckListResponsePictureId (#) is not valid for CheckListResponse\r\n            503 — The CheckListQuestionId is not valid. An existing checklist response (id: {#}) was created for another question\r\n            503 — The CheckListQuestionOptionID is required\r\n            503 — The ChecklistQuestionOptionIds is required for the selector type question where AllowMultiSelect and AnswerRequired is enabled\r\n            503 — Question option (id: {#}) was not found\r\n            503 — Question option (id: {#}) is not valid for question (id: {#}))\r\n            503 — It is not allowed to use the ChecklistQuestionOptionId parameter and the ChecklistQuestionOptionIds parameter together. Use one of these parameters instead.\r\n            503 — The question has already been answered for this attempt number. QuestionId: {#}"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 — API call rejected by security permissions"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /checklists/{checkListResponseId}/CheckListResponse:
    put:
      tags:
      - CheckLists
      summary: Update a response to a checklist question
      description: '[Updates the specified response](/guides/checklists/update-a-checklist-response/) to a checklist question.'
      operationId: PUTv3_checklists_{checkListResponseId}_CheckListResponse?overrideAttachments={overrideAttachments}&version={version}
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: checkListResponseId
        in: path
        description: "ID of the response to a checklist question to update.\r\n            Pass the [GET /workorders/{workOrderId}/checklists-responses](/swagger/ui/index?version=3#/WorkOrders/GETv3_workorders__workOrderId__checklists_responses) request to retrieve the response ID."
        required: true
        type: integer
        format: int32
      - name: overrideAttachments
        in: query
        description: "Set to true to remove all existing attachments from the checklist response except for the attachment specified by the `CheckListResponsePictureId` parameter.\r\n            When the CheckListResponsePictureId parameter is not specified and this parameter is set to true, the method removes all existing attachments and adds the file provided in the file parameter to the checklist response.\r\n            When the CheckListResponsePictureId parameter is not specified and this parameter is set to false, the method keeps the existing attachments and adds the new file specified by the file parameter.\r\n            By default, this parameter is set to false."
        required: false
        type: boolean
        default: false
      - name: version
        in: query
        description: Version of the response object. The default value is V1. Specify V2 to receive the response object that contains a list of attachments instead of a single attachment.
        required: false
        type: string
        enum:
        - V1
        - V2
      - name: CheckListResponsePictureId
        in: formData
        description: "ID of the file attached to the checklist response to update.\r\n            Send the [GET /workorders/{workOrderId}/checklists-responses](/swagger/ui/index?version=3#/WorkOrders/GETv3_workorders__workOrderId__checklists_responses) request, and look for the required file `Id` within `Pictures` in the response."
        required: false
        type: text
      - name: CheckListResponseRequest
        in: formData
        description: "Request to update a response to a checklist question.\r\n            <br />Pass the following parameters in the request:\r\n             • **CheckListQuestionId** *(Required)*: ID of the checklist question to update a response for.\r\n             • **CheckListQuestionOptionIds**: List of the checklist question option Ids selected to a **Selector** type question where multiple options can be selected.\r\n             • **CheckListQuestionOptionId**: ID of the answer option configured for a checklist question of the **Selector** type.\r\n             • **ProviderId** *(Required)*: ID of the provider on whose behalf you are updating a response.\r\n             • **TechnicianID** *(Required)*: ID of the technician on whose behalf you are updating a response.\r\n             • **Answer**: Answer to a checklist question of the following types:\r\n              ◦ **Acknowledgement**. Valid values: `on`, `off`, `1`, `0`, `true`, `false`, `yes`, `no`.\r\n              ◦ **Text Entry**. Enter a text answer. The maximum length is 500 characters.\r\n              ◦ **Numeric Input**. Submit a number.\r\n             • **FreeTextAnswer**: Comment to an answer option with the `IsConditionalFollowUp` attribute. Answer options are configured for questions of the **Selector** type.\r\n             • **EntityId** *(Required)*: Unique ID of the work order for which you are updating a response to a checklist question.\r\n             • **Attempt** *(Required)*: Order of a technician’s on-site visit to update a checklist response for.\r\n              ◦ **Attachments** List of attachment information to be added to the checklist response.\r\n               ◦ **ChecklistResponsePictureId**. ID of the file attached to the checklist response to update. *Ignore this parameter to attach a new additional file to the checklist response.*\r\n               ◦ **DocumentName**. The name of the document.\r\n               ◦ **DocumentPath**. Document path in the storage.\r\n            <br />**Example Object for the Acknowledgement Question**\r\n            \r\n                {\r\n                  \"CheckListQuestionID\": 3834,\r\n                  \"ProviderID\": 2000090505,\r\n                  \"TechnicianID\": 270592,\r\n                  \"Answer\": \"off\",\r\n                  \"EntityID\": 179826000,\r\n                  \"Attempt\": 1,\r\n                  \"Attachments\": [\r\n                       {\r\n                           \"ChecklistResponsePictureId\": 5366060,\r\n                           \"DocumentName\": \"test_att#1.jpg\",\r\n                           \"DocumentPath\": \"workorders/5ef9829b-5aec-4a3e-8c6d-c4a2b49a7317\"\r\n                        },\r\n                       {\r\n                           \"DocumentName\": \"test_att#2.jpg\",\r\n                           \"DocumentPath\": \"workorders/9gd1234b-8c6d-4a3e-5aec-c4a2b49a1234\"\r\n                        }\r\n                   ]\r\n                }"
        required: false
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.Checklists.ChecklistResponses.UpdateChecklistResponseRequest'
        type: application/json
      - name: file
        in: formData
        description: File to attach to the response to a checklist question. Required for questions with the `PictureFlag` parameter set to 2.
        required: false
        type: file
      responses:
        '200':
          description: The specified response to a checklist question is updated. A checklist response object and an attachment object are returned.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.UpdateChecklistResponseWithPicture'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            502 — Work order is not found\r\n            503 — Bad request\r\n            503 — Not all required parameters were specified\r\n            503 — The FreeTextAnswer is required\r\n            503 — The picture is required\r\n            503 — Checkbox responses only support next values: on, off, 1, 0, true, false, yes, no\r\n            503 — The required URL view acknowledgement checkbox only supports the next values: on, 1, true, yes\r\n            503 - The answer is required!\r\n            503 — The Answer is invalid. It must be a number or a string representing a number\r\n            503 — The CheckListQuestionId is not valid. An existing checklist response (id: {#}) was created for another question\r\n            503 — The Attempt is not valid. An existing checklist response (id: {#}) was created for another attempt\r\n            503 — Multiple answers are not allowed to a non-selector type question\r\n            503 — Multiple answer is not allowed to selector type question where AllowMultiSelect is disabled\r\n            503 — The active checklist with specified question (questionId: #) for the specified work order (workOrderId: #) is not found\r\n            503 — AssetIds are required for this checklist question\r\n            503 — There are no checklists for the specified work order. WorkOrderId: {#}\r\n            503 — Question (id: {#}) was not found\r\n            503 — The CheckListQuestionOptionID is required\r\n            503 — The ChecklistQuestionOptionIds is required for the selector type question where AllowMultiSelect and AnswerRequired is enabled\r\n            503 — Question option (id: {#}) was not found\r\n            503 — Question option (id: {#}) is not valid for question (id: {#}))\r\n            503 — It is not allowed to use the ChecklistQuestionOptionId parameter and the ChecklistQuestionOptionIds parameter together. Use one of these parameters instead\r\n            503 — The Attempt is not valid. An existing checklist response (id: {№}) was created for another attempt\r\n            503 — The CheckListQuestionId is not valid. An existing checklist response (id: {0}) was created for another question.\r\n            503 — The question has already been answered for this attempt number. QuestionId: {#}"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 — API call rejected by security permissions"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /checklists/ChecklistResponse/get:
    post:
      tags:
      - CheckLists
      summary: Get a response to a checklist question
      operationId: POSTv3_checklists_ChecklistResponse_get?workOrderId={workOrderId}
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: query
        description: The work order identifier *(Required)*
        required: true
        type: integer
        format: int32
      - name: checklistResponseIds
        in: body
        description: List of checklist response identifiers to retrieve *(Required)*
        required: true
        schema:
          type: array
          items:
            format: int32
            type: integer
      responses:
        '200':
          description: The specified responses to a checklist questions are returned.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.ChecklistResponseWithPictures'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            503 - Bad request"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 — API call rejected by security permissions"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /checklists/ChecklistResponse/attachments:
    post:
      tags:
      - CheckLists
      summary: Upload a checklist response attachment to the storage
      operationId: POSTv3_checklists_ChecklistResponse_attachments
      consumes:
      - multipart/form-data
      produces:
      - application/json
      - text/json
      parameters:
      - name: file
        in: formData
        description: File to attach to the response to a checklist question.
        required: false
        type: file
      responses:
        '200':
          description: File successfully uploaded to storage. The document path is returned in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.Checklists.ChecklistResponses.UploadedAttachmentResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            503 - Bad request,\r\n            503 - No checklist response attachment to upload."
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 — API call rejected by security permissions"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /checklists/ChecklistResponse/bulk:
    put:
      tags:
      - CheckLists
      summary: Update a responses to a checklist question in bulk
      operationId: PUTv3_checklists_ChecklistResponse_bulk
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: "Request to update responses to checklist questions in bulk.\r\n            <br />Pass the following parameters in the request:\r\n             • **ChecklistResponseIds** *(Required)*: List of checklist response identifiers to update.\r\n             • **ChecklistResponseRequest** *(Required)*: Request to update a response to a checklist question.\r\n              ◦ **CheckListQuestionId** *(Required)*: ID of the checklist question to update a response for.\r\n              ◦ **CheckListQuestionOptionIds**: List of the checklist question option Ids selected to a **Selector** type question where multiple options can be selected.\r\n              ◦ **CheckListQuestionOptionId**: ID of the answer option configured for a checklist question of the **Selector** type.\r\n              ◦ **ProviderId** *(Required)*: ID of the provider on whose behalf you are updating a response.\r\n              ◦ **TechnicianID** *(Required)*: ID of the technician on whose behalf you are updating a response.\r\n              ◦ **Answer**: Answer to a checklist question of the following types:\r\n               ◦ *Acknowledgement*. Valid values: `on`, `off`, `1`, `0`, `true`, `false`, `yes`, `no`.\r\n               ◦ *Text Entry*. Enter a text answer. The maximum length is 500 characters.\r\n               ◦ *Numeric Input*. Submit a number.\r\n              ◦ **FreeTextAnswer**: Comment to an answer option with the `IsConditionalFollowUp` attribute. Answer options are configured for questions of the **Selector** type.\r\n              ◦ **EntityId** *(Required)*: Unique ID of the work order for which you are updating a response to a checklist question.\r\n              ◦ **Attempt** *(Required)*: Order of a technician’s on-site visit to update a checklist response for.\r\n              ◦ **Attachments** List of attachment information to be added to the checklist response.\r\n               ◦ **ChecklistResponsePictureId**. ID of the file attached to the checklist response to update. *Ignore this parameter to attach a new additional file to the checklist response.*\r\n               ◦ **DocumentName**. The name of the document.\r\n               ◦ **DocumentPath**. Document path in the storage.\r\n              ◦ **OverrideAttachments**: Set to true to remove all existing attachments from the checklist response except for the attachment specified by the `CheckListResponsePictureId` parameter."
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.Checklists.ChecklistResponses.UpdateBulkChecklistResponseRequest'
      responses:
        '200':
          description: The specified response to a checklist question is updated.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            502 — Work order is not found\r\n            503 — Bad request\r\n            503 — Not all required parameters were specified\r\n            503 — The FreeTextAnswer is required\r\n            503 — The picture is required\r\n            503 — Checkbox responses only support next values: on, off, 1, 0, true, false, yes, no\r\n            503 — The required URL view acknowledgement checkbox only supports the next values: on, 1, true, yes\r\n            503 — Multiple answers are not allowed to a non-selector type question.\r\n            503 — Multiple answer is not allowed to selector type question where AllowMultiSelect is disabled\r\n            503 — The active checklist with specified question (questionId: #) for the specified work order (workOrderId: #) is not found\r\n            503 — Asset ids are not allowed for the checklist which is not displayed for each asset\r\n            503 — AssetIds are required for this checklist question\r\n            503 — Not all assets are associated with the work order. Assets not associated with the work order: {#}\r\n            503 — Assets not found (asset ids: {#})\r\n            503 — Not all types of specified assets match the asset types specified for the checklist question. Assets with wrong types: {#}\r\n            503 — There are no checklists for the specified work order. WorkOrderId: {#}\r\n            503 — Question (id: {#}) was not found.\r\n            503 — CheckListResponsePictureId (#) is not valid for CheckListResponse\r\n            503 — The EntityId is not valid. An existing checklist response (id: {#}) was created for another work order\r\n            503 — The Attempt is not valid. An existing checklist response (id: {#}) was created for another attempt\r\n            503 — The CheckListQuestionId is not valid. An existing checklist response (id: {#}) was created for another question\r\n            503 — CheckListResponsePictureId is not valid for CheckListResponse. Invalid Attachment Ids: {#}\r\n            503 — Checklist response ids are required\r\n            503 — The Answer is invalid. It must be a number or a string representing a number.\r\n            503 — The question has already been answered for this attempt number. QuestionId: {#}"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "The request is not authorized.\r\n            <br/>Error codes:\r\n            504 — API call rejected by security permissions"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: The server was unable to complete the request due to an internal error.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    post:
      tags:
      - CheckLists
      summary: Submit checklist responses in bulk
      operationId: POSTv3_checklists_ChecklistResponse_bulk
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: requests
        in: body
        description: "List of checklist responses to submit in bulk.\r\n            <br />Pass the following parameters in the request:\r\n             • **AssetIds** *(Required)*: List of asset identifiers to associate with the checklist responses.\r\n             • **Attachments**: List of attachment information to be added to the checklist responses.\r\n              ◦ **DocumentName**. The name of the document.\r\n              ◦ **DocumentPath**. Document path in the storage.\r\n             • **CheckListResponseRequest** *(Required)*: Request to submit a response to a checklist question.\r\n               ◦ **CheckListQuestionId** *(Required)*: ID of the checklist question to update a response for.\r\n               ◦ **CheckListQuestionOptionIds**: List of the checklist question option Ids selected to a **Selector** type question where multiple options can be selected.\r\n               ◦ **CheckListQuestionOptionId**: ID of the answer option configured for a checklist question of the **Selector** type.\r\n               ◦ **ProviderId** *(Required)*: ID of the provider on whose behalf you are updating a response.\r\n               ◦ **TechnicianID** *(Required)*: ID of the technician on whose behalf you are updating a response.\r\n               ◦ **Answer**: Answer to a checklist question of the following types:\r\n                ◦ *Acknowledgement*. Valid values: `on`, `off`, `1`, `0`, `true`, `false`, `yes`, `no`.\r\n                ◦ *Text Entry*. Enter a text answer. The maximum length is 500 characters.\r\n                ◦ *Numeric Input*. Submit a number.\r\n               ◦ **FreeTextAnswer**: Comment to an answer option with the `IsConditionalFollowUp` attribute. Answer options are configured for questions of the **Selector** type.\r\n               ◦ **EntityId** *(Required)*: Unique ID of the work order for which you are updating a response to a checklist question.\r\n               ◦ **Attempt** *(Required)*: Order of a technician’s on-site visit to update a checklist response for."
        required: true
        schema:
          type: array
          items:
            $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.Checklists.ChecklistResponses.CreateBulkChecklistResponseRequest'
      responses:
        '201':
          description: Responses to a checklist question are created. List of checklist response identifiers is returned.
          schema:
            type: array
            items:
              format: int32
              type: integer
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            502 — Work order is not found\r\n            503 — Not all required parameters were specified\r\n            503 — The FreeTextAnswer is required\r\n            503 — The picture is required\r\n            503 — Checkbox responses only support next values: on, off, 1, 0, true, false, yes, no\r\n            503 — The required URL view acknowledgement checkbox only supports the next values: on, 1, true, yes\r\n            503 — Multiple answers are not allowed to a non-selector type question.\r\n            503 — Multiple answer is not allowed to selector type question where AllowMultiSelect is disabled\r\n            503 — The active checklist with specified question (questionId: #) for the specified work order (workOrderId: #) is not found\r\n            503 — Asset ids are not allowed for the checklist which is not displayed for each asset\r\n            503 — AssetIds are required for this checklist question\r\n            503 — Not all assets are associated with the work order. Assets not associated with the work order: {#}\r\n            503 — Assets not found (asset ids: {#})\r\n            503 — Not all types of specified assets match the asset types specified for the checklist question. Assets with wrong types: {#}\r\n            503 — There are no checklists for the specified work order. WorkOrderId: {#}\r\n            503 — Question (id: {#}) was not found\r\n            503 — Checklist responses should be specified for the same work order\r\n            503 — Checklist responses should be specified for the same attempt.\r\n            503 — The Answer is invalid. It must be a number or a string representing a number\r\n            503 — The question has already been answered for this attempt number. QuestionId: {#}."
      

# --- truncated at 32 KB (142 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-checklists-api-openapi.yml