joinConsumerDevice

Triggers the orchestration to join the PPMID, IHD, CAD or Alt HAN device to the ESME, GSME, GPF and/or CHF. This should be called after a meter has been commissioned.

Arguments

input : JoinConsumerDeviceInput!


            required

Input fields for join device.

Returns

JoinConsumerDevice

Triggers the orchestration to join the PPMID, IHD, CAD or Alt HAN device to the ESME, GSME, GPF and/or CHF. This should be called after a meter has been commissioned.

Possible Errors

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can access customer queries
OR Can commission smart meters
OR Can manage consumer devices

Query Complexity

Examples

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 JoinConsumerDevice($input: JoinConsumerDeviceInput!) {
  joinConsumerDevice(input: $input) {
    requestReference
  }
}

{
  "input": JoinConsumerDeviceInput
}

{
  "data": {
    "joinConsumerDevice": {
      "requestReference": "around-end-same-employee-herself"
    }
  }
}