ServiceChannel AssetTypes API
The AssetTypes API from ServiceChannel — 21 operation(s) for assettypes.
OpenAPI Specification
swagger: '2.0'
info:
version: bearer.v1
title: Fixxbook.Bearer.Api.V1 AfterHours AssetTypes API
isOdataApi: false
relativePath: ''
discoveryPath: docs/bearer.v1
_isAuthorizedAccess: true
host: sb2fixxbook.servicechannel.com:443
basePath: /api
schemes:
- https
security:
- oauth2: []
tags:
- name: AssetTypes
paths:
/AssetTypes:
get:
tags:
- AssetTypes
operationId: GETv3_AssetTypes
consumes: []
produces:
- application/json
- text/json
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetType'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
post:
tags:
- AssetTypes
operationId: POSTv3_AssetTypes
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: req
in: body
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AddAssetTypeRequest'
responses:
'201':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AddAssetTypeResponse'
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 3100 — Asset Type Name is already in use.\r\n 3106 — Asset Type Name is Missing.\r\n 703 — Primary trade not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/AssetTypes/{assetTypeId}:
get:
tags:
- AssetTypes
operationId: GETv3_AssetTypes_{assetTypeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: assetTypeId
in: path
required: true
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetType'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 502 — Asset Type not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
put:
tags:
- AssetTypes
summary: ''
description: "Update Asset Type\r\n Don't specify AdditiolanTrades if no changes in Additiolan Trades needed\r\n Set AdditiolanTrades = [] to delete existing Additiolan Trades for asset type\r\n If AdditiolanTrades contains records then these trades will be set as Additional Trades to asset type."
operationId: PUTv3_AssetTypes_{assetTypeId}
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: assetTypeId
in: path
required: true
type: integer
format: int32
- name: type
in: body
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetType'
responses:
'200':
description: Request succeeded and the requested information is in the response.
'400':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 3101 — Asset Type Doesn't Exist!.\r\n 3102 — Asset Type already contains assets. Refrigerant Purpose can not be changed!\r\n 703 — Trade not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
delete:
tags:
- AssetTypes
operationId: DELETEv3_AssetTypes_{assetTypeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: assetTypeId
in: path
required: true
type: integer
format: int32
responses:
'200':
description: Request succeeded and the requested information is in the response.
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 502 — Asset Type not found.\r\n 3103 — Failed to delete asset type\r\n 3104 — Failed to delete asset type. Existing assets found.\r\n 3108 — Failed to delete asset type. Existing proposals found.\r\n 3105 — Cant modify asset type ParentId.\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Subscribers
/AssetTypes/byids:
get:
tags:
- AssetTypes
operationId: GETv3_AssetTypes_byids?ids[0]={ids[0]}&ids[1]={ids[1]}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: ids
in: query
required: true
type: array
items:
type: integer
format: int32
collectionFormat: multi
responses:
'200':
description: Request succeeded and the requested information is in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetType'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypeAttributes/{assetTypeId}:
get:
tags:
- AssetTypes
operationId: GETv3_AssetTypes_GetAssetTypeAttributes_{assetTypeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: assetTypeId
in: path
required: true
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.Messaging.Assets.AssetTypeAttributeExternal'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 502 — Asset Type not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypeTrades/{assetTypeId}:
get:
tags:
- AssetTypes
operationId: GETv3_AssetTypes_GetAssetTypeTrades_{assetTypeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: assetTypeId
in: path
required: true
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 502 — Asset Type not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypeGroups:
get:
tags:
- AssetTypes
summary: Get asset type groups by SubscriberId
description: Returns a list of asset type groups for the specified subscriber.
operationId: GETv3_AssetTypes_GetAssetTypeGroups?subscriberId={subscriberId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: query
description: Unique numeric identifier of the subscriber.
required: false
type: integer
format: int32
responses:
'200':
description: Asset type groups are in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.AssetTypes.AssetTypeGroup'
'400':
description: "The request was 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: "Something went wrong, and the server was unable to complete your request.\r\n <br/>Error codes:\r\n 501 — Object reference is not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetSubscriberAssetTypeCategories:
post:
tags:
- AssetTypes
summary: Get asset categories by SubscriberId and TradeNames
description: "Returns an asset category containing asset types that belong to the specified trade for the specified subscriber.\r\n <br />\r\n ***Note***: `TradeNames` is an optional parameter. When you skip it, the response shows all asset categories containing asset types."
operationId: POSTv3_AssetTypes_GetSubscriberAssetTypeCategories
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Request model to retrieve a list of asset categories.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.GetSubscriberAssetCategoriesRequest'
responses:
'200':
description: Asset categories 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'
'500':
description: "Something went wrong, and the server was unable to complete your request.\r\n <br/>Error codes:\r\n 501 — Object reference is not set to an instance of an object\r\n 501 — Value cannot be null"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypeCategoriesByIds:
post:
tags:
- AssetTypes
summary: Get asset categories by Ids
description: "Returns asset categories names based on their numeric identifiers.\r\n <br />\r\n ***Note***: To get all asset categories, send the request without specifying any Id. Asset categories from the list may contain asset types or may be empty, as this method retrieves asset categories from the standardized list."
operationId: POSTv3_AssetTypes_GetAssetTypeCategoriesByIds
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Request model to retrieve asset categories names.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.GetByIdsRequest'
responses:
'200':
description: Asset categories names 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'
'500':
description: "Something went wrong, and the server was unable to complete your request.\r\n <br/>Error codes:\r\n 501 — Object reference is not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypeCategoriesByAssetIds:
post:
tags:
- AssetTypes
summary: Get asset categories by AssetIds
description: Returns an asset category that contains the specified asset.
operationId: POSTv3_AssetTypes_GetAssetTypeCategoriesByAssetIds
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Request model to retrieve a list of asset categories.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.GetByIdsRequest'
responses:
'200':
description: Asset categories are in the response.
schema:
type: object
additionalProperties:
$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'
'500':
description: "Something went wrong, and the server was unable to complete your request.\r\n <br/>Error codes:\r\n 501 — Object reference not set to an instance of an object\r\n 501 — Unable to create a null constant value. Only entity types, enumeration types, or primitive types are supported in this context"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypesByLocation:
post:
tags:
- AssetTypes
operationId: POSTv3_AssetTypes_GetAssetTypesByLocation
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Core.InternalRequests.Assets.GetAssetTypesByLocationRequestInternal'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 502 — Asset Type not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/assets/{assetGroupId}/groupattachments:
post:
tags:
- AssetTypes
summary: Add AssetTypeGroup Attachments
operationId: POSTv3_AssetTypes_assets_{assetGroupId}_groupattachments
consumes:
- multipart/form-data
produces:
- application/json
- text/json
parameters:
- name: assetGroupId
in: path
required: true
type: integer
format: int32
- name: file
in: formData
description: File to attach to AssetTypeGroup
required: true
type: file
responses:
'200':
description: Created indicates that the request resulted in a new resource created before the response was sent.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AddAssetTypeGroupAttachmentResponse'
'400':
description: "Bad Request - the request could not be executed or was missing required parameters.\r\n <br/>Error codes:\r\n 502 — AssetTypeGroup Not found;\r\n 503 — Bad Request;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'401':
description: "Indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 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
/AssetTypes/AssetTypeMeters/{assetTypeId}:
get:
tags:
- AssetTypes
summary: Get asset type meters
description: "Returns a list of meters and their parameters associated with an asset type and created by the current subscriber.\r\n <br />You can get the details for a particular level by using the [GET/AssetTypes/AssetTypeMeter/{assetTypeMeterId}](/swagger/ui/index?version=3#/AssetTypes/GETv3_AssetTypes_AssetTypeMeter__assetTypeMeterId_) method.\r\n <br />Learn more about [asset meter reading](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/834469973/Asset+Meter+Reading) in ServiceChannel University."
operationId: GETv3_AssetTypes_AssetTypeMeters_{assetTypeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: assetTypeId
in: path
description: Unique numeric identifier of the asset type you want to get information on. Send the [GET /AssetTypes](/swagger/ui/index?version=3#/AssetTypes/GETv3_AssetTypes) request to get an asset type ID.
required: true
type: integer
format: int32
responses:
'200':
description: The requested asset type meters are in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetTypeMeterResponseItem'
'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 request URI is incorrect, or the resource does not exist.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/AssetTypeMeter/{assetTypeMeterId}:
get:
tags:
- AssetTypes
summary: Get an asset type meter details
description: Returns the details of the specified asset type meter for the current subscriber.
operationId: GETv3_AssetTypes_AssetTypeMeter_{assetTypeMeterId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: assetTypeMeterId
in: path
description: "Unique numeric identifier of the asset type meter you want to get the details of.\r\n <br />Pass the [GET /AssetTypes/AssetTypeMeters/{assetTypeId}](/swagger/ui/index?version=3#/AssetTypes/GETv3_AssetTypes_AssetTypeMeters__assetTypeId_) method to acquire an ID of an asset type meter."
required: true
type: integer
format: int32
responses:
'200':
description: The asset type meter details are in the response.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetTypeMeterResponseItem'
'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 request URI is incorrect, or the resource does not exist.
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/AssetTypeMeter:
put:
tags:
- AssetTypes
summary: Update an asset type meter
description: "Modifies information of an already existing asset type meter.\r\n <br />**Note**. All request parameters should be filled out: those you want to add or edit along with the parameters you want to leave unchanged.\r\n <br />**Example Request**\r\n \r\n PUT /AssetTypes/AssetTypeMeter\r\n {\r\n \"Id\": 16,\r\n \"Name\": \"Music System\",\r\n \"MaxValue\": \"500.00\",\r\n \"Notes\": ,\r\n \"Inactive\": false,\r\n \"EditOnWO\": true,\r\n \"AssetTypeId\": 7632,\r\n \"UnitOfMeasure\": 250\r\n }"
operationId: PUTv3_AssetTypes_AssetTypeMeter
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: Request to add or update the asset type meter details.
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetTypeMeterRequestItem'
responses:
'200':
description: The asset type meter is successfully updated.
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/> Failed to Update Asset Type Meter"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'500':
description: "The server was unable to complete the request due to an internal error.\r\n <br/>Error codes:\r\n 501 — Object reference not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
post:
tags:
- AssetTypes
summary: Add an asset type meter
description: Creates a new asset type meter for a particular asset type for the current subscriber.
operationId: POSTv3_AssetTypes_AssetTypeMeter
consumes:
- application/json
- text/json
produces:
- application/json
- text/json
parameters:
- name: request
in: body
description: "Request to add an asset type meter. \r\n <br />Pass the following parameters in the request:\r\n <br /> • **Id** (*Required*). Enter 0 or null so that when the asset type meter is created the system can assign a unique numeric ID to it.\r\n <br /> • **Name** (*Required*). Name of an asset type meter.\r\n <br /> • **Notes**. Comments provided by a user who added the asset type meter.\r\n <br /> • **Inactive**. Set the asset type meter to the active on inactive status. Valid values: *true*, *false* or 1 - true, 0 - false.\r\n <br /> • **EditOnWO**. Define whether technicians are allowed to enter data on work orders for the asset. Valid values: *true*, *false* or 1 - true, 0 - false.\r\n <br /> • **AssetTypeId** (*Required*). ID of an asset type to assign the meter to.\r\n <br /> • **UnitOfMeasure** (*Required*). Unique numeric identifier of a unit of measurement in the system."
required: true
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetTypeMeterRequestItem'
responses:
'200':
description: The asset type meter is successfully added.
'400':
description: "The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.\r\n <br/> Failed to Create Asset Type Meter"
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.\r\n <br/>Error codes:\r\n 501 — Object reference not set to an instance of an object"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/GetAssetTypesAvailableForSubscriber/{subscriberId}:
get:
tags:
- AssetTypes
operationId: GETv3_AssetTypes_GetAssetTypesAvailableForSubscriber_{subscriberId}?tradeId={tradeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: path
required: true
type: integer
format: int32
- name: tradeId
in: query
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.Messaging.Assets.AssetType'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
'404':
description: "Bad Request - the request could not be understood or was missing required parameters.\r\n <br/>Error codes:\r\n 502 — Asset Types not found."
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Any
/AssetTypes/asettypes/GetAssetTypesWithCreatePermission:
get:
tags:
- AssetTypes
summary: Get Asset Types With Create Permission
operationId: GETv3_AssetTypes_asettypes_GetAssetTypesWithCreatePermission?subscriberId={subscriberId}&tradeId={tradeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: subscriberId
in: query
description: ''
required: true
type: integer
format: int32
- name: tradeId
in: query
description: ''
required: false
type: integer
format: int32
responses:
'200':
description: OK
schema:
$ref: '#/definitions/System.Object'
'401':
description: "Unauthorized indicates that the requested resource requires authentication.\r\n <br/>Error codes:\r\n 504 — API call rejected by security permissions;"
schema:
$ref: '#/definitions/ServiceChannel.Services.Messaging.ErrorResponse'
deprecated: false
x-access: Providers
/AssetTypes/AssetTypes/AssetCategoriesByTradeId/{tradeId}:
get:
tags:
- AssetTypes
summary: Get asset categories by tradeId
description: "Returns a list of asset categories associated with the specified trade.\r\n <br />\r\n ***Note***: This method retrieves asset categories from the standardized list, that is why asset categories may contain asset types and may not. To get asset categories containing asset types that belong to the certain trade, pass the [POST /AssetTypes/GetSubscriberAssetTypeCategories](/swagger/ui/index?version=3#/AssetTypes/POSTv3_AssetTypes_GetSubscriberAssetTypeCategories) method.\r\n <br />\r\n For more information, refer to [Adding Asset Category and Asset Types](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/2523693743/Adding+Asset+Category+and+Asset+Types) in ServiceChannel University."
operationId: GETv3_AssetTypes_AssetTypes_AssetCategoriesByTradeId_{tradeId}
consumes: []
produces:
- application/json
- text/json
parameters:
- name: tradeId
in: path
description: "Unique numeric identifier of the trade. \r\n Pass the [GET / AssetTypes](/swagger/ui/index?version=3#/AssetTypes/GETv3_AssetTypes) or [GET /assets/{assetId}](/swagger/ui/index?version=3#/Assets/GETv3_assets__assetId__locationId__locationId__storeId__storeId__tagId__tagId__trackingNumber__trackingNumber_) method to retrieve `tradeId`."
required: true
type: integer
format: int32
responses:
'200':
description: Asset categories are in the response.
schema:
type: array
items:
$ref: '#/definitions/ServiceChannel.Services.Messaging.Assets.AssetTypeCategory'
# --- truncated at 32 KB (110 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/servicechannel/refs/heads/main/openapi/servicechannel-assettypes-api-openapi.yml