Service Reference Variant
Service details
Specific Errors
| Response Code | Response Code Description |
|---|---|
E120101 | No premises can be identified from the Request |
E120102 | No SM WAN data exists for the requested location (property) |
E120103 | No SM WAN coverage data available for CSP Region |
Source: DUIS 3.8.127.3
GBCS Use Case
RequestWANMatrixDUIS Service Definition
| Data Item | Description / Allowable values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| UPRN | Unique Property Reference Number | sr:UPRN (Restriction of xs:positiveInteger (totalDigits = 12)) | One item and only one item must be set | None | N/A |
| PartialAddress | Postcode and Address Identifier that uniquely identify an address | sr:PartialAddress | One item and only one item must be set | None | N/A |
| Data Item | Description / Allowable values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| PostCode | Postcode 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 Postcode, 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 / Allowable values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| Request | Input details of the Request, i.e. UPRN or Partial Address | sr:RequestWANMatrix | Yes | None | N/A |
| DSPWANMatrixResponse | Array of responses for each CSP Region | Sr:DSPWANMatrixResponse | Yes | None | N/A |
| Data Item | Description / Allowable values | Type | Mandatory | Default | Units |
|---|---|---|---|---|---|
| CSPRegion | The CSP Region the address is associated with Valid set: North Central South 4G Central 4G South 4G North | sr:CSPRegion (Restriction of xs:string (Enumeration)) | Yes | None | N/A |
| CSPRegionResponseCode | The outcome for a single CSP Region Valid set: • I0 • E120101 • E120102 • E120103 | sr:ResponseCode | Yes | None | N/A |
| CoverageAvailability | Coverage Availability Valid set: true. (Yes) false. (No) | xs:boolean | CSPRegionResponseCode = I0: Yes Otherwise: N/A | None | N/A |
| AnticipatedCoverageDate | If Coverage Availability is set to false, the anticipated date when Coverage will be available. If no Coverage is planned then this date will be set to ‘3000-12-31T00:00:00Z’ | xs:date | Coverage Availability = false: Yes Otherwise: N/A | None | N/A |
| WANTechnology | The WAN technology to be used for this location The allowable values shall be in line with Equipment names as defined and maintained within Annex E of the CH INSTALLATION AND MAINTENANCE SUPPORT MATERIALS | sr:WANTechnologyType (Restriction of xs:string (maxLength = 30)) | CSPRegionResponseCode = I0: Yes Otherwise: N/A | None | N/A |
| ConnectivityLikelihood | The likely Connectivity strength Valid set: High Medium Low | Restriction of xs:string (Enumeration) | CSPRegionResponseCode = I0: Yes Otherwise: N/A | None | N/A |
| AuxiliaryEquipmentRequired | Free text with details of any required auxiliary equipment, if any | Restriction of xs:string (maxLength = 50) | No | None | N/A |
| AdditionalInformation | Free text providing additional information | Restriction of xs:string (maxLength = 250) | No | None | N/A |
Message Patterns & Examples