Working with refrigerant

Service providers now have the capability to seamlessly share information regarding refrigerant transactions associated with equipment refrigerant circuits. This crucial data is integrated into the completed work order within the customer system, allowing for efficient monitoring of refrigerant requests and improving the functionality of Corrigo Enterprise. After the customer enables this functionality, service providers will gain access to the refrigerant data.

Retrieving Circuits
Retrieves details about refrigeration equipment which are used to execute refrigerant transactions. Call GET/api/refrigerant/circuits

Retrieving Cylinders

Retrieves information about cylinders which are used in Add Refrigerant and Recover Refrigerant transactions. Call GET/api/refrigerant/cylinders

Retrieving Refrigerant Transactions

Retrieves information about refrigerant transactions. Refrigerant transactions have two different states: either scheduled (which in this case they have not yet been executed by the Provider) or they can be completed. GET/api/refrigerant/transaction


Retrieving Transaction Types

When users are performing transactions, there are specific transactions that are available to record based on the circuit and the WO. This should retrieve available transaction types that can be performed based on the circuit and the work order. Call GET/api/refrigerant/availabletransactiontypes


Working With Refrigerant Transactions

Throughout the lifecycle of a refrigerant related work order, users may add, delete, or update Refrigerant transactions. Call the following respectively:

POST/api/refrigerant/add
POST/api/refrigerant/delete
POST/api/refrigerant/update


Working With Certifications
Users may have refrigerant certifications associated with them (certification class and number). These are used to populate certification details when users are executing a transaction.

  1. Delete refrigerant certification associated with the user, call DELETE/api/refrigerant/certification
  2. Retrieve refrigerant certification associated with the user, call GET/api/refrigerant/certification
  3. Add refrigerant certification to user, call POST/api/refrigerant/certification
  4. Update refrigerant certification to user, call PUT/api/refrigerant/certification

Refrigerant Circuits#

NameTypeVerificationDescription
IdIntOptionalIdentifier of a Circuit (circuitProductId) in your customer's system.
DispAsStringOptional
Maximum length 128
The circuit name.
NumberStringOptional
Maximum length 128
The circuit number.
IsMetricBoolOptionalFlag to show if Metric is applicable or not to circuit.
LeakThresholdIntOptionalWhen the Leak Rate equals or exceeds number, the leak must be identified and repaired.
CapacityIntOptionalThe capacity of the circuit, decimals are supported. When “lb” is selected as a unit type, decimal numbers are converted to ounces.
IsLeakDetecEquipBoolOptional“true” indicates the equipment is a Circuit. “false” indicates it is a Leak Detection Equipment.
ProductIdIntOptionalProduct ID for a product in the Refrigerant category.
ProductNameStringOptional
Maximum length 256
Product Name for a product in the Refrigerant category.
StatusIDIntOptionalThe status of the refrigerant equipment.

Refrigerant Cylinder


NameTypeVerificationDescription
IdIntOptionalIdentifier of a Cylinder in your customer's system.
NumberStringOptional
Maximum length 128
The Cylinder number which was used for the transaction. If an external cylinder was used, it is recommended to add "External cylinder" in the Comments. The cylinder must contain the same refrigerant type as the circuit. Cylinders used for "Recovered from Circuit" transactions must have a Recovery Flag.
IsMetricBoolOptionalFlag to show if Metric is applicable or not to cylinder.

Refrigerant Transaction Type
The following table describes all the transaction types that was performed on the refrigeration.

ValueDescription
UnknownEmpty/unsupported value
Purchased
Disposed
Refilled
CylinderRelease
CircuitRelease
Added
Recovered
Tested
LeakIdentified
LeakRepaired
LeakTestFollow
Created
CircuitEdit
Transferred
Retired
LeakTestInitial
Adjusted
CylinderEdit
LeakInspected
ALDCalibration
Retrofitted
Activated

Refrigerant Certification Class
The following table describes the Service Provider technician's refrigerant certification classes.

ValueDescription
NoneEmpty/unsupported value
Class1
Class1AndClass2
Class1AndClass2AndClass3
Class1AndClass3
Class2
Class2AndClass3
Class3
Universal

Leak CauseId
“Leak Identified” transactions. LeakCauseId only for mode2.

ValueDescription
UnknownEmpty/unsupported value
MechanicalJoint
WeldedJoint
Valve
ControlCapillaryLine
PipeFailure
Other

Refrigerant Test Method
Required for “Leak Inspected”, “Leak Identified”, “Leak Tested (Initial)” and “Leak Tested (Follow up)” transactions.

ValueDescription
UnknownEmpty/unsupported value
NotTested
Pressurizing
Electronic
DeepVacuum
SoapBubbles
Other
DyeInject
HalideDetector
OilResidue
ApprovedAlternate
CalibratedLeakDetectionDevice