ServiceChannel WorkOrders API

The WorkOrders API from ServiceChannel — 70 operation(s) for workorders.

OpenAPI Specification

servicechannel-workorders-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours WorkOrders API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: WorkOrders
paths:
  /workorders:
    get:
      tags:
      - WorkOrders
      summary: Search Work Orders
      description: "Performs search of workorders by specified filter expression and returns list of work orders with all details.\r\n            <br />One page contains 50 items by default (\"pageSize\"=50). To get next 50 items use the \"page\" parameter (for example page=2 and so on)."
      operationId: GETv3_workorders?locationId={locationId}&storeId={storeId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: locationId
        in: query
        description: UID of location.
        required: false
        type: integer
        format: int32
      - name: storeId
        in: query
        description: StoreId of location. Used to find location for which search will be performed. Applicable to subscribers only.
        required: false
        type: string
      - name: otherLocationId
        in: query
        description: UID of location, exact search by default
        required: false
        type: array
        items: {}
      - name: id
        in: query
        description: UID of work order, exact search by default
        required: false
        type: array
        items: {}
      - name: category
        in: query
        description: Category of work order, exact search by default
        required: false
        type: array
        items: {}
      - name: categoryId
        in: query
        description: CategoryId, ID of categories to return work orders for
        required: false
        type: array
        items: {}
      - name: status
        in: query
        description: Status of work order, exact search by default
        required: false
        type: array
        items: {}
      - name: extendedStatus
        in: query
        description: Extended status of work order, exact search by default
        required: false
        type: array
        items: {}
      - name: number
        in: query
        description: Work order number, 'starts with' search criteria by default
        required: false
        type: array
        items: {}
      - name: serviceId
        in: query
        description: '''starts with'' search criteria by default'
        required: false
        type: array
        items: {}
      - name: priority
        in: query
        description: Priority of work order, exact search by default
        required: false
        type: array
        items: {}
      - name: purchaseNumber
        in: query
        description: Purchase number of work order, 'starts with' search criteria by default
        required: false
        type: array
        items: {}
      - name: trade
        in: query
        description: Trade, 'starts with' search criteria by default
        required: false
        type: array
        items: {}
      - name: tradeId
        in: query
        description: TradeId, ID of trades to return work orders for
        required: false
        type: array
        items: {}
      - name: scheduledDate
        in: query
        description: Scheduled date
        required: false
        type: array
        items: {}
      - name: expirationDate
        in: query
        description: Expiration date
        required: false
        type: array
        items: {}
      - name: callDate
        in: query
        description: Call date
        required: false
        type: array
        items: {}
      - name: sort
        in: query
        description: Sort resources by the specified property in the response.
        required: false
        type: string
      - name: page
        in: query
        description: Results page number.
        required: false
        type: integer
        format: int32
      - name: pageSize
        in: query
        description: Number of objects on the results page. The default and maximum per page is 50.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Request succeeded and the requested information is in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.WorkOrder.GetWorkOrdersResponse.WorkOrder'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 403 - Account has not been activated for GPS use;\r\n            <br/> 503 - Validation fails. Request is empty or null;\r\n            <br/> 601 - Location Id is invalid;\r\n            <br/> 606 - Cannot find location by StoreId;\r\n            <br/> 1000 - Invalid Setup Id;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions; "
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "Indicates that a generic error has occurred on the server.\r\n            <br/>Error codes:\r\n            <br/> 501 - Timeout expired. The timeout period elapsed prior to completion of the operation or the server is not responding."
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    post:
      tags:
      - WorkOrders
      summary: Create a Work order
      description: "Creates a new Work order. Returns Work order Id for successful request.\r\n            <br />Available for provider and subscriber usage.\r\n            <br />Additional info:\r\n            <br />Updates GL code based on passed Category param according to settings in Admin module {go to Admin =&gt; Accounting =&gt; GlCodes to see user GL codes}.\r\n            Similar logic is used when you create Work order through next path: Dashboard =&gt; Request Service."
      operationId: POSTv3_workorders
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: A new Work order
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.CreateWoRequest'
      responses:
        '201':
          description: Created indicates that the request resulted in a new resource created before the response was sent.
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 100 - No provider was found for specified location and trade;\r\n            <br/> 300 - Missed contract data;\r\n            <br/> 301 - Contract not found for specified subscribers location, provider and trade;\r\n            <br/> 400 - Invalid Subscriber Id specified;\r\n            <br/> 503 - Work order cannot be created, provider could not be determined (missing providerID or IssueRequestInfo);\r\n            <br/> 600 - Invalid Location Id specified;\r\n            <br/> 603 - Subscriber has no specified Location;\r\n            <br/> 700 - Invalid Trade Name specified;\r\n            <br/> 702 - Subscriber has no specified Trade;\r\n            <br/> 800 - Missed required argument 'UserId';\r\n            <br/> 801 - Missed required argument 'CreatedBy';\r\n            <br/> 900 - Missed problem description options;\r\n            <br/> 901 - Missed required argument 'ProblemSource';\r\n            <br/> 902 - Missed required argument 'Description';\r\n            <br/> 903 - Missed required argument 'ProblemCode';\r\n            <br/> 904 - Invalid WorkOrder status;\r\n            <br/> 905 - Invalid 'Nte' value;\r\n            <br/> 906 - Invalid 'CallerName' value;\r\n            <br/> 907 - Invalid 'CallDate' value;\r\n            <br/> 908 - Invalid 'ScheduledDate' value;\r\n            <br/> 909 - Invalid 'ScheduledDate', greater than max allowed by subscriber;\r\n            <br/> 910 - Missed required argument 'Category';\r\n            <br/> 911 - Invalid 'Category';\r\n            <br/> 912 - Missed required argument 'Priority';\r\n            <br/> 913 - Invalid 'Priority';\r\n            <br/> 914 - Invalid 'Currency' value;\r\n            <br/> 915 - Invalid Setup Id;\r\n            <br/> 916 - At least one attachment required to create this WorkOrder;\r\n            <br/> 918 - Assets required to create this WorkOrder;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: "Indicates that a generic error has occurred on the server.\r\n            <br/>Error codes:\r\n            <br/> 501 - Sequence contains no elements"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/status:
    put:
      tags:
      - WorkOrders
      summary: Update a Work order Status
      description: "Updates Work Order status with optional Note. Returns Work order Id for successful request.\r\n            <br /><br />This method can only be used for users with 'WorkOrderStatusChange' permissions.\r\n            Available for provider and subscriber usage."
      operationId: PUTv3_workorders_{workorderId}_status
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: updateRequestExt
        in: body
        description: The update request. Work order Status.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoStatusRequestExt'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderStatusResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 100 - You don't have location access to perform this operation;\r\n            <br/> User has no permissions to perform this action;\r\n            <br/> 502 - WorkOrder not found;\r\n            <br/> 503 - Request data is empty; User data not found;\r\n            <br/> 904 - Invalid WorkOrder status;\r\n            <br/> User has no permission to set selected status;\r\n            <br/> 921 - Cannot update invoiced Work order;\r\n            <br/> 9001 - Decline reason id is required;\r\n            <br/> 9002 - This decline reason doesn't allow custom text"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/priority:
    put:
      tags:
      - WorkOrders
      summary: Update Work order Priority
      description: "Updates Work Order priority. Returns Work order Id for successful request.\r\n            <br /><br />This method can only be used for users with 'WorkOrderFullEdit' permissions."
      operationId: PUTv3_workorders_{workorderId}_priority
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: The update request. Work order Priority.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoFieldsRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 100 - You don't have location access to perform this operation;\r\n            <br/> 502 - Data not found. Returned if target Work order is not found database;\r\n            <br/> 503 - Request data is empty;\r\n            <br/> 913 - Priority isn't found in user settings;\r\n            <br/> Priority length cannot be longer then 100 or shorter then 1 characters;\r\n            <br/> 921 - Cannot update invoiced Work order;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/category:
    put:
      tags:
      - WorkOrders
      summary: Update the work order category
      description: "Updates the category of the specified work order (WO) with the passed value. Note that you cannot update the category of an invoiced service request.\r\n            <br />If the WO category does not have a GL code mapping with the WO trade, you will get an error message listing valid categories for this trade based on existing GL codes. You can retrieve valid categories for a specific trade by sending the [GET /categories/glcodes](/swagger/ui/index?version=3#/Categories/GETv3_categories_glcodes_locationId__locationId__trade__trade_) request.\r\n            <br />***Note:*** Only users who have permission to edit work orders can use this method.\r\n            <br />**Example Request**\r\n            \r\n                PUT /workorders/{workorderId}/category\r\n                {\r\n                   \"Value\": \"Repair\",\r\n                   \"Actor\": \"James Smith\",\r\n                   \"Id\": 12345\r\n                }"
      operationId: PUTv3_workorders_{workorderId}_category
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Unique numeric identifier of the work order you want to update the category for.
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: Request to update the work order category.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoCategoryRequest'
      responses:
        '200':
          description: The category of the specified work order is updated, and the unique work order ID is returned in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            100 — User has no rights to perform this action\r\n            502 — Work order is not found\r\n            921 — Cannot update invoiced work order"
          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
  /workorders/{workorderId}/nte:
    put:
      tags:
      - WorkOrders
      summary: Update Work order NTE
      description: "Updates Work Order NTE. Returns Work order Id for successful request.\r\n            <br /><br />This method can only be used for users with 'WorkOrderFullEdit' permissions."
      operationId: PUTv3_workorders_{workorderId}_nte
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: The update request. Work order NTE.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoNteRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n        \t<br/>Error codes:\r\n        \t<br/> 100 - You don't have location access to perform this operation;\r\n        \t<br/> 502 - Data not found. Returned if target Work order is not found database;\r\n        \t<br/> 503 - Request data is empty;\r\n        \t<br/> 905 - Invalid Work order NTE specified. Returned if nte exceeds user limit or its value is not a number;\r\n        \t<br/> 921 - Cannot update invoiced Work order;\r\n        \t<br/> 931 - NTE cannot be adjusted, please use subtotal and tax;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workOrderId}/projectApproval:
    put:
      tags:
      - WorkOrders
      summary: Update Work orders NTE project approval
      description: "Update Work orders NTE project approval. Returns successfully updated id.\r\n            <br /><br />This method can only be used for users with 'WorkOrderFullEdit' permissions."
      operationId: PUTv3_workorders_{workOrderId}_projectApproval
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: The update request. Work orders NTE/Link project approval.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.UpdateWorkOrdersProjectApprovalRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n        \t<br/>Error codes:\r\n        \t<br/> 100 - You don't have location access to perform this operation;\r\n        \t<br/> 502 - Data not found. Returned if target Work order is not found database;\r\n        \t<br/> 503 - Request data is empty;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
    post:
      tags:
      - WorkOrders
      summary: Create Work orders project approval
      description: "Create Work orders project approval. Returns successfully updated id.\r\n            <br /><br />This method can only be used for users with 'WorkOrderFullEdit' permissions."
      operationId: POSTv3_workorders_{workOrderId}_projectApproval
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: createRequest
        in: body
        description: The create request. Work orders project approval.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.CreateWorkOrdersProjectApprovalRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n        \t<br/>Error codes:\r\n        \t<br/> 100 - You don't have location access to perform this operation;\r\n        \t<br/> 502 - Data not found. Returned if target Work order is not found database;\r\n        \t<br/> 503 - Request data is empty;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/scheduledate:
    put:
      tags:
      - WorkOrders
      summary: Update Work order Scheduled Date
      description: "Updates Work Order Scheduled Date. Returns Work order Id for successful request.\r\n            <br /><br />Available for provider and subscriber usage.\r\n            This method can only be used for users with 'WorkOrderScheduledDateChange' permissions."
      operationId: PUTv3_workorders_{workorderId}_scheduledate?rescheduleReasonCode={rescheduleReasonCode}
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: The update request. Work order Scheduled Date.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoFieldsRequest'
      - name: rescheduleReasonCode
        in: query
        description: Numeric reschedule reason code. Optional.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 100 - You don't have location access to perform this operation;\r\n            <br/> 502 - Data not found. Returned if target Work order is not found database;\r\n            <br/> 503 - Request data is empty;\r\n            <br/> 908 - Invalid Work order scheduled date specified. Returned if invalid date format was specified,\r\n            scheduled date is smaller then Work order CallDate or bigger then Work order ExpirationDate;\r\n            <br/> 921 - Cannot update invoiced Work order;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/description:
    put:
      tags:
      - WorkOrders
      summary: Update Work order Description
      description: "Updates Work Order Description. Returns Work order Id for successful request.\r\n            <br /><br />This method can only be used for users with 'WorkOrderFullEdit' permissions."
      operationId: PUTv3_workorders_{workorderId}_description
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: Numeric Id of the Work order to perform action with.
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: The update request. Work order Description.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoFieldsRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 100 - You don't have location access to perform this operation;\r\n            <br/> 502 - Data not found. Returned if target Work order is not found database;\r\n            <br/> 503 - Request data is empty;\r\n            <br/> 902 - Invalid Work order Problem Description specified. Returned if description exceeds max len (8000 chars) or is empty;\r\n            <br/> 921 - Cannot update invoiced Work order;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/trade:
    put:
      tags:
      - WorkOrders
      summary: Change Work order Trade
      operationId: PUTv3_workorders_{workorderId}_trade
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workorderId
        in: path
        description: ''
        required: true
        type: integer
        format: int32
      - name: updateRequest
        in: body
        description: ''
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWoFieldsRequest'
      responses:
        '200':
          description: Indicates that the request succeeded and that the requested information is in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Workorders.ChangeWorkOrderResponse'
        '400':
          description: "Bad Request - the request could not be understood or was missing required parameters.\r\n            <br/>Error codes:\r\n            <br/> 100 - You don't have location access to perform this operation;\r\n            <br/> 502 - Data not found. Returned if target Work order is not found database;\r\n            <br/> 503 - Request data is empty;\r\n            <br/> 921 - Cannot update invoiced Work order;\r\n            <br/> 934 - Invalid Work order Trade specified. Returned if trade exceeds max len (50 chars) or is empty"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '401':
          description: "Indicates that the requested resource requires authentication.\r\n            <br/>Error codes:\r\n            <br/> 504 - API call rejected by security permissions;"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '500':
          description: Indicates that a generic error has occurred on the server.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
      deprecated: false
      x-access: Any
  /workorders/{workorderId}/resolution:
    post:
      tags:
      - WorkOrders
      summary: Add Work order Resolution
      description: Adds Resolution to Work order. Returns Resolution Id for successful request.
      operationId: POSTv3_workorders_{workorderId}_resolution
      consumes:
      - application/json
      - text/json
      produces:
      - application/jso

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