Skip to main content

Input fields

chfDeviceId : String! required

Device ID of the CHF (Communications Hub Function).

installationCode : String! required

Code provided by manufacturer as part of ASN data, and included as part of device pre-notification, which is required to authorise device commissioning.

isLowPriority : Boolean

By default commission meter requests will be treated as high priority and use a pairing window of 10 minutes. Requests marked as low priority will result in a longer pairing window of 1 hour.

meterDeviceId : String! required

Device ID (ESME or GSME) of the device being commissioned.

meterType : MeterTypeChoices! required

Type of meter being commissioned.

mpxn : String
overrideExistingProcess : Boolean

By default only one commission meter process can be active at any one point per meter device. Setting this will abandon any existing process and start a new one.

scheduleAt : DateTime

The date and time to send the request to the meter. If not provided, or in the past, the request will be sent immediately.

serialNumber : String

Serial number for ESME or GSME devices.

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": "43583935", "installationCode": "must-surface-law-how-full", "isLowPriority": true, "meterDeviceId": "44624025", "meterType": "ELECTRICITY_METER", "mpxn": "magazine-soldier-usually-wish-affect", "overrideExistingProcess": true, "scheduleAt": "2009-02-20T00:56:09.742851+00:00", "serialNumber": "oil-order-catch-work-everybody" }