--- title: "Get leak tracking preferences" method: GET path: "/refrigeranttracking" tags: ["RefrigerantTracking"] --- # Get leak tracking preferences `GET /refrigeranttracking` ## Request - Base URL: `https://sb2api.servicechannel.com/v3` - URL: `https://sb2api.servicechannel.com/v3/refrigeranttracking` - Auth: OAuth 2 - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize` - Token URL: `https://sb2login.servicechannel.com/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Shows refrigerant leak tracking preferences, including Commercial Refrigerant Trigger Rate, HVAC Trigger Rate, PM Leak Inspection NTE, and more, configured for the subscriber.
When the *RefrigerationTracking* feature flag is turned off for the subscriber, the method returns the default — EPA standard — values. ## Query parameters - `subscriberId` integer, required ## Response `200` Refrigerant tracking settings for the specified subscriber are in the response. - ServiceChannelServicesMessagingRefrigerantTrackingRefrigerantSettingsRefrigerantSettingsUS: Object containing refrigerant tracking settings for US companies - `UnitsOfMeasure` string, byte: Unit of measure for tracking refrigerant use.
The possible response values: • `0`: Pounds and decimals of pounds • `1`: Pounds and ounces • `2`: Kilograms and grams
***Note***: To use kilograms and grams as a unit of measure, turn on the *RefrigerantSettingsEU* feature flag. - `SubscriberId` integer: Unique numeric identifier of the subscriber. - `InventoryLocation` string, byte: Defines whether technicians can take refrigerant from any inventory location or from the locations in the technician's area only.
The possible response values: • `0`: Only in technician’s area • `1`: Any location - `CalculationMethod` string, byte: Preferred method of refrigerant leak calculation: • `0`: Annualized • `1`: Rolling Average
Check how each calculation method works in [SCU](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/2789703925/Refrigerant+Tracking#RefrigerantTracking). - `ChargeThreshold` number, double: Minimum amount of refrigerant that a system can contain for leak tracking to occur. The charge threshold value is displayed in the specified unit of measure. Check the `UnitsOfMeasure` parameter value. - `ComercialRefTriggerRate` number, double: Minimum percentage of the total system charge that can be lost before refrigerant tracking to occur. This rate is set for commercial refrigeration appliances.
It applies to asset types with the refrigerant use purpose set to *Commercial Refrigeration*. - `IndustrialRefTriggerRate` number, double: Minimum percentage of the total system charge that can be lost before refrigerant tracking to occur. This rate is set for industrial refrigeration appliances.
It applies to asset types with the refrigerant use purpose set to *Industrial Refrigeration*. - `HVACTriggerRate` number, double: Minimum percentage of the total system charge that can be lost before refrigerant tracking to occur. This rate is set for HVAC appliances.
It applies to asset types with the refrigerant use purpose set to *Comfort Cooling (AC)*. - `OthersTriggerRate` number, double: Minimum percentage of the total system charge that can be lost before refrigerant tracking to occur. This trigger rate is set for appliances that don’t fall under any of the following groups: commercial appliances, industrial appliances, HVAC appliances.
It applies to asset types with the refrigerant use purpose set to *Other Types of Refrigerated Asset*. - `Yearly` number, double: Minimum threshold for annual leak inspections. The value defines the minimum system charge required to create an annual PM leak inspection work order if a leak has met or exceeded the EPA leak threshold.
Check the `UnitsOfMeasure` parameter value to see the corresponding unit of measure. - `Quarterly` number, double: Minimum threshold for quarterly leak inspections. The value defines the minimum system charge required to create quarterly PM leak inspection work orders if a leak has met or exceeded the EPA leak threshold.
Check the `UnitsOfMeasure` parameter value to see the corresponding unit of measure. - `RunCARBReport` boolean: Refrigerant tracking preference that allows subscribers to run the California Air Resources Board report.
The possible response values: • `true`: The CARB reporting is activated for the subscriber. • `false`: The CARB reporting is deactivated for the subscriber.
Learn about the CARB reporting in [SCU](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/710148264/California+Air+Resource+Board+CARB+Reporting). - `ComplianceAcknowledgmentForAllLeaksRefrigerantUse` boolean: Compliance acknowledgement message that gets triggered for every reported leak or refrigerant use to confirm that a full inspection has been conducted.
The possible response values: • `true`: The compliance acknowledgement message is enabled in the SC Provider mobile app, Service Automation, and Provider Automation. • `false`: The compliance acknowledgement message is deactivated.
***Note***: The *RefLeakInspectionAcknowledgementAll* feature flag should be turned on. - `DelayedSecondaryVerification` boolean: Allows subscribers to enforce a time delay between the initial and the secondary verifications when a leak event takes place.
The possible response values: • `true`: Time delay is activated by the subscriber. The number of days is specified for each refrigerant type: * `HVACDelayDays` * `IndustrialRefrigerationDelayDays` * `CommercialRefrigerationDelayDays` * `OtherTypesDelayDays` • `false`: Time delay is not enabled by the subscriber.
***Note***: The subscriber should have the *RefrigerationTrackingDelayedSecondaryVerification* feature flag enabled.
Read more about this feature in [SCU](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/2789703925/Refrigerant+Tracking#RefrigerantTracking-DelayedSecondaryVerificationDelayedSecondaryVerification). - `LeakInspectionNTE` number, double: Default not-to-exceed (NTE) amount for all PM work orders generated for quarterly and annual follow-up leak inspections. - `RefrigerationPriorityName` string: Priority name for Planned Maintenance work orders that are automatically generated for follow-up leak inspections. - `EmailNotificationEnable` boolean: Allows subscribers to create an email notification that will be sent to the specified recipients when the amount of refrigerant added by a technician meets or exceeds the system total charge.
The possible response values: • `false`: The email notification is not enabled by the subscriber. • `true`: The email notification is enabled. The recipients and the message text are specified in the response. When the response value is `true`, check the `EmailNotification` object. - `EmailNotification` ServiceChannelServicesMessagingRefrigerantTrackingRefrigerantSettingsEmailNotification: Object defining the system charge exceeded notification. The email notification is sent to the specified recipients when the amount of refrigerant added by a technician meets or exceeds the system total charge. - `EmailAddresses` string: Email addresses of the recipients who receive the system charge exceeded notification. - `EmailText` string: Text of the email. - `GenerateFollowUpWorkOrder` string, byte: Defines whether a follow-up work order should be generated when there is an open leak, and the provider wants to close the original work order.
The possible response values: • `0`: No follow-up work orders should be generated. The work order cannot be closed and invoiced until the leak record is closed. The *Never* option is set by the subscriber for the **Follow-Up Work Order** setting in Refrigerant Tracking Admin. • `1`: A follow-up work order can be generated for the provider to close the leak record. The *Open Leak* option is set by the subscriber for the **Follow-Up Work Order** setting in Refrigerant Tracking Admin.
***Note***: If the *Open Leak* option is not available for the subscriber, try turning the *RTMultiLeakFollowUp* feature flag on. - `Compliance` string: Shows the region to which the configured refrigerant tracking settings get applied, following the compliance requirements.
The possible response values: • `US`: Refrigerant tracking compliance for the USA • `EU`: Refrigerant tracking compliance for the European Union • `CA`: Refrigerant tracking compliance for Canada - `MaxLocCount` integer: Maximum number of locations where refrigerant tracking should be recorded. It relates to the `RtLimitedAppliance` parameter. - `RtLimitedAppliance` string, byte: Specifies whether refrigerant tracking should happen across all locations or at those where it’s required.
The possible response values: • `0`: Across all locations • `1`: For limited locations only
When the response returns `1`, check the related `MaxLocCount` parameter to learn the max number of locations. - `Settings` string: Refrigerant tracking preferences configured for the subscriber. - `RefrigerantTrackingProviderId` integer: Unique numeric identifier of the provider who is assigned retrofit and retirement work orders, as well as work orders created in the event of adding a refrigerant part use record from the asset details page. - `GenerateLeakInspectionOption` string, byte: Specifies which refrigerant types require PM leak inspection work orders: only ODS (Ozone Depleting Substance) refrigerant types or all refrigerant types.
The possible response values: • `0`: For all refrigerant types • `1`: For ODS refrigerant types - `OpenLeakNotificationSettings` ServiceChannelServicesMessagingRefrigerantTrackingRefrigerantSettingsOpenLeakNotificationSettings: Object containing the settings for configuring email alerts about open leaks. - `NotificationInterval` integer: How many days should pass before sending the next notification about the open leak event. - `RecipientsEmails` string: Email address(es) of people who get notified about the open leak. - `UpdatedDate` string, date-time: Date when the open leak notification settings were last updated by the subscriber. The format is YYYY-MM-DDThh:mm:ss.sssZ. - `EnableCARBInspections` boolean: Shows whether the subscriber has activated PM leak inspections for appliances tracked by CARB (California Air Resources Board).
The possible response values: • `true`: PM leak inspections are enabled for appliances tracked by CARB. When the parameter is `true`, check the related parameters: * `DateFormat` * `CalendarStartDate` * `CalendarStartDateStr` • `false`: PM leak inspections are deactivated for appliances tracked by CARB. - `DateFormat` string: Date format applied to the `CalendarStartDate` parameter. - `CalendarStartDate` string, date-time: Date that becomes a call date for all CARB leak inspection PM work orders. The date format is YYYY-MM-DDThh:mm:ss.
Check the `EnableCARBInspections` parameter for more information. - `CalendarStartDateStr` string: Date that becomes a call date for all CARB leak inspection PM work orders. The date format is MMM DD, YYYY. - `LeakInspectionPMGenerationAdvanceTimeframe` integer: Number of days to generate PM leak inspection work orders in advance upon identifying a leak. The default value is 7 days. - `LeakInspectionPMGenerationAdvanceAppliedToExistingPMs` string, byte - `LeakInspectionCategoryId` integer: Unique numeric identifier of the category for PM leak inspection work orders. - `SCProviderMessageEnable` boolean: Shows whether the subscriber has enabled the compliance acknowledgment message to be displayed for providers in the SC Provider mobile app. Providers receive the message when checking out of PM leak inspection work orders with at least one refrigerated asset.
The possible response values: • `true`: The acknowledgement message is enabled. • `false`: The acknowledgement message is deactivated.
Read about the related `SCProviderMessage` parameter to view the message text.
***Note***: The *RefLeakInspectionAcknowledgement* and *RTMultiLeakFlow* feature flags should be turned on. - `ServiceAutomationMessageEnable` boolean: Shows whether the subscriber has enabled the compliance acknowledgment message to be displayed for subscribers in Service Automation. The message appears when subscribers are entering leak verification information for PM leak inspection work orders with at least one refrigerated asset.
The possible response values: • `true`: The message is enabled. • `false`: The message is deactivated.
Check the related `ServiceAutomationMessage` parameter to view the message text.
***Note***: The *RefLeakInspectionAcknowledgement* and *RTMultiLeakFlow* feature flags should be turned on. - `ProviderAutomationMessageEnable` boolean: Shows whether the subscriber has enabled the compliance acknowledgment message to be displayed for providers in Provider Automation. The message is displayed when providers are entering leak verification information for PM leak inspection work orders with at least one refrigerated asset.
The possible response values: • `true`: The acknowledgment message is enabled. • `false`: The acknowledgment message is deactivated.
Check the related `ProviderAutomationMessage` parameter to view the message text.
***Note***: The *RefLeakInspectionAcknowledgement* and *RTMultiLeakFlow* feature flags should be turned on. - `SCProviderMessage` string: Compliance acknowledgement message that is displayed for providers in SC Provider upon checking out of PM leak inspection work orders with at least one refrigerated asset. See the parent `SCProviderMessageEnable` parameter for more details. - `ServiceAutomationMessage` string: Compliance acknowledgement message that is displayed for subscribers in Service Automation. Subscribers see the message when they are entering leak verification information for PM leak inspection work orders with at least one refrigerated asset. - `ProviderAutomationMessage` string: Compliance acknowledgement message that is displayed for providers in Provider Automation. Providers see the message when they are entering leak verification information for PM leak inspection work orders with at least one refrigerated asset. - `CertificationExceptionRecipients` string: Email addresses of people to be notified whenever technicians specify that they don’t have the required trade certification/license while completing a refrigerant or HVAC work order via SC Provider.
***Note***: Available with the *RefCertSCP* feature flag. - `GreenChillReportReceipting` boolean: Shows whether the subscriber has enabled GreenChill Report to use provided email address instead of default recipient email address.
Check the related 'GreenChillReportRecipientEmail' parameter to view the email address. - `GreenChillReportRecipientEmail` string: Email Address that is displayed in GreenChill Report. - `CertificationExceptionRecipientEmails` string[]: Email addresses of people to be notified whenever technicians specify that they don’t have the required trade certification/license while completing a refrigerant or HVAC work order via SC Provider. Available with the RefCertSCP feature flag. - `HVACDelayDays` integer: Time delay between the initial and the secondary verifications for HVAC assets. Specified in days. - `IndustrialRefrigerationDelayDays` integer: Time delay between the initial and the secondary verifications for assets of the industrial refrigeration group. Specified in days. - `CommercialRefrigerationDelayDays` integer: Time delay between the initial and the secondary verifications for assets of the commercial refrigeration type. Specified in days. - `OtherTypesDelayDays` integer: Time delay between the initial and the secondary verifications for other types of assets that don’t fall under the industrial refrigeration, commercial refrigeration, or HVAC groups. Specified in days. - `RefrigerationPriorityId` integer ## Other responses - `400`: The request is not accepted due to bad syntax, missing parameters, insufficient data, etc.
Error codes: 502 — No refrigerant tracking preferences are found for this subscriber 503 — Invalid subscriber - `401`: The requested resource requires authentication.
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)