SEservicechannel
ResolutionCodes

Get root causes

Returns a list of root causes. Root causes are set up for trades and describe reasons why the problem occurred to begin with.

get/resolutionCodes/rootCauses

Request

Query parameters

subscriberIdinteger required

Unique subscriber identifier.

tradestring

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. <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 root causes 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 root causes for. You can specify up to 5 asset categories if you have access to this functionality.

keywordstring

Keyword contained in root causes 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 root causes 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 root causes for. If 'categoryId' is passed, 'category' parameter is ignored <b>The value of this or the Category attribute is required.</b>

Response

Root causes are in the response.

Keyinteger

Root cause identifier.

Valuestring

Root cause name.

HasFreeTextboolean

Defines whether a user can enter a comment explaining their understanding of the root cause and specifying the reason why the problem occurred.

Orderinteger

Order of appearance of a root cause.

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.