Advantez

AreaStatistics request and response SOAP examples

areaStatistics

Retrieve a list of areas located within specified countries, regions, province and/or geocordinate ranges with the count of properties in these areas.

Support Operations

SOAP 1.1

An example of a SOAP 1.1 request and response

POST /webkits/area.v1.1.service HTTP/1.1
Host: services.advantez.com
Content-Type: text/xml; charset=utf-8
Content-Length: length SOAPAction: "http://services.advantez.com/area/v1.1/areaStatistics"

<?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>
    <areaStatistics xmlns="http://services.advantez.com/area/v1.1">
      <advantezKey>string</advantezKey>
      <webServiceKey>string</webServiceKey>
      <countries>
        <id>int</id>
        <id>int</id>
      </countries>
      <regions>
        <id>int</id>
        <id>int</id>
      </regions>
      <provinces>
        <id>int</id>
        <id>int</id>
      </provinces>
      <geocoordinates>
        <geocoordinate latitudeStart="decimal" latitudeEnd="decimal" longitudeStart="decimal" longitudeEnd="decimal" />
        <geocoordinate latitudeStart="decimal" latitudeEnd="decimal" longitudeStart="decimal" longitudeEnd="decimal" />
      </geocoordinates>
      <listTypes>
        <listType>resale or rental or development-unit or development</listType>
        <listType>resale or rental or development-unit or development</listType>
      </listTypes>
      <propertyTypes>
        <propertyType>apartment or bar or bistro or building-plot or bungalow or business or chalet or commercial or commercial-plot or country-house or detached or duplex-apartment or duplex-penthouse or end-terrace or farm or farm-house or finca or garage or garden-apartment or hotel or house or land or maisonette or mew or mobile-home or night-club or office or penthouse or restaurant or ruin or semi-detached or shop or studio or terrace or townhouse or villa or other or rural-land or cafe or cafe-bar or yacht or boat or mooring or parking or storage or internet-cafe or snack-bar or entertainment-bar or industrial-unit or beach-club or supermarket or vineyard or campsite or bed-and-breakfast or hostel or guest-house or wooden-chalet or condo or single-family-home or music-bar or nursery or hairdressers or kennels or laundry or gymnasium or fast-food-take-away or sandwich-bar or franchise or empty-business-premises or garden-business or real-estate-business or fish-and-chips-shop or bakery or sports-bar or drinks-bar or printing-business or catering-business or vehicle-hire or charter or plant-hire or heating-specialist-business or self-storage-business</propertyType>
        <propertyType>apartment or bar or bistro or building-plot or bungalow or business or chalet or commercial or commercial-plot or country-house or detached or duplex-apartment or duplex-penthouse or end-terrace or farm or farm-house or finca or garage or garden-apartment or hotel or house or land or maisonette or mew or mobile-home or night-club or office or penthouse or restaurant or ruin or semi-detached or shop or studio or terrace or townhouse or villa or other or rural-land or cafe or cafe-bar or yacht or boat or mooring or parking or storage or internet-cafe or snack-bar or entertainment-bar or industrial-unit or beach-club or supermarket or vineyard or campsite or bed-and-breakfast or hostel or guest-house or wooden-chalet or condo or single-family-home or music-bar or nursery or hairdressers or kennels or laundry or gymnasium or fast-food-take-away or sandwich-bar or franchise or empty-business-premises or garden-business or real-estate-business or fish-and-chips-shop or bakery or sports-bar or drinks-bar or printing-business or catering-business or vehicle-hire or charter or plant-hire or heating-specialist-business or self-storage-business</propertyType>
      </propertyTypes>
      <minPropertiesInArea>int</minPropertiesInArea>
    </areaStatistics>
  </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>
    <areaStatisticsResponse xmlns="http://services.advantez.com/area/v1.1">
      <areaStatisticsResult>
        <areaStatistics>
          <cityName>string</cityName>
          <longitude>decimal</longitude>
          <latitude>decimal</latitude>
          <propertyCount>int</propertyCount>
          <country id="int" name="string" />
          <region id="int" name="string" />
          <province id="int" name="string" />
        </areaStatistics>
        <areaStatistics>
          <cityName>string</cityName>
          <longitude>decimal</longitude>
          <latitude>decimal</latitude>
          <propertyCount>int</propertyCount>
          <country id="int" name="string" />
          <region id="int" name="string" />
          <province id="int" name="string" />
        </areaStatistics>
      </areaStatisticsResult>
      <result>successful or invalid-value or non-secure-protocol or unexpected-exception or invalid-proptrack-key or unauthorised-domain or invalid-webservice-key or invalid-advantez-key</result>
    </areaStatisticsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

An example of a SOAP 1.2 request and response

POST /webkits/area.v1.1.service HTTP/1.1
Host: services.advantez.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>
    <areaStatistics xmlns="http://services.advantez.com/area/v1.1">
      <advantezKey>string</advantezKey>
      <webServiceKey>string</webServiceKey>
      <countries>
        <id>int</id>
        <id>int</id>
      </countries>
      <regions>
        <id>int</id>
        <id>int</id>
      </regions>
      <provinces>
        <id>int</id>
        <id>int</id>
      </provinces>
      <geocoordinates>
        <geocoordinate latitudeStart="decimal" latitudeEnd="decimal" longitudeStart="decimal" longitudeEnd="decimal" />
        <geocoordinate latitudeStart="decimal" latitudeEnd="decimal" longitudeStart="decimal" longitudeEnd="decimal" />
      </geocoordinates>
      <listTypes>
        <listType>resale or rental or development-unit or development</listType>
        <listType>resale or rental or development-unit or development</listType>
      </listTypes>
      <propertyTypes>
        <propertyType>apartment or bar or bistro or building-plot or bungalow or business or chalet or commercial or commercial-plot or country-house or detached or duplex-apartment or duplex-penthouse or end-terrace or farm or farm-house or finca or garage or garden-apartment or hotel or house or land or maisonette or mew or mobile-home or night-club or office or penthouse or restaurant or ruin or semi-detached or shop or studio or terrace or townhouse or villa or other or rural-land or cafe or cafe-bar or yacht or boat or mooring or parking or storage or internet-cafe or snack-bar or entertainment-bar or industrial-unit or beach-club or supermarket or vineyard or campsite or bed-and-breakfast or hostel or guest-house or wooden-chalet or condo or single-family-home or music-bar or nursery or hairdressers or kennels or laundry or gymnasium or fast-food-take-away or sandwich-bar or franchise or empty-business-premises or garden-business or real-estate-business or fish-and-chips-shop or bakery or sports-bar or drinks-bar or printing-business or catering-business or vehicle-hire or charter or plant-hire or heating-specialist-business or self-storage-business</propertyType>
        <propertyType>apartment or bar or bistro or building-plot or bungalow or business or chalet or commercial or commercial-plot or country-house or detached or duplex-apartment or duplex-penthouse or end-terrace or farm or farm-house or finca or garage or garden-apartment or hotel or house or land or maisonette or mew or mobile-home or night-club or office or penthouse or restaurant or ruin or semi-detached or shop or studio or terrace or townhouse or villa or other or rural-land or cafe or cafe-bar or yacht or boat or mooring or parking or storage or internet-cafe or snack-bar or entertainment-bar or industrial-unit or beach-club or supermarket or vineyard or campsite or bed-and-breakfast or hostel or guest-house or wooden-chalet or condo or single-family-home or music-bar or nursery or hairdressers or kennels or laundry or gymnasium or fast-food-take-away or sandwich-bar or franchise or empty-business-premises or garden-business or real-estate-business or fish-and-chips-shop or bakery or sports-bar or drinks-bar or printing-business or catering-business or vehicle-hire or charter or plant-hire or heating-specialist-business or self-storage-business</propertyType>
      </propertyTypes>
      <minPropertiesInArea>int</minPropertiesInArea>
    </areaStatistics>
  </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>
    <areaStatisticsResponse xmlns="http://services.advantez.com/area/v1.1">
      <areaStatisticsResult>
        <areaStatistics>
          <cityName>string</cityName>
          <longitude>decimal</longitude>
          <latitude>decimal</latitude>
          <propertyCount>int</propertyCount>
          <country id="int" name="string" />
          <region id="int" name="string" />
          <province id="int" name="string" />
        </areaStatistics>
        <areaStatistics>
          <cityName>string</cityName>
          <longitude>decimal</longitude>
          <latitude>decimal</latitude>
          <propertyCount>int</propertyCount>
          <country id="int" name="string" />
          <region id="int" name="string" />
          <province id="int" name="string" />
        </areaStatistics>
      </areaStatisticsResult>
      <result>successful or invalid-value or non-secure-protocol or unexpected-exception or invalid-proptrack-key or unauthorised-domain or invalid-webservice-key or invalid-advantez-key</result>
    </areaStatisticsResponse>
  </soap12:Body>
</soap12:Envelope>