Input fields

chfConnectionMethod : CHFConnectionMethod

How the CHF was installed and connected to the rest of the Smart Metering System.
chfDeviceId : String! required

Device ID of the CHF (Communications Hub Function).
chfInstallType : CHFInstallType

Is it a new or replacement CHF?
chfLocation : CHFLocation

Location of the CHF.
faultReason : CHFFaultReason

The engineer's description of the fault.
faultReturnType : CHFFaultReturnType

Whether a fault was identified before or after the installation.
hasAerialInstalled : Boolean

Was an external aerial installed?
hasConnectivityObstruction : Boolean

In the case of NO_SM_WAN, was the issue a thick stone wall obstruction (as defined in CHSM)?
hasMetalObstruction : Boolean

In the case of NO_SM_WAN, was the issue a local metal obstruction (as defined in CHSM)?
hasSharedObstruction : Boolean

In the case of NO_SM_WAN, was the CHF in a shared/communal area (as defined in CHSM)?
mpan : String

MPAN of the meter point linked to the CHF.
Deprecation
The 'mpan' field is deprecated.

Use mpxn instead.

- Marked as deprecated on 2022-11-07.
- Scheduled for removal on or after 2023-11-07.
mpxn : String

MPxN of a meter point linked to the CHF.
noFaultReturnType : CHFNoFaultReturnType

In the case of NO_FAULT_RETURN, the reason for the meter not being installed.
premiseType : PremiseType

Type of the premise in which the CHF is located.
updateType : CommsHubStatusUpdateType! required

The type of status update to be sent.
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

{ "chfConnectionMethod": "HOT_SHOE", "chfDeviceId": "39296666", "chfInstallType": "NEW", "chfLocation": "OUTSIDE", "faultReason": "DAMAGED_CASE", "faultReturnType": "PRIOR_TO_INSTALLATION", "hasAerialInstalled": true, "hasConnectivityObstruction": true, "hasMetalObstruction": true, "hasSharedObstruction": true, "mpxn": "move-get-watch-wide-billion", "noFaultReturnType": "GENERAL", "premiseType": "DETACHED_OR_SEMI", "updateType": "SUCCESS" }