PowerSuiteWebService
Click here for a complete list of operations.
GetSites
Returns basic info for all sites in PowerSuite given a uprn or usrn
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /PowerSuiteDomesticWebService.asmx HTTP/1.1
Host: udtapi-municipal-test.whitespacews.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://webservices.whitespacews.com/GetSites"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSites xmlns="http://webservices.whitespacews.com/">
<sitesInput>
<Uprn>string</Uprn>
</sitesInput>
</GetSites>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetSitesResponse xmlns="http://webservices.whitespacews.com/">
<GetSitesResult>
<SiteArray>
<AccountSite>
<ExtensionData xsi:nil="true" />
<AccountSiteID>int</AccountSiteID>
<AccountSiteUPRN>decimal</AccountSiteUPRN>
<BusinessTypeCode>string</BusinessTypeCode>
<BusinessTypeName>string</BusinessTypeName>
<SalesZoneCode>string</SalesZoneCode>
<SalesZoneName>string</SalesZoneName>
<AccountSiteStatusID>int</AccountSiteStatusID>
<AccountSiteStatusName>string</AccountSiteStatusName>
<AreaID>int</AreaID>
<AreaName>string</AreaName>
<AccountSiteTypeID>int</AccountSiteTypeID>
<AccountSiteTypeName>string</AccountSiteTypeName>
<ParishID>int</ParishID>
<ParishName>string</ParishName>
<WardID>int</WardID>
<WardName>string</WardName>
<NumChildren>int</NumChildren>
<Site xsi:nil="true" />
</AccountSite>
<AccountSite>
<ExtensionData xsi:nil="true" />
<AccountSiteID>int</AccountSiteID>
<AccountSiteUPRN>decimal</AccountSiteUPRN>
<BusinessTypeCode>string</BusinessTypeCode>
<BusinessTypeName>string</BusinessTypeName>
<SalesZoneCode>string</SalesZoneCode>
<SalesZoneName>string</SalesZoneName>
<AccountSiteStatusID>int</AccountSiteStatusID>
<AccountSiteStatusName>string</AccountSiteStatusName>
<AreaID>int</AreaID>
<AreaName>string</AreaName>
<AccountSiteTypeID>int</AccountSiteTypeID>
<AccountSiteTypeName>string</AccountSiteTypeName>
<ParishID>int</ParishID>
<ParishName>string</ParishName>
<WardID>int</WardID>
<WardName>string</WardName>
<NumChildren>int</NumChildren>
<Site xsi:nil="true" />
</AccountSite>
</SiteArray>
</GetSitesResult>
</GetSitesResponse>
</soap:Body>
</soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /PowerSuiteDomesticWebService.asmx HTTP/1.1
Host: udtapi-municipal-test.whitespacews.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSites xmlns="http://webservices.whitespacews.com/">
<sitesInput>
<Uprn>string</Uprn>
</sitesInput>
</GetSites>
</soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
<soap12:Body>
<GetSitesResponse xmlns="http://webservices.whitespacews.com/">
<GetSitesResult>
<SiteArray>
<AccountSite>
<ExtensionData xsi:nil="true" />
<AccountSiteID>int</AccountSiteID>
<AccountSiteUPRN>decimal</AccountSiteUPRN>
<BusinessTypeCode>string</BusinessTypeCode>
<BusinessTypeName>string</BusinessTypeName>
<SalesZoneCode>string</SalesZoneCode>
<SalesZoneName>string</SalesZoneName>
<AccountSiteStatusID>int</AccountSiteStatusID>
<AccountSiteStatusName>string</AccountSiteStatusName>
<AreaID>int</AreaID>
<AreaName>string</AreaName>
<AccountSiteTypeID>int</AccountSiteTypeID>
<AccountSiteTypeName>string</AccountSiteTypeName>
<ParishID>int</ParishID>
<ParishName>string</ParishName>
<WardID>int</WardID>
<WardName>string</WardName>
<NumChildren>int</NumChildren>
<Site xsi:nil="true" />
</AccountSite>
<AccountSite>
<ExtensionData xsi:nil="true" />
<AccountSiteID>int</AccountSiteID>
<AccountSiteUPRN>decimal</AccountSiteUPRN>
<BusinessTypeCode>string</BusinessTypeCode>
<BusinessTypeName>string</BusinessTypeName>
<SalesZoneCode>string</SalesZoneCode>
<SalesZoneName>string</SalesZoneName>
<AccountSiteStatusID>int</AccountSiteStatusID>
<AccountSiteStatusName>string</AccountSiteStatusName>
<AreaID>int</AreaID>
<AreaName>string</AreaName>
<AccountSiteTypeID>int</AccountSiteTypeID>
<AccountSiteTypeName>string</AccountSiteTypeName>
<ParishID>int</ParishID>
<ParishName>string</ParishName>
<WardID>int</WardID>
<WardName>string</WardName>
<NumChildren>int</NumChildren>
<Site xsi:nil="true" />
</AccountSite>
</SiteArray>
</GetSitesResult>
</GetSitesResponse>
</soap12:Body>
</soap12:Envelope>