XML Based Integration


Dezrez live XML feeds allow web developers to conduct a live search of properties and return a list of search results and property details as xml. This gives the web developer full control over how the search results and full details html is constructed for displaying on a customers website while maintaining the live nature of the property data.Dezrez live XML feeds allow web developers to conduct a live search of properties and return a list of search results and property details as xml. This gives the web developer full control over how the search results and full details html is constructed for displaying on a customer’s website while maintaining the live nature of the property data.

The Branch ID, Agency ID & API Key is not permitted to be displayed in any URL for the website. Please store this information in a configuration file as variables. Failure to comply will result in the API Key being suspended.

This document provides technical information to web developers wishing to integrate a customer’s website with a property search using the live XML data feed and provides a specification of the XML which is returned.


Searching

Returning the live XML property data is achieved by submitting a standard HTTP POST request to the dezrez servers. The dezrez servers will produce an XML document of search results based on the search criteria included in the POST and return it.

Submitting a Search

The list of properties which is returned in the XML document is produced based on the search criteria passed to the dezrez server in a HTTP POST or GET. The HTTP request should be sent to the following URL:

http://www.dezrez.com/DRApp/DotNetSites/WebEngine/property/Default.aspx

Search Form Parameters

Below is a list of parameters which can be submitted to the dezrez servers to produce a list of search results:

The following parameters are required:

Parameter name Data type Value Description
apiKey string Example:
DEBF038A-8047-42F8-B0A8-12C35DA33F13
The API (Application Programing Interface) key is an identifier unique for the estate agent and needs to be provided with any request made to the dezrez web engine. After the initial request the web engine will attempt to store the API key for any subsequent request for that session. A key can be obtained from the dezrez web team (0845 465 2222). This is a compulsory value.
eaid int 0-32000 The Estate Agency ID – This number can be obtained from the dezrez web team (0845 465 2222). This is a compulsory value.
sessionGUID string Example:
66ff1de8-0115-48d6-8417-74c238fc8704
The session GUID (Globally Unique Identifier) is used to identify the website users current session. This should be passed from your website to the dezrez web engine to maintain a constant session across the web engine. Not supplying the same sessionGUID with every request for a particular session will result in the website user having to log into the web engine multiple times. See Appendix A for sample code to generate a unique id. This is a compulsory value.
xslt int -1 This has to be set to -1 to get xml and not formatted html returned.

The following parameters are optional:

Parameter name Data type Value Description
branchList string Comma delimited list of values between 0-32000
e.g. “21,22,23”
The branch ID number – i.e. can be use to return properties from a selected offices.
minPrice int 0-100,000,000 Specifies the minimum value of the properties returned. The minPrice and maxPrice values must form a valid range.
maxPrice int 0-100,000,000 Specifies the minimum value of the properties returned. The minPrice and maxPrice values must form a valid range.
bedrooms int 0 - 32000 Specifies the minimum number of bedrooms to be returned.
showSTC bool true if you want to display STC properties for sale and Let Agreed properties for lettings By default the web engine will not return properties marked as sold subject to contract or let agreed. Adding a hidden form with the value “true” will return them, or you can give the option to the user using a checkbox for example.
searchAllAddress text Any freeform text e.g. “St-Ives” The search will return any properties which include the specified text string in any part of the address fields. Codes may be set up by the agent to identify a particular area and these are also search using this parameter e.g. (STI).
searchAddress1 text Any freeform text. Searches address field 1 for instances of the specified text.
searchAddress2 text Any freeform text. Searches address field 2 for instances of the specified text.
searchTown text Any freeform text. Searches the town field for instances of the specified text.
searchCity text Any freeform text. Searches the city field for instances of the specified text.
searchCounty text Any freeform text. Searches the county field for instances of the specified text.
searchCountry text Any freeform text. Searches the country field for instances of the specified text.
searchPostCode text Any freeform text. Searches the postcode field for instances of the specified text.
searchLocationCodes text Any location code set up by the estate agent e.g. “(SWA)”. Location codes always take the format of a character code (max 3 characters) in brackets “(XXX)” Searches the location code field for instances of the specifies text.
classification int blank = All Types
1 = Residential
2 = New Build
3 = Commercial
4 = Land
5 = foreign
6 = other
7 = Investment
8 = Mooring
Specifies the type of the properties returned.
propertyType int blank = All Types
0 = Flats
1 = Houses
2 = Business
3 = Plot
4 = Apartment
5 = Town House
6 = Bungalow
7 = Chalet
8 = Cottage
9 = Semi Detached
10 = Detached
11 = Terraced
Specifies the property style returned by the search.
rentalPeriod int 0/blank will return sale properties
2 all results in per day
3 all results in per week
4 all results in PCM
5 all results in per Quarter
6 all results in per Year
Specifies whether the search will return sales or rental properties. Returns sales if omitted.
sortDescending bool false/blank - Cheapest property first
true - Most expensive property first
Specifies the search order to use; either cheapest or most expensive property first.
page int 0-32000 The page of properties to return. Returns page 1 if omitted.
perpage int 0-32000 The number of properties returned on each search page. Returns 10 properties per page if omitted.

Search Results XML Specification

Below is an example of the search results XML returned by the server:

copy
<response>
  <apiKey id="1" apikey="DEBF038A-8047-42F8-B0A8-12C35DA33F13">API key ok.</apiKey>
  <apiKeyMessage>your ip address is 127.0.0.1 and it has been logged against the api key you supplied</apiKeyMessage>
  <propertySearchSales>
    <properties rentalperiod="0">
      <pages page="1" count="1" pageCount="1" perPage="10">
        <page number="1" selected="true" />
      </pages>
      <property id="393772" eaid="398" bid="603" rescomnew="3" featured="true" price="£395,495" priceVal="395495" currency="GBP" rentalperiod="1" updated="2010-06-18T14:14:27.013" bedrooms="3" bathrooms="2" receptions="3" garages="0" gardens="1" otherrooms="3" specials="4" metropix="0" virturaltour="" propertyType="70" hits="2102" leaseType="2" EATel="01792 485588" period="Post War" latitude="52.6059156552" longitude="-1.0785216288" sold="1" UO_LA="false" picture="true" portfolio="false">
        <num>3</num>
        <sa1>Avenue Road</sa1>
        <sa2>test</sa2>
        <town>LONDON</town>
        <city />
        <county />
        <country />
        <postcode>N14 4EE</postcode>
        <locationcodes>(TC)(AV)</locationcodes>
        <useAddress>Avenue Road, test, LONDON</useAddress>
        <pricetext>offers in the region of</pricetext>
        <summaryDescription>A great opportunity to aquire this post war public house with accomadation with 3 bedrooms above.The premises has recently undergone significant modernisation to both the bar and restraunt areas.This is a free house which has superb public gardens with large patio area and car park for up to approx 20 cars.</summaryDescription>
      </property>
      <searchParameters minPrice="0" maxPrice="99999999" branchList="" eaid="398" propertyType="" bedrooms="0" showSTC="" allAddressFields="" sa1="" sa2="" town="" city="" county="" postcode="" location="" classification="" descending="true" perPage="10" page="1" sessionGUID="e27e928c-24d7-4867-81eb-ac1e3d3e5b94" />
    </properties>
  </propertySearchSales>
</response>
									
								

XML structure

Element Element type Data type  
apiKey XML element xml node The API key status of the request.
apiKey/@id XML attribute int The API key status of the request based on the following key:

0 - API key wrong
1 - API key ok
2 - API key not supplied
3 - API key not approved
apiKey/@apikey XML attribute string The API key used in the current request
apiKeyMessage XML element string The API key message returned from the server
properties XML element xml node Contains the property and page nodes.
properties/@rentalperiod XML attribute int
pages XML element xml node Contains the page elements and page totals etc.
pages/@page XML attribute int The number of the current page of properties.
pages/@count XML attribute int The total number of properties returned in the current search.
pages/@pageCount XML attribute int The total number of pages of properties.
pages/@perPage XML attribute int The number of properties per page.
pages/page/@number XML attribute int The page number of the page node.
pages/page/@selected XML attribute bool Indicates whether the page node is the current page of properties being displayed.
property XML element xml node The property element of the xml
property/@id XML attribute int The unique identifier for the property
property/@eaid XML attribute int The unique identifier for the estate agency
property/@bid XML attribute int The unique identifier for the estate agency branch
property/@rescomnew XML attribute int The category of the property, possible values are:

1 = Residential
2 = New build
3 = Commercial
4 = Land
5 = Foreign
6 = Other
7 = Investment
8 = Mooring
property/@featured XML attribute bool Indicates where the property has been marked as "featured"
property/@price XML attribute String The formatted price of the property (including currency symbol and commas)
property/@priceVal XML attribute float The price of the property (no formatting)
property/@currency XML attribute string The three letter currency code
property/@sold XML attribute int Sold is the property status and uses the following key:

0 - available
1 - reduced
2 - sold subject to contract
property/@UO_LA XML attribute bool This indicates if the property has been marked as "under offer/let agreed" in Dezrez. You would need to check the property type (sale/let) to determine if it under offer or let agreed.
property/@bedrooms XML attribute int The number of bedrooms
property/@bathrooms XML attribute int The number of bathrooms
property/@receptions XML attribute int The number of reception rooms
property/@garages XML attribute int The number of garages
property/@gardens XML attribute int The number of gardens
property/@parkingSpaces XML attribute int The number of parking spaces
property/@otherrooms XML attribute int The number of other rooms
property/@specials XML attribute int The number of special features attached to the property
property/@leaseType XML attribute int The lease type of the property, possible values are:

1 = Not Applicable
3 = Freehold
5 = Freehold (to be confirmed)
2 = Leasehold
4 = Leasehold (to be confirmed)
6 = To be Advised
7 = Share of Leasehold
8 = Share of Freehold
9 = Flying Freehold
11 = Leasehold (Share of Freehold)
property/@metropix XML attribute int The unique id for the Metropix floorplan that has been attached to the property
property/@propertyType XML attribute int The property type. See appendix A for a list of property types
property/@period XML attribute string The property period. See appendix B for a list of property periods
property/@brochureApproved XML attribute bool Indicates whether the property brochure has been approved
property/@hits XML attribute int The number of web site hits the property has received.
property/@latitude XML attribute float The stored latitude for the property (see Appendix C for notes on coordinates)
property/@longitude XML attribute float The stored longitude for the property (see Appendix C for notes on coordinates)
property/@updated XML attribute date time The date and time the property was lsat updated
property/@portfolio XML attribute bool Indicates whether the property is in the portfolio. This attribute will always show false unless the user is logged in, only then will it test to see if the property is in the web users portfolio.
property/@picture XML attribute bool Indicates whether the property has a primary picture.
property/@EATel XML attribute string The telephone number for the branch the property is in.
property/@virturaltour XML attribute string The URL of the virtual tour attached to the property.
property address elements XML element xml node The property node contains the address details of the property. Each address line is in its own node, the possible address nodes are:

sa1 (street address 1)
sa2 (street address 2)
town
city
county
postcode
country
locationcodes
useAddress


Only the nodes set to be display in the Dezrez software will actually appear. For example only sa1, town and county could be set to be displayed so only those nodes will appear. Post code will always be available.

Also within the address node is a "useAddress" node which contains the enabled address lines pre formatted.

Location codes are custom codes set up by the estate agent in Dezrez to mark properties as being from a specific area or having a particular feature. Please contact the estate agent to get the list of location codes they have set up and their meanings.
property/pricetext XML element string A free text field used to as a prefix or suffix (estate agent specific) to the price. For example:
Offers in the region of
Offers over
etc.
property/summaryDescription XML element string The text of the property description marked to be the summary of the property.
searchParameters XML element xml node The search paramater node has an attribute for every search paramater passed through to the web engine. Any valid search criteria passed to the web engine will be returned as an attribute of this node otherwise the attribute will be emtpy.

Property Image

To display an image for each property returned by the search results you would need to construct the following link:

http://www.dezrez.com/DRApp/DotNetSites/WebEngine/property/pictureResizer.aspx?eaid=398&apikey=DEBF038A-8047-42F8-B0A8-12C35DA33F13&pid=258204&bid=603&picture=1&width=500

The link uses these parameters:

Parameter Data Type Value Description
apiKey string Example:
DEBF038A-8047-42F8-B0A8-12C35DA33F13
The API (Application Programing Interface) key is an identifier unique for the estate agent and needs to be provided with any request made to the dezrez web engine. After the initial request the web engine will attempt to store the API key for any subsequent request for that session. A key can be obtained from the dezrez web team (0845 465 2222). This is a compulsory value.
eaid int Example: 398 The Estate Agency ID – This number can be obtained from the dezrez web team (0845 465 2222). This is a compulsory value.
pid long Example: 258204 Dezrez ID for the property. Available from the search results XML file.
picture int Example: 1 ID number for the image.
bid int Example: 603 Estate Agents Branch ID
width int Example: 500 Specifies the width of the image returned in pixels
rotation int 0 - 360 Optional - specifies the rotation on the image in degrees


The property element contains the attribute picture. This is Boolean value which indicates whether there is a main picture for the property or not. The main picture for the property has a photoID of 1.


Obtaining Full property Details

To obtain full property details for a single property, a HTTP POST or GET should be sent to the following address:

http://www.dezrez.com/DRApp/DotNetSites/WebEngine/property/Property.aspx

Parameter name Data type Value Description
apiKey string Example:
DEBF038A-8047-42F8-B0A8-12C35DA33F13
The API (Application Programing Interface) key is an identifier unique for the estate agent and needs to be provided with any request made to the dezrez web engine. After the initial request the web engine will attempt to store the API key for any subsequent request for that session. A key can be obtained from the dezrez web team (0845 465 2222). This is a compulsory value.
eaid int 0-32000 The Estate Agency ID – This number can be obtained from the dezrez web team (0845 465 2222). This is a compulsory value.
pid long Example: 258204 The property ID. This is a compulsory value.
sessionGUID string Example:
66ff1de8-0115-48d6-8417-74c238fc8704
The session GUID (Globally Unique Identifier) is used to identify the website users current session. This should be passed from your website to the dezrez web engine to maintain a constant session across the web engine. Not supplying the same sessionGUID with every request for a particular session will result in the website user having to log into the web engine multiple times. See Appendix A for sample code to generate a unique id. This is a compulsory value.
xslt int -1 This has to be set to -1 to get xml and not formatted html returned.

Full details XML example

copy
<response>
  <apiKey id="1" apikey="DEBF038A-8047-42F8-B0A8-12C35DA33F13">API key ok.</apiKey> 
  <apiKeyMessage>your ip address is 127.0.0.1 and it has been logged against the api key you supplied</apiKeyMessage>
    <propertyFullDetails>
        <property id="1680980" eaid="398" bid="603" nid="12217" sale="true" instructed="18/1/2010 00:00:00" category="1" featured="false" price="£1,525,000" priceVal="1525000" POA="false" currency="GBP" rentalperiod="1" updated="18/6/2010 14:14:49" bedrooms="3" bathrooms="1" instructionLevel="0" receptions="2" leaseType="3" garages="1" gardens="1" otherrooms="2" specials="1" parkingSpaces="1" metropix="0" propertyType="5" period="Period" brochureApproved="true" hits="538" latitude="51.6424866741" longitude="-0.186223924" sold="0" deleted="false" UO_LA="false" sendToPortal="true" portfolio="false" sessionGUID="381d2c93-aab0-4bce-ba35-a31e24d1b7c0">
          <branch>
            <name>Head Office</name>
            <tel>01792 485588</tel>
            <email>nick.silverstone@dezrez.com</email>
            <address>
              <sa1>Technium2</sa1>
              <sa2>Kings Rd</sa2>
              <town>The Docks</town>
              <city>Swansea</city>
              <county>
              </county>
              <country>
              </country>
              <postcode>SA15 4PF</postcode>
            </address>
          </branch>
          <homeinformationpack>
            <info>
              <hip eer_c="50" eer_p="60" eir_c="0" eir_p="0" security="5" market="true" ordered="">
              </hip>
            </info>
          </homeinformationpack>
          <address>
            <sa1 display="true">Ivere Drive </sa1>
            <sa2 display="true">New Barnet </sa2>
            <town display="true">BARNET</town>
            <city display="true">
            </city>
            <county display="true">Hertfordshire</county>
            <country display="true">
            </country>
            <postcode>EN5 1AS</postcode>
            <locationcodes>(LM)(TC) </locationcodes>
            <useAddress>Ivere Drive, New Barnet, BARNET, Hertfordshire</useAddress>
          </address>
          <media>
            <picture id="1" updated="18/1/2010 16:59:58" category="primary" categoryID="1" caption="">http://data.dezrez.com/PictureResizer.ASP?PropertyID=1680980&PhotoID=1&AgentID=398&BranchID=603</picture>
            <picture id="2" updated="18/1/2010 16:59:58" category="secondary" categoryID="2" caption="">http://data.dezrez.com/PictureResizer.ASP?PropertyID=1680980&PhotoID=2&AgentID=398&BranchID=603</picture>
            <picture id="3" updated="18/1/2010 16:59:58" category="secondary" categoryID="2" caption="">http://data.dezrez.com/PictureResizer.ASP?PropertyID=1680980&PhotoID=3&AgentID=398&BranchID=603</picture>
            <picture id="4" updated="18/1/2010 16:59:58" category="secondary" categoryID="2" caption="">http://data.dezrez.com/PictureResizer.ASP?PropertyID=1680980&PhotoID=4&AgentID=398&BranchID=603</picture>
            <picture id="5" updated="18/1/2010 16:59:59" category="secondary" categoryID="2" caption="">http://data.dezrez.com/PictureResizer.ASP?PropertyID=1680980&PhotoID=5&AgentID=398&BranchID=603</picture>
            <picture id="10" updated="18/1/2010 16:59:59" category="secondary" categoryID="2" caption="">http://data.dezrez.com/PictureResizer.ASP?PropertyID=1680980&PhotoID=10&AgentID=398&BranchID=603</picture>
            <picture id="EER" category="EER" categoryID="5" caption="Energy Efficency Rating">http://www.dezrez.com/drapp/Utilities.ASP?WCI=SAP_IMAGE&Type=EER&Current=50&Potential=60&Rotate=0&width=500</picture>
            <document category="brochure">http://www.dezrez.com/Drapp/Search.ASP?WCI=PortalBrochure&WCE=001680980&Template=PortalBrochure&eaid=398</document>
          </media>
          <text>
            <description id="1" summary="true">A much sort after street, this top floor flat has two double bedrooms, decent sized living room with french windows to a roof terrace, a seperate kitchen and a hall way area.On a much desired street, this top floor flat has two double bedrooms, decent sized living room with french windows to a roof terrace, a seperate kitchen and a hall way area. </description>
            <description id="2" summary="false">Semi Detached<br/>3 Beds<br/>2 Reception <br/>Garden</description>
            <description id="3" summary="false">
            </description>
            <description id="4" summary="false">
            </description>
            <description id="5" summary="false">
            </description>
            <description id="6" summary="false">
            </description>
            <notes><info><hip  eer_c="50" eer_p="60" eir_c="0" eir_p="0" security="5" market="True" ordered="30/12/1899"></hip></info></notes>
            <charges>
            </charges>
            <pricetext>
            </pricetext>
            <areas>
              <area title="Ground floor">
                <feature type="Main Room()">
                  <heading>Main Room</heading>
                  <description>12' 10" x 12' 10" (3.90m x 3.90m) Fitted with a matching range of base and eye level units with worktop space over, 1½ bowl sink, integrated fridge/freezer and dishwasher, built-in double oven, four ring gas hob, window to rear, window to side, terracotta tiled flooring, door to:</description>
                </feature>
                <feature type="Lounge/Dining Room()">
                  <heading>Lounge/Dining Room</heading>
                  <description>12' 10" x 12' 10" (3.90m x 3.90m) Fitted with a matching range of base and eye level units with worktop space over, 1½ bowl sink, integrated fridge/freezer and dishwasher, built-in double oven, four ring gas hob, window to rear, window to side, terracotta tiled flooring, door to:</description>
                </feature>
                <feature type="kitchen">
                  <heading>Kitchen/Morning</heading>
                  <description>12' 10" x 12' 10" (3.90m x 3.90m) Fitted with a matching range of base and eye level units with worktop space over, 1½ bowl sink, integrated fridge/freezer and dishwasher, built-in double oven, four ring gas hob, window to rear, window to side, terracotta tiled flooring, door to:</description>
                </feature>
              </area>
              <area title="first floor">
                <feature type="bedroom">
                  <heading>Master Bedroom</heading>
                  <description>12' 10" x 12' 10" (3.90m x 3.90m) Fitted with a matching range of base and eye level units with worktop space over, 1½ bowl sink, integrated fridge/freezer and dishwasher, built-in double oven, four ring gas hob, window to rear, window to side, terracotta tiled flooring, door to:</description>
                </feature>
                <feature type="bedroom">
                  <heading>Bedroom</heading>
                  <description>12' 10" x 12' 10" (3.90m x 3.90m) Fitted with a matching range of base and eye level units with worktop space over, 1½ bowl sink, integrated fridge/freezer and dishwasher, built-in double oven, four ring gas hob, window to rear, window to side, terracotta tiled flooring, door to:</description>
                </feature>
                <feature type="bathroom">
                  <heading>Bathroom</heading>
                  <description>no toilet or bath</description>
                </feature>
                <feature type="bedroom">
                  <heading>Bedroom</heading>
                  <description>12' 10" x 12' 10" (3.90m x 3.90m) Fitted with a matching range of base and eye level units with worktop space over, 1½ bowl sink, integrated fridge/freezer and dishwasher, built-in double oven, four ring gas hob, window to rear, window to side, terracotta tiled flooring, door to:</description>
                </feature>
              </area>
              <area title="outside">
                <feature type="garage">
                  <heading>Garage</heading>
                  <description> </description>
                </feature>
                <feature type="garden">
                  <heading>Front Garden</heading>
                  <description>8.00m x 4.00m (26' 3" x 13' 1") with patio area</description>
                </feature>
              </area>
            </areas>
          </text>
        </property>
  </propertyFullDetails>
</response>
									
								
							

XML Structure

Element Element type Data type  
apiKey XML element xml node The API key status of the request.
apiKey/@id XML attribute int The API key status of the request based on the following key:

0 - API key wrong
1 - API key ok
2 - API key not supplied
3 - API key not approved
apiKey/@apikey XML attribute string The API key used in the current request
apiKeyMessage XML element string The API key message returned from the server.
property XML element xml node The property element of the xml
property/@id XML attribute int The unique identifier for the property
property/@eaid XML attribute int The unique identifier for the estate agency
property/@bid XML attribute int The unique identifier for the estate agency branch
property/@nid XML attribute int The unique identifier for the negotiator attached to the property. Not used outside of Dezrez.
property/@sale XML attribute bool Indicates whether the property is for sales or to let.

true = for sale
false = to let
property/@instructed XML attribute date time The date the property was marked as "instructed" in Dezrez
property/@updated XML attribute date time The date and time the property was lsat updated
property/@category XML attribute int The category of the property, possible values are:

1 = Residential
2 = New build
3 = Commercial
4 = Land
5 = Foreign
6 = Other
7 = Investment
8 = Mooring
property/@featured XML attribute bool Indicates where the property has been marked as "featured"
property/@price XML attribute String The formatted price of the property (including currency symbol and commas)
property/@priceVal XML attribute float The price of the property (no formatting)
property/@POA XML attribute bool Indicates whether the property has been marked as "Price On Application", i.e do not display the actual property price
property/@currency XML attribute string The three letter currency code
property/@rentalperiod XML attribute int The rental period value for the property, possible values are:

0/1 = sale property
2 = price per day
3 = price per week
4 = price per month
5 = price per quarter
6 = price per year
property/@sold XML attribute int Sold is the property status and uses the following key:

0 - available
1 - reduced
2 - sold subject to contract
property/@UO_LA XML attribute bool This indicates if the property has been marked as "under offer/let agreed" in Dezrez. You would need to check the property type (sale/let) to determine if it under offer or let agreed.
property/@bedrooms XML attribute int The number of bedrooms
property/@bathrooms XML attribute int The number of bathrooms
property/@receptions XML attribute int The number of reception rooms
property/@garages XML attribute int The number of garages
property/@gardens XML attribute int The number of gardens
property/@parkingSpaces XML attribute int The number of parking spaces
property/@otherrooms XML attribute int The number of other rooms
property/@specials XML attribute int The number of special features attached to the property
property/@leaseType XML attribute int The lease type of the property, possible values are:

1 = Not Applicable
3 = Freehold
5 = Freehold (to be confirmed)
2 = Leasehold
4 = Leasehold (to be confirmed)
6 = To be Advised
7 = Share of Leasehold
8 = Share of Freehold
9 = Flying Freehold
11 = Leasehold (Share of Freehold)
property/@metropix XML attribute int The unique id for the Metropix floorplan that has been attached to the property
property/@propertyType XML attribute int The property type. See appendix A for a list of property types
property/@period XML attribute string The property period. See appendix B for a list of property periods
property/@brochureApproved XML attribute bool Indicates whether the property brochure has been approved
property/@hits XML attribute int The number of web site hits the property has received.
property/@latitude XML attribute float The stored latitude for the property (see Appendix C for notes on coordinates)
property/@longitude XML attribute float The stored longitude for the property (see Appendix C for notes on coordinates)
property/@yaw XML attribute float The stored yaw for the property, used for streetview where available (see Appendix C for notes on coordinates)
property/@pitch XML attribute float The stored pitch for the property, used for streetview where available (see Appendix C for notes on coordinates)
property/@zoom XML attribute float The stored zoom for the property, used for streetview where available (see Appendix C for notes on coordinates)
property/@deleted XML attribute bool Whether the property has been deleted, you should not receive any property details for deleted properties.
property/@sendToPortal XML attribute bool Indicates whether the property has been approved to be sent to the property portals through Dezrez.
property/@portfolio XML attribute bool Indicates whether the property is in the portfolio. This attribute will always show false unless the user is logged in, only then will it test to see if the property is in the web users portfolio.
property/@sessionGUID XML attribute string The session GUID for the current web user. If a session GUID has been passed to the web engine it will return that GUID otherwise one will be generated by the server.
branch XML element xml node This node contains the contact information for the branch the property belongs to. Includes postal address, phone number, email address and branch name.
homeinformationpack XML element xml node This node contains EPC and HIP information. This is no longer relevant for HIPs, however this will now contain the URL to the EPC PDF if available.
address XML element xml node This node contains the address details of the property. Each address line is in its own node, the possible address nodes are:

sa1 (street address 1)
sa2 (street address 2)
town
city
county
postcode
country
locationcodes
useAddress


Only the nodes set to be display in the Dezrez software will actually appear. For example only sa1, town and county could be set to be displayed so only those nodes will appear. Post code will always be available.

Also within the address node is a "useAddress" node which contains the enabled address lines pre formatted.

Location codes are custom codes set up by the estate agent in Dezrez to mark properties as being from a specific area or having a particular feature. Please contact the estate agent to get the list of location codes they have set up and their meanings.
media XML element xml node The media node contains links to all the media elements attached to the property, this could include:

pictures
documents
virtual tours
media/picture XML element xml node A picture node contains the url for the property picture in question. In order to use this url append a width and rotaion, for example:

&width=500&rotaion=0
media/picture/@id XML attribute string The unique id for the picture
media/picture/@updated XML attribute date time The date and time the picture was last updated
media/picture/@category XML attribute string The name of the category the picture belongs to, possible values are:

primary
secondary
floorplan
maps
aerialphoto
thumbnail
media/picture/@categoryID XML attribute int The id of the category the picture belongs to, possible values are:

1 = primary
2 - secondary
3 - floorplan
4 - maps
5 - aerialphoto
6 - thumbnail
media/picture/@caption XML attribute string Optional photo caption added by the estate agent
media/virtualtour XML element string The url to the virtual tour added by the estate agent
media/document XML element string The url to the full details for the property. There could potentially be two document nodes for a property, in this instance the first occuring node should be used for the full details.
media/document/@category XML attribute string Currently the only value for the category attribute on a document element is "brochure".
text XML element xml node The text node contains all the descriptions and room particulars for the property
text/description XML element string A description node contains the description of the property. There are a maximum of 6 description nodes all with an id attribute 1-6.
text/description/@summary XML attribute bool The summary attribute indicates whether a particular description has been selected to be used as the summary description for the property. Only one description will be marked for the summary.
text/notes XML element string A generic notes field about the property, could potentially be used for internal reference by the estate agent so not necessarily for display.
text/notes XML element string A generic notes field about the property, could potentially be used for internal reference by the estate agent so not necessarily for display.
text/charges XML element string Another generic notes field about the property, could potentially be used for internal reference by the estate agent so not necessarily for display.
text/pricetext XML element string A free text field used to as a prefix or suffix (estate agent specific) to the price. For example:
Offers in the region of
Offers over
etc.
text/areas XML element xml node The areas node contains the room particulars for a property.
text/areas/area XML element xml node An area node contains all the rooms within a specific area of the property, area are defined by the estate agent on a property by property basis. The most common use of areas is to define floors on a property.
text/areas/area/@title XML attribute string The title of a specific area.
text/areas/area/feature XML element xml node A feature node defines a room of a property, this node will contain the heading and description nodes used to describe the room.
text/areas/area/feature/@type XML attribute string The room type as a string.
text/areas/area/feature/heading XML element string The room title as a string.
text/areas/area/feature/description XML element string The description of the room.

Appendix A - Property types

This is the key for identifying the individual property types:

10 Apartment
58 Apartment (Low Density)
59 Apartment (Studio)
57 Building Plot
60 Business
56 Cluster
70 Commercial
61 Corner Townhouse
40 Detached (Barn Conversion)
15 Detached (Bungalow)
39 Detached (Chalet)
23 Detached (Cottage)
30 Detached (Country House)
5 Detached (House)
29 Detached (Town House)
52 Duplex Apartment
33 East Wing (Country House)
17 End Link (Bungalow)
7 End Link (House)
12 End Terrace (Bungalow)
36 End Terrace (Chalet)
20 End Terrace (Cottage)
2 End Terrace (House)
26 End Terrace (Town House)
47 First Floor Converted (Flat)
44 First Floor Purpose Built (Flat)
50 First &amp; Second Floor (Maisonette)
9 Flat
49 Ground &amp; First Floor (Maisonette)
46 Ground Floor Converted (Flat)
43 Ground Floor Purpose Built (Flat)
66 Link Detached
53 Mansion
68 Maisonette
42 Mews Style (Barn Conversion)
18 Mid Link (Bungalow)
8 Mid Link (House)
13 Mid Terrace (Bungalow)
37 Mid Terrace (Chalet)
21 Mid Terrace (Cottage)
3 Mid Terrace (House)
27 Mid Terrace (Town House)
31 North Wing (Country House)
51 Penthouse Apartment
54 Q-Type
41 Remote Detached (Barn Conversion)
16 Remote Detached (Bungalow)
24 Remote Detached(Cottage)
6 Remote Detached (House)
48 Second Floor Converted (Flat)
45 Second Floor Purpose Built (Flat)
14 Semi-Detached (Bungalow)
38 Semi-Detached(Chalet)
22 Semi-Detached(Cottage)
4 Semi-Detached (House)
28 Semi-Detached (Town House)
69 Shell
32 South Wing (Country House)
67 Studio
11 Terraced (Bungalow)
35 Terraced (Chalet)
19 Terraced (Cottage)
1 Terraced (House)
25 Terraced (Town House)
55 T-Type
65 Village House
62 Villa (Detached)
63 Villa (Link-Detached)
64 Villa (Semi-Detached)
34 West Wing (Country House)
71 Retirement Flat
72 Bedsit
73 Park Home/Mobile Home

This is how the property types are grouped together within the dezrez software:


9,10,43,46,58,59,71,44,45,47,48,67,51,49,50,52,68,72 All Flats
5,6,29,30,50,53,65,66 House (Detached)
4,7,17,18,28,31,32,33,34,54,55,61,2,12,20,26,36 House (Semi-Detached)
1,2,3,8,25,26,27,56 House (Terraced)
15,16,39 Bungalow (Detached)
14,38 Bungalow (Semi-Detached)
11,12,13,35,36,37 Bungalow (Terraced)
23,24 Cottage (Detached)
22 Cottage (Semi-Detached)
19,20,21 Cottage (Terraced)
9,10,43,46,58,59 Apartment/Flat (Ground Floor)
9,10,44,45,47,48,58,59 Apartment/Flat (Other Floor)
9,10,58,59,67,72 Apartment/Flat (Studio)
71 Retirement Flat
9,10,51,58,59 Penthouse
49,50,52,68 Maisonette
35,36,37,38,39 Chalet
40,41,42 Barn Conversion
57,69 Building Plot/Land
60,70 Business/Commercial
62,63 Villa/Finca (Detached)
64 Villa/Finca (Semi-Detached)

Appendix B - Property periods

This is the list of individual property period:

19th Century
18th Century
17th Century
Not Applicable
Edwardian
Georgian
Modern
New
Neo Georgian
Older
Period
Post War
Victorian
Built To Order
Tudor
Mature

Appendix C - Coordinates

We cannot guarantee the quality of the coordinates stored against a property. The information is intially obtained from the post office based on the postcode entered by the estate agent. The agent then has the ability to correct the location and streetview within the Dezrez software.