SEservicechannel
RefrigerantTracking

Get reason codes for refrigerant use

Retrieves a list of reason codes for the refrigerant part use. For example, leak or repair.

get/refrigeranttracking/{subscriberId}/GetRefrigerantUseReasonCodes

Request

Path parameters

subscriberIdinteger required

Unique numeric identifier of the subscriber.

Response

The list of reason codes is in the response.

Idinteger

Unique numeric identifier of the refrigerant use reason code.

Orderinteger

Order of appearance of a reason code.

Purposeinteger

Unique numeric identifier of the reason code for the refrigerant part use. Possible values: 0 - Leak, 1 - InitialCharge, 2 - SystemExpansion, 3 - Removal, 4 - Other, 5 - RemovedReused, 6 - Retrofit. <br />Each reason code on the subscriber side is associated with a hardcoded purpose value in the database. Since reason codes can vary across subscribers, the purpose helps identify the valid reason code. <br />Note: Purpose value 0 is assigned to the Leak and Repair reason codes, indicating that a leak record gets calculated for these reason codes.

Namestring

Reason code name for the refrigerant part use as configured by the subscriber. Possible values:  • Leak  • Repair  • Adjustment  • System Expansion  • Removal  • Initial Charge  • Retrofit  • Removed Reused

SubscriberIdinteger

Unique numeric identifier of the subscriber.

IsActiveboolean

Defines whether a user can select a reason code when capturing refrigerant use. Possible response values:  • true: Reason code is enabled.  • false: Reason code is disabled.

Changes

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