Service Reference Variant
Service details
Specific Errors
| Response Code | Response Code Description |
|---|---|
E080201 | The Request does not uniquely identify a Premises |
E080202 | The Premises do not contain any Devices |
Source: DUIS 3.8.104.3
GBCS Use Case
ReadInventoryDeviceIDReadInventoryMPxNReadInventoryPropertyFilterReadInventoryUPRNDUIS Service Definition
| Data Item | Description / Values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| UPRN | Unique Property Reference Number | sr:UPRN (Restriction of xs:positiveInteger (totalDigits = 12)) | No | None | N/A |
| DeviceID | Device ID of a device in the premises | sr:EUI (See clause 3.10.1.3) | No | None | N/A |
| MPxN | MPAN or MPRN associated to a Device in the premises | sr:ImportMPxN (Restriction of xs:string (minLength =1 maxLength = 13)) | No | None | N/A |
| PropertyFilter | PostCode and Address identifier that uniquely identify an address | sr:PropertyFilter | No | None | N/A |
| Data Item | Description / Values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| PostCode | Post Code of Metering Point This search criteria is case insensitive | sr:PostCode (Restriction of xs:string (minLength = 6 maxLength = 8)) | Yes | None | N/A |
| AddressIdentifier | Address Identifier (house number or house name), that combined with the Post Code, allows the identification of the premises This search criteria is case insensitive | sr:AddressIdentifier (Restriction of xs:string (maxLength = 30)) | Yes | None | N/A |
| Data Item | Description / Values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| Device | Minimum 1 and maximum 17 Devices | sr:Device maxOccurs = 17 | Yes | None | N/A |
| Per Device (complex type sr:Device) found at that Smart Metering System: | |||||
| DeviceID | Device ID of a Device in the Smart Metering System | sr:EUI (See clause 3.10.1.3) | Yes | None | N/A |
| DeviceType | The Type of device Valid set: ESME GSME GPF CHF HCALCS PPMID IHD CAD | sr:DeviceType (Restriction of xs:string (Enumeration)) | Yes | None | N/A |
| DeviceStatus | An indicator giving the status of the device Valid set: Pending Whitelisted InstalledNotCommissioned Commissioned Decommissioned Withdrawn Suspended Recovery Recovered Device Status is not applicable to Type 2 Devices, i.e. IHD and CAD | sr:DeviceStatus (Restriction of xs:string (Enumeration)) | Device Type = Type 2(IHD, CAD): N/A Otherwise: Yes | None | N/A |
| DeviceManufacturer | The name of the Device’s Manufacturer With the exception of IHD and CAD: • The Device Manufacturer is the <device_model_manufacturer_identifier> from the CPL and presented in the format XXXX where each X is one of the characters 0 to 9 or A to F • This data item matches the value on the CPL For IHD and CAD this data item is free text | sr:DeviceManufacturer (Restriction of xs:string (maxLength = 30)) | Yes | None | N/A |
| DeviceModel | The specific model of the device, as used by the manufacturer. With the exception of IHD and CAD: • The Device Model is the concatenation of <device_model .model_identifier>< device_model .hardware_version.version>< device_model .hardware_version.revision> from the CPL and presented in the format XXXXXXXX where each X is one of the characters 0 to 9 or A to F Where: • the first 4 characters are the model identifier • the next 2 characters are the hardware version.version • the final 2 characters are the hardware version.revision • This data item matches the value on the CPL For IHD and CAD this data item is free text | sr:DeviceModel (Restricyion of xs:string (maxLength = 30)) | Yes | None | N/A |
| SMETSCHTSVersion | The version of SMETS or CHTS that the device complies with. This should align with the SMETS_CHTS version version_number value contained on the CPL. | sr:SMETSCHYSVersion (Restriction of xs:string (minLength = 1, maxLength = 20)) | Device Type = CAD: N/A Otherwise: Yes | None | N/A |
| DeviceFirmwareVersion | The operational version of Firmware of the Device The Firmware version as held in the CPL and presented in the format XXXXXXXX where each X is one of the characters 0 to 9 or A to F. This data item matches the value on the CPLA The binary value shall be four octets in length and shall correspond to the File Version field in the ZSE OTA Header structure. | Restriction of xs:string (minLength = 1, maxLength = 8) | Device includes Firmware: Yes Otherwise: N/A | None | N/A |
| DeviceFirmwareVersionStatus | The status of the Firmware Version Valid set: Active Cancelled Expired Withdrawn The status displayed in DeviceFirmwareVersionStatus maps to the status on the Central Products List as per the Data Item values to CPL values Mapping table below: | sr:FirmwareVersionStatus (Restriction of xs:string (Enumeration)) | Device includes Firmware: Yes Otherwise: N/A | None | N/A |
| CPLStatus | The CPL Assurance Certificate Status Valid set: Active Cancelled Expired Withdrawn The status displayed in CPL Status maps to the status on the Central Products List as per the Data Item values to CPL values Mapping table below: | sr:CPLStatus (Restriction of xs:string (Enumeration)) | Device includes Firmware: Yes Otherwise: N/A | None | N/A |
| DateCommissioned | Where applicable, the date when the Device was commissioned | xs:date | Device Type = IHD,CAD: N/A Device has been commissioned: Yes Otherwise: No | None | UTC Date |
| ImportMPxN | The reference number identifying an import electricity or a gas metering point | sr:ImportMPxN Restriction of xs:string (minLength = 1, maxLength = 13) | Device Type = ESME, GSME: No Otherwise: N/A | None | N/A |
| SecondaryImportMPAN | The reference number identifying a Twin Element Import electricity secondary metering point | sr:MPAN Restriction of xs:string (minLength = 13, maxLength = 13) | Device Type = ESME and ESME Variant = B: No Otherwise: N/A | None | N/A |
| ExportMPAN | The reference number identifying an export electricity metering point | sr:MPAN Restriction of xs:string (minLength = 13, maxLength = 13) | Device Type = ESME and includes Export capability: No Otherwise: N/A | None | N/A |
| ESMEVariant | See Table 229 for mapping and valid set. Values including F or G are not applicable to Devices prior to GBCS v4.0 | sr:ESMEVariant Restriction of xs:string (Enumeration) | Device Type = ESME: Yes Otherwise: N/A | None | N/A |
| UPRN | Unique Property Reference Number | sr:URPN (Restriction of xs:positiveInteger (totalDigits = 12)) | No | None | N/A |
| PropertyFilter | Post Code and Address Identifier that uniquely identifies an address | sr:PropertyFilter | No | None | N/A |
| CSPRegion | The CSP Region the Smart Meter System is associated with Valid set: North Central South 4G Central 4G South 4G North Unknown | sr:CSPRegion (Restriction of xs:string (Enumeration)) | No | None | N/A |
| DeviceGBCSVersion | The operational version of GBCS as recorded in the SMI for the Device. The version number format will align with the CPL. For example 1.0 or 2.0 | xs:string | Device includes Firmware: Yes Otherwise: N/A | None | N/A |
| HANVariant | The Device’s HAN Variant. Valid Set: Single Band (2.4GHz only) Dual Band (868MHz and 2.4GHz) Unknown HAN Variant (The CPL CHF Device Manufacturer and Device Model define its HAN Variant and the DCC Systems hold this relationship. When a CH is pre-notified to the DCC, its CHF HAN Variant is set based on its Device Manufacturer and Device Model) | xs:string | DeviceType = CHF: Yes Otherwise: N/A | None | N/A |
| Connectivity | If a Virtual WAN Device has been joined to the CHF, specifies the network used to currently communicate with the CHF. Valid set: Virtual Cellular This attribute will only be present if a Virtual WAN Device has been joined to the CHF. | sr:Connectivity (Restriction of xs:string (Enumeration)) | DeviceType = CHF: No Otherwise: N/A | None | N/A |
| Status value on the Central Products List (CPL) | DeviceFirmwareVersionStatus value | CPLStatus value |
|---|---|---|
| Current | Active | Active |
| Removed | Cancelled | Cancelled |
| No value defined | Expired (not currently used) | Expired (not currently used) |
| No value defined | Withdrawn (not currently used) | Withdrawn (not currently used) |
| Central Products List (CPL) device type | DUIS device type | DUIS ESMEVariant Valid set |
|---|---|---|
| Single Element Electricity Metering Equipment | ESME | A. Single Element ESME AD. Single Element ESME with ALCS ADE. Single Element ESME with ALCS and Boost Function ADF. Single Element ESME with ALCS and APC ADEF. Single Element ESME with ALCS, Boost Function and APC AEF. Single Element ESME with Boost Function and APC AF. Single Element ESME with APC AG. SAPC AEG. SAPC with Boost Function ADG. SAPC with ALCS ADEG. SAPC with ALCS and Boost Function |
| Twin Element Electricity Metering Equipment | ESME | B. Twin Element ESME BD. Twin Element ESME with ALCS BDE. Twin Element ESME with ALCS and Boost Function BF. Twin Element ESME with APC BDF. Twin Element ESME with ALCS and APC BDEF. Twin Element ESME with ALCS, Boost Function and APC BEF. Twin Element ESME with Boost Function and APC |
| Polyphase Element Electricity Metering Equipment | ESME | C. Polyphase ESME CD. Polyphase ESME with ALCS CDE. Polyphase ESME with ALCS and Boost Function CDEF. Polyphase with ALCS, Boost Function and APC CF. Polyphase with APC CDF. Polyphase with ALCS and APC CEF. Polyphase with Boost Function and APC |
| Gas Smart Meter | GSME | N/A |
| Prepayment Interface Device | PPMID | N/A |
| HAN Connected Auxiliary Load Control Switch | HCALCS | N/A |
Message Patterns & Examples