This document describes the APIs used to add a Glow CAD to a user within the Glow Platform.Definitions#
| Term | Definition |
|---|
| Consent | Specific to the Smart Energy Code: formal process to capture permission from the User to retrieve their energy consumption and related data from their smart meters under the Terms and Conditions in place at the time their consent is captured. |
| MPxN | Meter point identifier, every property has a unique MPxN. MPAN identifies electricity meter, MPRN identifies gas meter. |
| SECAS | Smart Energy Code Administrator; regulate Hildebrand's ability to offer the service. |
| Terms and Conditions | Hildebrand's Terms and Conditions. Approved by SECAS. Version controlled. |
| User | Individual energy consumer (expected to have a valid smart meter). |
| Verification | Process whereby a User's smart meters are verified to confirm they are compatible with Hildebrand's ability to retrieve data from them. |
| Glow CAD | Glow Delta, Glow Wired, Glow IHD |
| SMETS | The SMETS version, it is either 1 or 2. |
CAD Fulfilment Eligibility Check API#
Before fulfilling a CAD order, it is recommended to verify that all prerequisites are met using the below API.Request#
Response#
Eligibility check is successful#
In the case of a successful eligibility check the response will look like thisEligibility check is not successful#
{
"error": "messsage",
"errorCode": "ERROR_CODE"
}
CAD Fulfilment API#
Request#
Response#
Fulfilment Successful#
In the case of a successful fufilment the response will look like thisFulfilment is not successful#
{
"error": "messsage",
"errorCode": "ERROR_CODE"
}
Error Codes#
| Code | Description | Applicable to Eligibility API |
|---|
| ERROR_INVALID_USER | User information provided is invalid. | ✅ |
| ERROR_MPXN_NOT_VERIFIED_AND_CONSENTED | The user does not have the provided MPxN verified. | ✅ |
| ERROR_MPXN_CANNOT_BE_DETERMINED | The mpxn parameter is optional. If not provided, the API attempts to locate a single MPAN. Failure to do so triggers this error. | ✅ |
| ERROR_MPXN_NOT_ONBOARDED | Consent exists for the given MPxN, but it has not been onboarded. (Unexpected scenario.) | ✅ |
| ERROR_MPXN_ALREADY_HAS_GLOW_CAD | A Glow CAD is already configured for that MPxN. | ✅ |
| ERROR_BAD_MPXN_INVENTORY | Issue retrieving the MPxN DCC inventory. | ✅ |
| ERROR_SMART_METER_INCOMPATIBLE_SMETS1_TRILLIANT | The smart meter is a SMETS1 Trilliant model, which Glow CADs cannot join. | ❌ |
| ERROR_SMART_METER_INCOMPATIBLE_SMETS | The Glow CAD and smart meter are not of the same SMETS version. | ❌ |
| ERROR_INVALID_ASSET | The Glow CAD is not recognized by the Glow Platform. | ❌ |
| ERROR_CAD_ALREADY_EXISTS | The Glow CAD is already onboarded to a different user. | ❌ |
| ERROR_CAD_ALREADY_ONBOARDED | The Glow CAD is already onboarded to a different user. | ❌ |
Modified at 2026-07-16 15:20:13
