RefrigerantTracking

Complete/update a leak event

Allows users to close a leak event by setting the completion date. Other leak information can be updated as well for both in-progress and completed leak events. <br />Note: When the RTMultiLeakFlow feature flag is on, you can only add or update the completion date via this method. Other parameters cannot be modified. Note that at least one leak record should be associated with the event.

put/refrigeranttracking/leakrecord

Request

Request body

Idinteger required

Unique numeric identifier of the leak event. Leak event IDs can be found in the Refrigerant Leak Events report in Service Automation.

Notestring

Leak record note.

RepairDatestring date-time

Date when the repair was completed. It cannot be earlier than the work order call date. The date format is YYYY-MM-DDThh:mm:ss.sssZ.

InitialDatestring date-time

Date when the first leak verification took place. The date format is YYYY-MM-DDThh:mm:ss.sssZ. Note: The initial verification date cannot be in the future. It should be either a current date or a date in the past.

InitialMethodinteger

Method that was used during the first verification to make sure the leak had been fixed. <br />Possible values:  • 0: Unknown  • 1: Soap Bubble Test  • 2: Electronic Leak Detection  • 3: Ultrasonic Leak Detection  • 4: Pressure Test  • 5: Vacuum Test  • 6: Fluorescent Dye Test  • 7: Infrared Test  • 8: Near Infrared Test  • 9: Halon Gas Detection

FollowUpDatestring date-time

Date of the second verification. The date format is YYYY-MM-DDThh:mm:ss.sssZ. Note: The follow-up verification date cannot be earlier than the initial verification date and cannot be in the future. It should be either a current date or a date in the past.

FollowUpMethodinteger

Method of the second verification. The list of available verification methods is the same as for the InitialMethod.

LeakLocationIdinteger

Unique numeric identifier of the location where the leak occurred: more specific place within the particular area, for example, Level Indicator/Alarm, Splitting Valve. Use the GET/refrigeranttracking/{subscriberId}/leaklocations method to get the list of available leak locations.

FaultCodeIdinteger

Unique numeric identifier of the reason why the problem occurred. Use the GET/refrigeranttracking/leakRecord/faultCodes method to get available fault codes and their IDs. <br />Possible values:  • 1: Accidental Damage  • 2: Braze or Joint Failure  • 3: Corrosion  • 4: Defrost Heater Failure  • 5: Faulty Part  • 6: Forklift Damage  • 7: Gasket Seal Failure  • 8: Ice Build Up  • 9: Line Break  • 10: Manufacture Defect  • 11: Missing Part  • 12: Natural Disaster  • 13: Normal Mechanical Wear  • 14: Other(Must Explain in Comments)  • 15: Vandalism  • 16: Vibration Related  • 17: Project Related Loss

ActionCodeIdinteger

Unique numeric identifier of the action that a technician took to fix the leak. Use the GET/refrigeranttracking/leakRecord/actionCodes method to get available action codes and their IDs.

LeakAreaIdinteger

Unique numeric identifier of the area where the leak occurred: more general place, for example, Receiver or Compressor. Use the GET/refrigeranttracking/leakareas method to get leak areas and their IDs.

CurrentTrackingNumberinteger

Unique numeric identifier of the work order.

CompletedDatestring date-time

Date and time when the leak event was completed. The date format is YYYY-MM-DDThh:mm:ss.sssZ. Note: The leak event completion date cannot be earlier than the leak event repair date and later than the work order completion date.

Response

The specified leak event has been successfully updated.

Changes

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