GET request/water/customer/site/search?postcode={postcode}&wspid={wspid}&sspid={sspid}&EnglandOrScotland={EnglandOrScotland}
Displays Site meter details for a particular Postcode or SPID or SSPID
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
EnglandOrScotland | byte |
None. |
|
postcode | string |
None. |
|
sspid | string |
None. |
|
wspid | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of WaterSiteName | Description | Type | Additional information |
---|---|---|---|
Address | string |
None. |
|
City | string |
None. |
|
CmosSiteId | integer |
None. |
|
ContractEndDate | date |
None. |
|
County | string |
None. |
|
EnglandOrScotland | byte |
None. |
|
Line1 | string |
None. |
|
Line2 | string |
None. |
|
Meters | Collection of WaterSiteMeter |
None. |
|
PartialCustomer | boolean |
None. |
|
Postcode | string |
None. |
|
SCustomer | string |
None. |
|
Spid | string |
None. |
|
SSPID | string |
None. |
|
WCustomer | string |
None. |
Response Formats
application/json, text/json
Sample:
[ { "address": "sample string 1", "line1": "sample string 2", "line2": "sample string 3", "city": "sample string 4", "county": "sample string 5", "postcode": "sample string 6", "spid": "sample string 7", "cmosSiteId": 8, "meters": [ { "mugMeterId": 1, "cmosSiteID": 1, "mugSiteID": 1, "cmaSiteID": 1, "cmaMeterID": 1, "cmosMeterId": 1, "meterTypeID": 64, "type": "sample string 1", "meterNumber": "sample string 2", "volume": 1.0, "pipeSize": 1, "waterChargableMeterSize": 1, "sewerChargableMeterSize": 1, "assessedChargableMeterSize": 1 }, { "mugMeterId": 1, "cmosSiteID": 1, "mugSiteID": 1, "cmaSiteID": 1, "cmaMeterID": 1, "cmosMeterId": 1, "meterTypeID": 64, "type": "sample string 1", "meterNumber": "sample string 2", "volume": 1.0, "pipeSize": 1, "waterChargableMeterSize": 1, "sewerChargableMeterSize": 1, "assessedChargableMeterSize": 1 } ], "contractEndDate": "2025-06-26T20:48:41.2359603+00:00", "sspid": "sample string 9", "wCustomer": "sample string 10", "sCustomer": "sample string 11", "englandOrScotland": 64, "partialCustomer": true }, { "address": "sample string 1", "line1": "sample string 2", "line2": "sample string 3", "city": "sample string 4", "county": "sample string 5", "postcode": "sample string 6", "spid": "sample string 7", "cmosSiteId": 8, "meters": [ { "mugMeterId": 1, "cmosSiteID": 1, "mugSiteID": 1, "cmaSiteID": 1, "cmaMeterID": 1, "cmosMeterId": 1, "meterTypeID": 64, "type": "sample string 1", "meterNumber": "sample string 2", "volume": 1.0, "pipeSize": 1, "waterChargableMeterSize": 1, "sewerChargableMeterSize": 1, "assessedChargableMeterSize": 1 }, { "mugMeterId": 1, "cmosSiteID": 1, "mugSiteID": 1, "cmaSiteID": 1, "cmaMeterID": 1, "cmosMeterId": 1, "meterTypeID": 64, "type": "sample string 1", "meterNumber": "sample string 2", "volume": 1.0, "pipeSize": 1, "waterChargableMeterSize": 1, "sewerChargableMeterSize": 1, "assessedChargableMeterSize": 1 } ], "contractEndDate": "2025-06-26T20:48:41.2359603+00:00", "sspid": "sample string 9", "wCustomer": "sample string 10", "sCustomer": "sample string 11", "englandOrScotland": 64, "partialCustomer": true } ]
text/html
Sample:
[{"address":"sample string 1","line1":"sample string 2","line2":"sample string 3","city":"sample string 4","county":"sample string 5","postcode":"sample string 6","spid":"sample string 7","cmosSiteId":8,"meters":[{"mugMeterId":1,"cmosSiteID":1,"mugSiteID":1,"cmaSiteID":1,"cmaMeterID":1,"cmosMeterId":1,"meterTypeID":64,"type":"sample string 1","meterNumber":"sample string 2","volume":1.0,"pipeSize":1,"waterChargableMeterSize":1,"sewerChargableMeterSize":1,"assessedChargableMeterSize":1},{"mugMeterId":1,"cmosSiteID":1,"mugSiteID":1,"cmaSiteID":1,"cmaMeterID":1,"cmosMeterId":1,"meterTypeID":64,"type":"sample string 1","meterNumber":"sample string 2","volume":1.0,"pipeSize":1,"waterChargableMeterSize":1,"sewerChargableMeterSize":1,"assessedChargableMeterSize":1}],"contractEndDate":"2025-06-26T20:48:41.2359603+00:00","sspid":"sample string 9","wCustomer":"sample string 10","sCustomer":"sample string 11","englandOrScotland":64,"partialCustomer":true},{"address":"sample string 1","line1":"sample string 2","line2":"sample string 3","city":"sample string 4","county":"sample string 5","postcode":"sample string 6","spid":"sample string 7","cmosSiteId":8,"meters":[{"mugMeterId":1,"cmosSiteID":1,"mugSiteID":1,"cmaSiteID":1,"cmaMeterID":1,"cmosMeterId":1,"meterTypeID":64,"type":"sample string 1","meterNumber":"sample string 2","volume":1.0,"pipeSize":1,"waterChargableMeterSize":1,"sewerChargableMeterSize":1,"assessedChargableMeterSize":1},{"mugMeterId":1,"cmosSiteID":1,"mugSiteID":1,"cmaSiteID":1,"cmaMeterID":1,"cmosMeterId":1,"meterTypeID":64,"type":"sample string 1","meterNumber":"sample string 2","volume":1.0,"pipeSize":1,"waterChargableMeterSize":1,"sewerChargableMeterSize":1,"assessedChargableMeterSize":1}],"contractEndDate":"2025-06-26T20:48:41.2359603+00:00","sspid":"sample string 9","wCustomer":"sample string 10","sCustomer":"sample string 11","englandOrScotland":64,"partialCustomer":true}]
application/xml, text/xml
Sample:
<ArrayOfWaterSite xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.WaterSiteDto"> <WaterSite> <Address>sample string 1</Address> <City>sample string 4</City> <CmosSiteId>8</CmosSiteId> <ContractEndDate>2025-06-26T20:48:41.2359603+00:00</ContractEndDate> <County>sample string 5</County> <EnglandOrScotland>64</EnglandOrScotland> <Line1>sample string 2</Line1> <Line2>sample string 3</Line2> <Meters> <WaterSiteMeter> <AssessedChargableMeterSize>1</AssessedChargableMeterSize> <CMAMeterID>1</CMAMeterID> <CMASiteID>1</CMASiteID> <CMOSSiteID>1</CMOSSiteID> <CmosMeterId>1</CmosMeterId> <MeterNumber>sample string 2</MeterNumber> <MeterTypeID>64</MeterTypeID> <MugMeterId>1</MugMeterId> <MugSiteID>1</MugSiteID> <PipeSize>1</PipeSize> <SewerChargableMeterSize>1</SewerChargableMeterSize> <Type>sample string 1</Type> <Volume>1</Volume> <WaterChargableMeterSize>1</WaterChargableMeterSize> </WaterSiteMeter> <WaterSiteMeter> <AssessedChargableMeterSize>1</AssessedChargableMeterSize> <CMAMeterID>1</CMAMeterID> <CMASiteID>1</CMASiteID> <CMOSSiteID>1</CMOSSiteID> <CmosMeterId>1</CmosMeterId> <MeterNumber>sample string 2</MeterNumber> <MeterTypeID>64</MeterTypeID> <MugMeterId>1</MugMeterId> <MugSiteID>1</MugSiteID> <PipeSize>1</PipeSize> <SewerChargableMeterSize>1</SewerChargableMeterSize> <Type>sample string 1</Type> <Volume>1</Volume> <WaterChargableMeterSize>1</WaterChargableMeterSize> </WaterSiteMeter> </Meters> <PartialCustomer>true</PartialCustomer> <Postcode>sample string 6</Postcode> <SCustomer>sample string 11</SCustomer> <SSPID>sample string 9</SSPID> <Spid>sample string 7</Spid> <WCustomer>sample string 10</WCustomer> </WaterSite> <WaterSite> <Address>sample string 1</Address> <City>sample string 4</City> <CmosSiteId>8</CmosSiteId> <ContractEndDate>2025-06-26T20:48:41.2359603+00:00</ContractEndDate> <County>sample string 5</County> <EnglandOrScotland>64</EnglandOrScotland> <Line1>sample string 2</Line1> <Line2>sample string 3</Line2> <Meters> <WaterSiteMeter> <AssessedChargableMeterSize>1</AssessedChargableMeterSize> <CMAMeterID>1</CMAMeterID> <CMASiteID>1</CMASiteID> <CMOSSiteID>1</CMOSSiteID> <CmosMeterId>1</CmosMeterId> <MeterNumber>sample string 2</MeterNumber> <MeterTypeID>64</MeterTypeID> <MugMeterId>1</MugMeterId> <MugSiteID>1</MugSiteID> <PipeSize>1</PipeSize> <SewerChargableMeterSize>1</SewerChargableMeterSize> <Type>sample string 1</Type> <Volume>1</Volume> <WaterChargableMeterSize>1</WaterChargableMeterSize> </WaterSiteMeter> <WaterSiteMeter> <AssessedChargableMeterSize>1</AssessedChargableMeterSize> <CMAMeterID>1</CMAMeterID> <CMASiteID>1</CMASiteID> <CMOSSiteID>1</CMOSSiteID> <CmosMeterId>1</CmosMeterId> <MeterNumber>sample string 2</MeterNumber> <MeterTypeID>64</MeterTypeID> <MugMeterId>1</MugMeterId> <MugSiteID>1</MugSiteID> <PipeSize>1</PipeSize> <SewerChargableMeterSize>1</SewerChargableMeterSize> <Type>sample string 1</Type> <Volume>1</Volume> <WaterChargableMeterSize>1</WaterChargableMeterSize> </WaterSiteMeter> </Meters> <PartialCustomer>true</PartialCustomer> <Postcode>sample string 6</Postcode> <SCustomer>sample string 11</SCustomer> <SSPID>sample string 9</SSPID> <Spid>sample string 7</Spid> <WCustomer>sample string 10</WCustomer> </WaterSite> </ArrayOfWaterSite>