SEservicechannel
ResolutionCodes

Get resolution codes

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.

get/resolutionCodes

Request

Query parameters

subscriberIdinteger required

Unique subscriber identifier.

tradestring

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. <b>The value of this or the TradeId attribute is required.</b> Parameter is obsolete. Please use <b>TradeId</b> instead

categorystring

Category to return resolution codes for. A category is the overall classification of a work order, such as Maintenance, Repair, or CAPEX. <b>The value of this or the CategoryId attribute is required.</b> Parameter is obsolete. Please use <b>CategoryId</b> instead

locationIdinteger required

Unique identifier of a subscriber’s location.

providerIdinteger

Unique provider identifier. Should be passed by subscriber users.

assetCategoryIdsinteger[]

IDs of asset categories to return resolution codes for. You can specify up to 5 asset categories if you have access to this functionality.

keywordstring

Keyword contained in resolution codes to perform the search by.

pageinteger

Results page number.

pageSizeinteger

Number of objects on the results page. The default is 10.

tradeIdinteger

TradeId to return resolution codes for. If 'tradeId' is passed, 'trade' parameter is ignored <b>The value of this or the Trade attribute is required.</b>

categoryIdinteger

CategoryId to return resolution codes for. If 'categoryId' is passed, 'category' parameter is ignored <b>The value of this or the Category attribute is required.</b>

Response

Resolution codes are in the response.

Keyinteger

Resolution code identifier.

Valuestring

Resolution code name.

HasFreeTextboolean

Defines whether a user can enter a comment explaining their understanding of the resolution code and specifying what was done on site to solve the issue.

Orderinteger

Order of appearance of a resolution code.

AssetCategoryIdsinteger[]

Asset category ID. A value populates only if two or more categories are specified in assetCategoryIds in the filter.

Changes

No recorded changes to this operation across all 1 revision of this API.