PowerSuiteWebService Web Service

PowerSuiteWebService

Click here for a complete list of operations.

GetSiteContacts

Returns all contacts in PowerSuite for a given site

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

<?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>
    <GetSiteContacts xmlns="http://webservices.whitespacews.com/">
      <siteContactInput />
    </GetSiteContacts>
  </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>
    <GetSiteContactsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteContactsResult xmlns="http://webservices.whitespacews.com/Contacts">
        <Contacts>
          <Contact>
            <ExtensionData xsi:nil="true" />
            <ContactID>int</ContactID>
            <ContactName>string</ContactName>
            <ContactCode>string</ContactCode>
            <ContactHREF>string</ContactHREF>
            <ContactTitle>string</ContactTitle>
            <ContactFirstName>string</ContactFirstName>
            <ContactMiddleName>string</ContactMiddleName>
            <ContactLastName>string</ContactLastName>
            <ContactLocation>string</ContactLocation>
            <ContactSalesZone>string</ContactSalesZone>
            <UPRN>decimal</UPRN>
            <ContactTelephoneNumber>string</ContactTelephoneNumber>
            <ContactMobileNumber>string</ContactMobileNumber>
            <ContactFaxNumber>string</ContactFaxNumber>
            <ContactEmail>string</ContactEmail>
            <MainContact>boolean</MainContact>
            <Site xsi:nil="true" />
          </Contact>
          <Contact>
            <ExtensionData xsi:nil="true" />
            <ContactID>int</ContactID>
            <ContactName>string</ContactName>
            <ContactCode>string</ContactCode>
            <ContactHREF>string</ContactHREF>
            <ContactTitle>string</ContactTitle>
            <ContactFirstName>string</ContactFirstName>
            <ContactMiddleName>string</ContactMiddleName>
            <ContactLastName>string</ContactLastName>
            <ContactLocation>string</ContactLocation>
            <ContactSalesZone>string</ContactSalesZone>
            <UPRN>decimal</UPRN>
            <ContactTelephoneNumber>string</ContactTelephoneNumber>
            <ContactMobileNumber>string</ContactMobileNumber>
            <ContactFaxNumber>string</ContactFaxNumber>
            <ContactEmail>string</ContactEmail>
            <MainContact>boolean</MainContact>
            <Site xsi:nil="true" />
          </Contact>
        </Contacts>
      </GetSiteContactsResult>
    </GetSiteContactsResponse>
  </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>
    <GetSiteContacts xmlns="http://webservices.whitespacews.com/">
      <siteContactInput />
    </GetSiteContacts>
  </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>
    <GetSiteContactsResponse xmlns="http://webservices.whitespacews.com/">
      <GetSiteContactsResult xmlns="http://webservices.whitespacews.com/Contacts">
        <Contacts>
          <Contact>
            <ExtensionData xsi:nil="true" />
            <ContactID>int</ContactID>
            <ContactName>string</ContactName>
            <ContactCode>string</ContactCode>
            <ContactHREF>string</ContactHREF>
            <ContactTitle>string</ContactTitle>
            <ContactFirstName>string</ContactFirstName>
            <ContactMiddleName>string</ContactMiddleName>
            <ContactLastName>string</ContactLastName>
            <ContactLocation>string</ContactLocation>
            <ContactSalesZone>string</ContactSalesZone>
            <UPRN>decimal</UPRN>
            <ContactTelephoneNumber>string</ContactTelephoneNumber>
            <ContactMobileNumber>string</ContactMobileNumber>
            <ContactFaxNumber>string</ContactFaxNumber>
            <ContactEmail>string</ContactEmail>
            <MainContact>boolean</MainContact>
            <Site xsi:nil="true" />
          </Contact>
          <Contact>
            <ExtensionData xsi:nil="true" />
            <ContactID>int</ContactID>
            <ContactName>string</ContactName>
            <ContactCode>string</ContactCode>
            <ContactHREF>string</ContactHREF>
            <ContactTitle>string</ContactTitle>
            <ContactFirstName>string</ContactFirstName>
            <ContactMiddleName>string</ContactMiddleName>
            <ContactLastName>string</ContactLastName>
            <ContactLocation>string</ContactLocation>
            <ContactSalesZone>string</ContactSalesZone>
            <UPRN>decimal</UPRN>
            <ContactTelephoneNumber>string</ContactTelephoneNumber>
            <ContactMobileNumber>string</ContactMobileNumber>
            <ContactFaxNumber>string</ContactFaxNumber>
            <ContactEmail>string</ContactEmail>
            <MainContact>boolean</MainContact>
            <Site xsi:nil="true" />
          </Contact>
        </Contacts>
      </GetSiteContactsResult>
    </GetSiteContactsResponse>
  </soap12:Body>
</soap12:Envelope>