PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

GetSiteInfo

Returns basic info for a site in PowerSuite given an account site id or uprn

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/GetSiteInfo"

<?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>
    <GetSiteInfo xmlns="http://webservices.whitespacews.com/">
      <siteInfoInput />
    </GetSiteInfo>
  </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>
    <GetSiteInfoResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteInfoResult>
        <Site>
          <ExtensionData />
          <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>
            <ExtensionData xsi:nil="true" />
            <SiteID>int</SiteID>
            <SiteName>string</SiteName>
            <SiteAddressPrefix>string</SiteAddressPrefix>
            <SiteAddressName>string</SiteAddressName>
            <SiteShortAddress>string</SiteShortAddress>
            <SiteAddressNumber>string</SiteAddressNumber>
            <SiteAddress1>string</SiteAddress1>
            <SiteAddress2>string</SiteAddress2>
            <SiteTown>string</SiteTown>
            <SiteCity>string</SiteCity>
            <SiteCounty>string</SiteCounty>
            <SiteCountry>string</SiteCountry>
            <SitePostCode>string</SitePostCode>
            <SiteReference>string</SiteReference>
            <AccountID>int</AccountID>
            <AccountGroupCode>string</AccountGroupCode>
            <AccountGroupName>string</AccountGroupName>
            <SiteCreatedDate>string</SiteCreatedDate>
            <SiteClosedDate>string</SiteClosedDate>
            <SiteStoppedDate>string</SiteStoppedDate>
            <SiteLatitude>double</SiteLatitude>
            <SiteLongitude>double</SiteLongitude>
            <SiteNorthing>double</SiteNorthing>
            <SiteEasting>double</SiteEasting>
            <ServiceChargeTypeID>int</ServiceChargeTypeID>
            <ServiceChargeTypeName>string</ServiceChargeTypeName>
            <StreetID>int</StreetID>
            <StreetName>string</StreetName>
            <SiteIsContract>boolean</SiteIsContract>
            <SiteIsNonContract>boolean</SiteIsNonContract>
            <SiteNoInvoice>boolean</SiteNoInvoice>
            <SiteNotes>string</SiteNotes>
            <SiteParentID>int</SiteParentID>
            <AuthorityID>int</AuthorityID>
            <SiteFullAddress>string</SiteFullAddress>
          </Site>
        </Site>
      </GetSiteInfoResult>
    </GetSiteInfoResponse>
  </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>
    <GetSiteInfo xmlns="http://webservices.whitespacews.com/">
      <siteInfoInput />
    </GetSiteInfo>
  </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>
    <GetSiteInfoResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteInfoResult>
        <Site>
          <ExtensionData />
          <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>
            <ExtensionData xsi:nil="true" />
            <SiteID>int</SiteID>
            <SiteName>string</SiteName>
            <SiteAddressPrefix>string</SiteAddressPrefix>
            <SiteAddressName>string</SiteAddressName>
            <SiteShortAddress>string</SiteShortAddress>
            <SiteAddressNumber>string</SiteAddressNumber>
            <SiteAddress1>string</SiteAddress1>
            <SiteAddress2>string</SiteAddress2>
            <SiteTown>string</SiteTown>
            <SiteCity>string</SiteCity>
            <SiteCounty>string</SiteCounty>
            <SiteCountry>string</SiteCountry>
            <SitePostCode>string</SitePostCode>
            <SiteReference>string</SiteReference>
            <AccountID>int</AccountID>
            <AccountGroupCode>string</AccountGroupCode>
            <AccountGroupName>string</AccountGroupName>
            <SiteCreatedDate>string</SiteCreatedDate>
            <SiteClosedDate>string</SiteClosedDate>
            <SiteStoppedDate>string</SiteStoppedDate>
            <SiteLatitude>double</SiteLatitude>
            <SiteLongitude>double</SiteLongitude>
            <SiteNorthing>double</SiteNorthing>
            <SiteEasting>double</SiteEasting>
            <ServiceChargeTypeID>int</ServiceChargeTypeID>
            <ServiceChargeTypeName>string</ServiceChargeTypeName>
            <StreetID>int</StreetID>
            <StreetName>string</StreetName>
            <SiteIsContract>boolean</SiteIsContract>
            <SiteIsNonContract>boolean</SiteIsNonContract>
            <SiteNoInvoice>boolean</SiteNoInvoice>
            <SiteNotes>string</SiteNotes>
            <SiteParentID>int</SiteParentID>
            <AuthorityID>int</AuthorityID>
            <SiteFullAddress>string</SiteFullAddress>
          </Site>
        </Site>
      </GetSiteInfoResult>
    </GetSiteInfoResponse>
  </soap12:Body>
</soap12:Envelope>