---
title: "Get leak events by `workorderID`"
method: GET
path: "/refrigeranttracking/{trackingNumber}/leakRecord"
tags: ["RefrigerantTracking"]
---

# Get leak events by \`workorderID\`

`GET /refrigeranttracking/{trackingNumber}/leakRecord`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/refrigeranttracking/{trackingNumber}/leakRecord`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/refrigeranttracking/:trackingNumber/leakRecord/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns [leak events](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/573898951/Viewing+Refrigerant+Leak+Events) generated on the certain work order and associated leak records.

## Path parameters

- `trackingNumber` integer, required

## Response `200`

The request succeeded and the requested information is in the response.

- ServiceChannelServicesWebApiModelsResponseRefrigerantTrackingLeakEventApiResponse: Object containing the details of a leak event.
  - `Id` integer: Unique numeric identifier of the leak event.
  - `AssetId` integer: Unique numeric identifier of the asset.
  - `RecId` integer: Unique numeric identifier of the work order.
  - `TriggerDate` string, date-time: Date when the leak event was created. The format is YYYY-MM-DDThh:mm:ss.sss.
  - `RepairDate` string: Date when the repair was completed.
  - `TriggerDateStr` string: Date when the leak event was created. The format is YYYY-MM-DD.
  - `InitialVerificationDate` string: Date when the first verification took place.
  - `FollowUpDate` string: Date of the second verification.
  - `InitialVerificationMethod` integer: Method that was used during the first verification to make sure the leak had been fixed.
  - `CalculationMethod` string, byte: Method of leak calculating, for example, rolling average.
  - `FollowUpMethod` integer: Method of the second verification.
  - `LeakStatus` string, byte: Status of the leak event.
  - `LeakRate` number, double: Result of the leak calculation in percentage.
  - `Charge` number, double: Total system charge of the asset.
  - `ChargeMetrics` number, double: Metrics of the asset’s charge.
  - `TriggerQty` number, double: Trigger quantity.
  - `TriggerQtyMetrics` number, double: Trigger quantity metrics.
  - `LeakAreaId` integer: Unique numeric identifier of the area where the leak occurred: more general place, for example, receiver/condensor.
  - `LeakLocationId` integer: Unique numeric identifier of the location where the leak occurred: more specific place within the particular area, for example, level indicator/alarm/splitting valve.
  - `Step` string, byte: Step.
  - `FaultCodeId` integer: Unique numeric identifier of the reason why the problem occurred.
  - `ActionCodeId` integer: Unique numeric identifier of the action that a technician took to fix the leak.
  - `FaultCodeName` string
  - `ActionCodeName` string
  - `GeneratedDate` string, date-time: Generated date. The format is YYYY-MM-DDThh:mm:ss.sss.
  - `LeakImmeasurableList` ServiceChannelServicesWebApiModelsResponseRefrigerantTrackingLeakImmeasurableApiResponse[]: Object containing the list of leak records
    - `Id` integer: Unique numeric identifier of the leak record.
    - `AssetId` integer: Unique numeric identifier of the asset.
    - `AssetTagId` string: Unique numeric identifier of the asset tag.
    - `RecId` integer: Unique numeric identifier of the work order.
    - `RepairDate` string, date-time: Date when the repair was completed.
    - `RepairDateFormatted` string
    - `RepairDateStr` string
    - `InitialVerificationDate` string, date-time: Date when the first verification took place.
    - `InitialVerificationDateFormatted` string
    - `InitialVerificationDateStr` string
    - `InitialVerificationMethod` integer: Method that was used during the first verification to make sure the leak had been fixed.
    - `InitialVerificationMethodName` string
    - `FollowUpVerificationDate` string, date-time: Date of the second verification.
    - `FollowUpVerificationDateFormatted` string
    - `FollowUpVerificationStr` string
    - `FollowUpVerificationMethod` integer: Method of the second verification.
    - `FollowUpVerificationMethodName` string
    - `ActionCodeId` integer: Unique numeric identifier of the action that a technician took to fix the leak.
    - `ActionCode` string
    - `FaultCodeId` integer: Unique numeric identifier of the reason why the problem occurred.
    - `FaultCode` string
    - `LeakEventId` integer: Unique numeric identifier of the leak event to which the leak record is associated.
    - `LeakLocationId` integer: Unique numeric identifier of the location where the leak occurred: more specific place within the particular area, for example, level indicator/alarm/splitting valve.
    - `LeakAreaId` integer: Unique numeric identifier of the area where the leak occurred: more general place, for example, receiver/condensor.
    - `LeakLocationName` string
    - `LeakAreaName` string
    - `ModifiedBy` integer: User who modified the leak record.
    - `ModifiedByUserId` string
    - `ModifiedByUserName` string
    - `LeakNotes` string[]: Notes that were added by users to a leak record.
    - `Actor` string: Name of the technician who performed the fix of the leak.
    - `LeakLocation` string: Location where the leak occured, including more general and more specific name, for example, splitting valve - condensor.
    - `LeakStatusStr` string: Status of the leak event.
    - `NotesTotalCount` integer: Total number of leak notes.
    - `LeakImmeasurableNotes` ServiceChannelServicesMessagingRefrigerantTrackingLeakImmeasurableNote[]
      - `ID` integer
      - `LeakImmeasurableId` integer
      - `Note` string
      - `CreateDate` string, date-time
      - `CreateDateFormated` string
      - `UserId` integer
      - `AutoGenerated` boolean
      - `CreatedByUserName` string
    - `OriginalTrackingNumber` integer
    - `LeakStatus` boolean
    - `InitialVerificationPassed` boolean
    - `FollowUpVerificationPassed` boolean
    - `LeakDetectionDate` string, date-time
    - `LeakDetectionDateFormatted` string
    - `LeakDetectionDateStr` string
  - `CompletedDate` string, date-time: Date when the leak event was completed.

## Other responses

- `401`: The request is not authorized. <br/> Error codes: 504 — API call rejected by security permissions

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)