joinDeviceToNetwork
Send a request to the DCC to join a smart device to a HAN (Home Area Network).
Arguments
Device ID of the CHF (Communications Hub Function).
Code that authorises joining of the device to the HAN.
MPAN/MPRN of the meter or HCALCS to join to the HAN.
Device ID of the device to join to the HAN.
Type of device that is being joined to the HAN.
Returns
JoinDeviceToNetworkSend a request to the DCC to join a smart device to a HAN (Home Area Network).
Possible Errors
Allowed Viewers
Customer
Partner User
Third party
Required Permissions
Can commission smart metersQuery Complexity
1Examples
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.
mutation JoinDeviceToNetwork(
$chfDeviceId: String!,
$installCode: String,
$mpxn: String,
$newDeviceId: String!,
$newDeviceType: JoinableDeviceType!
) {
joinDeviceToNetwork(
chfDeviceId: $chfDeviceId,
installCode: $installCode,
mpxn: $mpxn,
newDeviceId: $newDeviceId,
newDeviceType: $newDeviceType
) {
requestReference
}
}
Variables
{
"chfDeviceId": "29420667",
"installCode": "indeed-adult-common-employee-teach",
"mpxn": "operation-expert-young-election-message",
"newDeviceId": "66472621",
"newDeviceType": "ELECTRICITY_METER"
}
Response
{
"data": {
"joinDeviceToNetwork": {
"requestReference": "reality-item-since-magazine-resource"
}
}
}