ServiceChannel ResolutionCodes API

The ResolutionCodes API from ServiceChannel — 5 operation(s) for resolutioncodes.

OpenAPI Specification

servicechannel-resolutioncodes-api-openapi.yml Raw ↑
swagger: '2.0'
info:
  version: bearer.v1
  title: Fixxbook.Bearer.Api.V1 AfterHours ResolutionCodes API
  isOdataApi: false
  relativePath: ''
  discoveryPath: docs/bearer.v1
  _isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: ResolutionCodes
paths:
  /resolutionCodes:
    get:
      tags:
      - ResolutionCodes
      summary: Get resolution codes
      description: Returns a list of resolution codes. Resolution codes are set up for trades and describe actions that a technician takes to resolve a problem upon working on a service request.
      operationId: GETv3_resolutionCodes
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: subscriberId
        in: query
        description: Unique subscriber identifier.
        required: true
        type: integer
        format: int32
      - name: trade
        in: query
        description: "Trade to return resolution codes for. A trade is an area of work for which a service is performed, such as _HVAC_, _Refrigeration_, or _Plumbing_.\r\n            <b>The value of this or the TradeId attribute is required.</b>\r\n            Parameter is obsolete. Please use <b>TradeId</b> instead"
        required: false
        type: string
      - name: category
        in: query
        description: "Category to return resolution codes for. A category is the overall classification of a work order, such as _Maintenance_, _Repair_, or _CAPEX_.\r\n            <b>The value of this or the CategoryId attribute is required.</b>\r\n            Parameter is obsolete. Please use <b>CategoryId</b> instead"
        required: false
        type: string
      - name: locationId
        in: query
        description: Unique identifier of a subscriber’s location.
        required: true
        type: integer
        format: int32
      - name: providerId
        in: query
        description: Unique provider identifier. Should be passed by subscriber users.
        required: false
        type: integer
        format: int32
      - name: assetCategoryIds
        in: query
        description: IDs of asset categories to return resolution codes for. You can specify up to 5 asset categories if you have access to this functionality.
        required: false
        type: array
        items:
          type: integer
          format: int32
      - name: keyword
        in: query
        description: Keyword contained in resolution codes to perform the search by.
        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 is 10.
        required: false
        type: integer
        format: int32
      - name: tradeId
        in: query
        description: "TradeId to return resolution codes for. If 'tradeId' is passed, 'trade' parameter is ignored\r\n            <b>The value of this or the Trade attribute is required.</b>"
        required: false
        type: integer
        format: int32
      - name: categoryId
        in: query
        description: "CategoryId to return resolution codes for. If 'categoryId' is passed, 'category' parameter is ignored\r\n            <b>The value of this or the Category attribute is required.</b>"
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Resolution codes are in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.ResolutionCodes.ResolutionCodeResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            4113 — You can specify up to 5 asset categories"
          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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\r\n            <br/>Error codes: \r\n            4114 — You don't have access to asset categories"
          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:
      - ResolutionCodes
      summary: Add or update resolution codes for a work order
      description: "Associates resolution codes with the specified work order. If resolution codes are already added to a work order, you can change them by sending the request.\r\n            <br />Learn [how providers can add or edit resolution codes](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/1688502858/Resolution+and+Root+Causes+Codes+in+Provider+Automation#ResolutionandRootCausesCodesinProviderAutomation-ProcessingRRCsProcessingResolutionandRootCauseCodes) in ServiceChannel University.\r\n            <br />**Example Requests**\r\n                \r\n              OPTION 1:\r\n                POST /resolutionCodes\r\n                {\r\n                   \"WorkOrderId\": 158716211,\r\n                   \"ResolutionCodeIds\": [\r\n                     2145, 2147\r\n                 ],\r\n                   \"ResolutionCodes\": []\r\n                }\r\n                \r\n              OPTION 2:\r\n                POST /resolutionCodes\r\n                {\r\n                   \"WorkOrderId\": 158716211,\r\n                   \"ResolutionCodeIds\": [],\r\n                   \"ResolutionCodes\": [\r\n                    {\r\n                     \"Key\": 2189,\r\n                     \"Text\": \"Repair wings\",\r\n                     \"AssetCategoryId\": 5\r\n                    },\r\n                    {\r\n                     \"Key\": 2146,\r\n                     \"Text\": \"\",\r\n                     \"AssetCategoryId\": 2\r\n                    }\r\n                   ]\r\n                }"
      operationId: POSTv3_resolutionCodes
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: "Request to add or update resolution codes for a work order. \r\n            <br />**Required parameters:**\r\n             • `WorkOrderId`. Unique numeric identifier of the work order to add resolution codes to.\r\n             • Use one of the following collections to add resolution codes. To get resolution code IDs, send the [GET /resolutionCodes](/swagger/ui/index?version=3#/ResolutionCodes/GETv3_resolutionCodes_subscriberId__subscriberId__trade__trade__category__category__locationId__locationId__providerId__providerId__assetCategoryIds_0___assetCategoryIds_0___assetCategoryIds_1___assetCategoryIds_1___keyword__keyword__page__page__pageSize__pageSize_) request, and look for the `Key` value of the desired code in the response. \r\n              ◦ `ResolutionCodeIds`. Enter resolution code IDs separated by commas.\r\n              ◦ `ResolutionCodes`. For each resolution code you want to add, pass an object with the following parameters: `Key`, `Text` — optional comment for resolution codes with the `HasFreeText` attribute, and `AssetCategoryId` (required if you have access to asset categories).\r\n            <br />Users who have access to asset categories should add 1–3 resolution codes for each asset category associated with a work order. Otherwise, you can specify up to 3 resolution codes for a work order."
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.ResolutionCodes.UpdateResolutionCodesRequest'
      responses:
        '200':
          description: Resolution codes are added to the specified work order.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            4100 — You can specify up to 3 resolution codes for a work order\r\n            4101 — You need to specify at least one resolution code\r\n            4108 — The max length of the resolution code text is exceeded\r\n            4109 — Resolution code text must be unique\r\n            4110 — Resolution code without free text must be unique\r\n            4122 — You need to specify up to 3 resolution codes per asset category for all asset categories assigned to the 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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\r\n            <br/>Error codes: \r\n            4107 — You don't have access to set the resolution code text"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data nor found"
        '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
  /resolutionCodes/{workOrderId}:
    get:
      tags:
      - ResolutionCodes
      summary: Get resolution codes and root causes for a work order
      description: "Returns resolution codes and root causes for the specified work order.\r\n             • A **resolution code** is an action that a technician takes to resolve a problem upon working on a service request.\r\n             • A **root cause** is a reason why the problem occurred to begin with.\r\n            <br />Resolution codes and root causes are set up for specific trades and are standardized. If there are resolution codes and root causes configured for a work order trade, a technician is prompted to select these properties upon [checking out of a work order](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/622396960/Checking+In+and+Out+of+Work+Orders+Using+SC+Provider#CheckingInandOutofWorkOrdersUsingSCProvider-CheckingOutwithResolutionandRootCauseCodes) and moving it to the _Completed_ status in ServiceChannel Provider."
      operationId: GETv3_resolutionCodes_{workOrderId}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: path
        description: Unique identifier of the work order to return resolution codes and root causes for.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Resolution codes and root causes for the specified work order are in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.ResolutionCodes.WorkOrderResolutionInfoResponse'
        '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'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data not found"
        '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
  /resolutionCodes/rootCauses:
    get:
      tags:
      - ResolutionCodes
      summary: Get root causes
      description: Returns a list of root causes. Root causes are set up for trades and describe reasons why the problem occurred to begin with.
      operationId: GETv3_resolutionCodes_rootCauses
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: subscriberId
        in: query
        description: Unique subscriber identifier.
        required: true
        type: integer
        format: int32
      - name: trade
        in: query
        description: "Trade to return root causes for. A trade is an area of work for which a service is performed, such as _HVAC_, _Refrigeration_, or _Plumbing_.\r\n            <b>The value of this or the TradeId attribute is required.</b>\r\n            Parameter is obsolete. Please use <b>TradeId</b> instead"
        required: false
        type: string
      - name: category
        in: query
        description: "Category to return root causes for. A category is the overall classification of a work order, such as _Maintenance_, _Repair_, or _CAPEX_.\r\n            <b>The value of this or the CategoryId attribute is required.</b>\r\n            Parameter is obsolete. Please use <b>CategoryId</b> instead"
        required: false
        type: string
      - name: locationId
        in: query
        description: Unique identifier of a subscriber’s location.
        required: true
        type: integer
        format: int32
      - name: providerId
        in: query
        description: Unique provider identifier. Should be passed by subscriber users.
        required: false
        type: integer
        format: int32
      - name: assetCategoryIds
        in: query
        description: IDs of asset categories to return root causes for. You can specify up to 5 asset categories if you have access to this functionality.
        required: false
        type: array
        items:
          type: integer
          format: int32
      - name: keyword
        in: query
        description: Keyword contained in root causes to perform the search by.
        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 is 10.
        required: false
        type: integer
        format: int32
      - name: tradeId
        in: query
        description: "TradeId to return root causes for. If 'tradeId' is passed, 'trade' parameter is ignored\r\n            <b>The value of this or the Trade attribute is required.</b>"
        required: false
        type: integer
        format: int32
      - name: categoryId
        in: query
        description: "CategoryId to return root causes for. If 'categoryId' is passed, 'category' parameter is ignored\r\n            <b>The value of this or the Category attribute is required.</b>"
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: Root causes are in the response.
          schema:
            type: array
            items:
              $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Response.ResolutionCodes.RootCauseResponse'
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            4113 — You can specify up to 5 asset categories"
          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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason.\r\n            <br/>Error codes: \r\n            4114 — You don't have access to asset categories"
          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:
      - ResolutionCodes
      summary: Add or update root causes for a work order
      description: "For users who have access to asset categories, associates root causes with the specified work order. If root causes are already added to a work order, you can replace them by sending the request. You need to specify one root cause for each asset category of a work order.\r\n            <br />Get root cause IDs using the [GET /resolutionCodes/rootCauses](/swagger/ui/index?version=3#/ResolutionCodes/GETv3_resolutionCodes_rootCauses_subscriberId__subscriberId__trade__trade__category__category__locationId__locationId__providerId__providerId__assetCategoryIds_0___assetCategoryIds_0___assetCategoryIds_1___assetCategoryIds_1___keyword__keyword__page__page__pageSize__pageSize_) method. To retrieve asset category IDs, send the [GET /AssetTypes/GetAssetTypeGroups](/swagger/ui/index?version=3#/AssetTypes/GETv3_AssetTypes_GetAssetTypeGroups_subscriberId__subscriberId_) request.\r\n            <br />***Note:*** Users who don't have access to asset categories should pass the [POST /resolutionCodes/rootCauses/{workOrderId}](/swagger/ui/index?version=3#/ResolutionCodes/POSTv3_resolutionCodes_rootCauses__workOrderId__rootCauseId__rootCauseId__rootCauseText__rootCauseText_) request to add or update a root cause for a work order.\r\n            <br />Visit ServiceChannel University to find out [how providers can add or edit root causes](https://servicechannel.atlassian.net/wiki/spaces/SCUCP/pages/1688502858/Resolution+and+Root+Causes+Codes+in+Provider+Automation#ResolutionandRootCausesCodesinProviderAutomation-ProcessingRRCsProcessingResolutionandRootCauseCodes).\r\n            <br />**Example Request**\r\n            \r\n               POST /resolutionCodes/rootCauses\r\n               {\r\n                 \"WorkOrderId\": 175444600,\r\n                 \"RootCauses\": [\r\n                  {\r\n                    \"Key\": 419,\r\n                    \"Text\": \"Accidental damage\",\r\n                    \"AssetCategoryId\": 1\r\n                  },\r\n                  {\r\n                    \"Key\": 420,\r\n                    \"Text\": \"\",\r\n                    \"AssetCategoryId\": 2\r\n                  }\r\n                ]\r\n               }"
      operationId: POSTv3_resolutionCodes_rootCauses
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: request
        in: body
        description: Request to add or update root causes for a work order.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.ResolutionCodes.UpdateRootCausesRequest'
      responses:
        '200':
          description: Root causes are added to the specified work order.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            4102 - You need to select a root cause\r\n            4105 - The max length of the root cause text is exceeded\r\n            4117 - The work order doesn't have assigned asset categories. You need to specify at least one asset category\r\n            4118 - You need to specify one root cause per asset category for all asset categories assigned to the work order\r\n            4120 - Asset category is required"
          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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason. \r\n            <br/>Error codes:\r\n            4104 — You don't have access to set the root cause tex\r\n            4114 — You don't have access to asset categories"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data not found"
        '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
  /resolutionCodes/rootCauses/{workOrderId}:
    post:
      tags:
      - ResolutionCodes
      summary: Add or update root causes for a work order
      description: "For users who don't have access to asset categories, associates a root cause with the specified work order. If a root cause is already added to a work order, you can change it by sending the request.\r\n            <br />Before adding a root cause, use the [GET /resolutionCodes/rootCauses](/swagger/ui/index?version=3#/ResolutionCodes/GETv3_resolutionCodes_rootCauses_subscriberId__subscriberId__trade__trade__category__category__locationId__locationId__providerId__providerId__assetCategoryIds_0___assetCategoryIds_0___assetCategoryIds_1___assetCategoryIds_1___keyword__keyword__page__page__pageSize__pageSize_) method to find out if root causes are configured for the work order trade. To get a root cause ID, look for the `Key` value of the desired root cause in the response.\r\n            <br /> ***Note:*** Users with access to asset categories should send the following request to add or update root causes for a work order: [POST /resolutionCodes/rootCauses](/swagger/ui/index?version=3#/ResolutionCodes/POSTv3_resolutionCodes_rootCauses)."
      operationId: POSTv3_resolutionCodes_rootCauses_{workOrderId}?rootCauseId={rootCauseId}&rootCauseText={rootCauseText}
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: path
        description: Unique numeric identifier of the work order to add, update, or delete a root cause for.
        required: true
        type: integer
        format: int32
      - name: rootCauseId
        in: query
        description: ID of the root cause to associate with the work order. Ignore this parameter to remove the current root causes from the work order.
        required: false
        type: integer
        format: int32
      - name: rootCauseText
        in: query
        description: Comment explaining your understanding of the root cause of the work order.<br />Enabled for root causes with the `HasFreeText` attribute. The maximum length is 100 characters.
        required: false
        type: string
      responses:
        '200':
          description: The root cause is added to the specified work order.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            4102 — You need to select a root cause\r\n            4105 — The max length of the root cause text is exceeded"
          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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason. \r\n            <br/>Error codes: \r\n            4104 - You don't have access to set root cause text\r\n            4121 - You must use a method to set multiple root causes when you have access to asset categories"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data nor found"
        '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
  /resolutionCodes/{workOrderId}/assetCategories:
    get:
      tags:
      - ResolutionCodes
      summary: Retrieve asset categories for a work order
      description: "Returns asset categories associated with the specified work order. Asset categories represent a standardized classification of asset types.\r\n            <br />***Note:*** Only users who have access to asset categories can send this request."
      operationId: GETv3_resolutionCodes_{workOrderId}_assetCategories
      consumes: []
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: path
        description: Unique numeric identifier of the work order to return asset categories for.
        required: true
        type: integer
        format: int32
      responses:
        '200':
          description: Asset categories for the specified work order are in the response.
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetTypeCategory'
        '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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason. \r\n            <br/>Error codes: \r\n            4114 - You don't have access to asset categories"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data not found"
        '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:
      - ResolutionCodes
      summary: Add or update asset categories for a work order
      description: "Associates asset categories with the specified work order. Sending this request replaces the current asset categories.\r\n            <br />Asset categories represent a standardized classification of asset types. You can add no more than 5 asset categories to a work order.\r\n            <br />***Note:*** Only users who have access to asset categories can send this request.    \r\n            <br />**Example Request**\r\n            \r\n               POST /resolutionCodes/{workOrderId}/assetCategories\r\n               {\r\n                 \"AssetCategoryIds\": [\r\n                   1, 4, 6\r\n                 ]\r\n               }"
      operationId: POSTv3_resolutionCodes_{workOrderId}_assetCategories
      consumes:
      - application/json
      - text/json
      produces:
      - application/json
      - text/json
      parameters:
      - name: workOrderId
        in: path
        description: Unique numeric identifier of the work order to add asset categories to.
        required: true
        type: integer
        format: int32
      - name: request
        in: body
        description: Request to add or update asset categories for a work order.
        required: true
        schema:
          $ref: '#/definitions/ServiceChannel.Services.WebApi.Models.Request.ResolutionCodes.UpdateAssetCategoriesRequest'
      responses:
        '200':
          description: Asset categories are added to the specified work order.
        '400':
          description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n            <br/>Error codes:\r\n            4113 - You can specify up to 5 asset categories\r\n            4115 - You need to specify at least one asset category\r\n            4116 - Invalid asset category id"
          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'
        '403':
          description: "You are not authorized to request this resource, or the resource is unavailable for some reason. \r\n            <br/>Error codes: \r\n            4114 - You don't have access to asset categories"
          schema:
            $ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
        '404':
          description: "The requested resource does not exist on the server.\r\n            <br/>Error codes:\r\n            502 — Data not found"
        '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
definitions:
  ServiceChannel.Services.WebApi.Models.Response.ResolutionCodes.RootCauseResponse:
    description: Root cause object.
    type: object
    properties:
      Key:
        format: int32
        description: Root cause identifier.
        type: integer
      Value:
        description: Root cause name.
        type: string
      HasFreeText:
        description: Defines whether a user can enter a comment explaining their understanding of the root cause and specifying the reason why the problem occurred.
        default: false
        type: boolean
      Order:
        format: int32
        description: Order of appearance of a root cause.
        type: integer
      AssetCategoryIds:
        description: Asset category ID. A value populates only if two or more categories are specified in assetCategoryIds in the filter.
        type: array
        items:
          format: int32
          type: integer
  ServiceChannel.Services.Messaging.Assets.AssetTypeCategory:
    description: Asset category object.
    type: object
    properties:
      Id:
        format: int32
        description: Unique numeric identifier of the asset category.
        type: integer
      Name:
        description: Asset category name.
        type: string
  ServiceChannel.Services.WebApi.Models.Request.ResolutionCodes.ResolutionCodeRequest:
    description: Object for details of a resolution code to add to a work order.
    type: object
    properties:
      Key:
        format: int32
        description: ID of the resolution code to associate with the work order.
        type: integer
      Text:
        description: "Comment explaining your understanding of the resolution code of the work order. \r\n            Enabled for resolution codes with the `HasFreeText` attribute. The maximum length is 100 characters."
     

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