Skip to main content

Input fields

chfDeviceId : String! required

Device ID of the CHF (Communications Hub Function).

consumerDeviceId : String! required

Device ID (IHD, PPMID, CAD or Alt HAN) of the device being added to the CHF.

consumerDeviceType : JoinConsumerDeviceChoices! required

The device type being joined to the CHF.

fuelType : FuelTypeChoices

The fuel type of the device, electricity, gas or dual fuel.

installationCode : String

Code provided by manufacturer as part of ASN data, and included as part of device pre-notification, which can be required to authorise the joined device.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "chfDeviceId": "51002963", "consumerDeviceId": "19157168", "consumerDeviceType": "PPMID", "fuelType": "ELECTRICITY", "installationCode": "blood-however-manage-beyond-cost" }