Live portal feed

Dezrez provided support for the Portal XML feed for the past 10 years but the time has come for us to invest our resources towards supporting more recent technologies so that we can continue to deliver great new experiences. As a result, technical assistance for the portal XML will be ending on the 1st March 2017. No new integrations for this feed is available. Please visit our integrations page

The Dezrez Portal Information Service provides a data feed information service to 3rd parties who benefit from holding property information as part of their core business function.

The automated datafeed provides an effective mass synchronization of the in-house data (i.e. the master copy) held on the Dezrez information stores and the data that is made available to 3rd party companies.

Transferring data
Data files are transferred from Dezrez to your server via a HTTP post. Each post will contain an XML string for a single property. The information is extracted from the Dezrez live information stores when a save action is performed and then posted to a location you specify. One HTTP post is performed per property.

Data Precedence
A key factor to consider when receiving a data post is the precedence applied to the property information data and the data already in your existing database. During the loading of the property information data file into your database, we recommend that any existing data for the property id in question be removed from your database and replaced with the details in the new data file. In effect any properties loaded via the datafeed should be removed from your database and replaced with the contents of the newer HTTP post.

Property visibility
The visibility status of a property affects not only how it needs to be dealt with but also the xml that will be posted to you. A property can have a visibility of private or public, when public the full property details will be posted, private properties will only have a summary of the property.

                                    <propertyFullDetails>
	<property id="3384146" eaid="127" bid="167" nid="0" valNegID="42480" instNegID="42480" sale="true" instructed="1/5/2014 09:37:38" category="1" featured="false" price="&#xA3;500,000" priceVal="500000" POA="false" currency="GBP" rentalperiod="1" updated="18/12/2014 09:47:25" dateInstructed="01/05/2014" dateSTC="" bedrooms="2" bathrooms="1" instructionLevel="0" receptions="1" leaseType="2" garages="1" gardens="1" otherrooms="0" specials="1" parkingSpaces="0" metropix="123456" propertyType="5" period="Modern" brochureApproved="true" hits="3" latitude="51.6351714762" longitude="-4.0951330565" sold="0" deleted="false" UO_LA="false" sendToPortal="true" yaw="0" pitch="0" zoom="0" portfolio="false" sessionGUID="cab7daab-e0d1-4824-bcf8-28aa69729402">
		<branch>
			<name>
				<![CDATA[Head Office]]>
			</name>
			<tel>
				<![CDATA[0845 465 22 22]]>
			</tel>
			<email>
				<![CDATA[support@dezrez.com]]>
			</email>
			<address>
				<sa1>
					<![CDATA[Ethos]]>
				</sa1>
				<sa2>
					<![CDATA[Kings Road]]>
				</sa2>
				<town>
					<![CDATA[]]>
				</town>
				<city>
					<![CDATA[Swansea]]>
				</city>
				<county>
					<![CDATA[W Glam]]>
				</county>
				<country>
					<![CDATA[UK.]]>
				</country>
				<postcode>
					<![CDATA[SA1 8AS]]>
				</postcode>
			</address>
		</branch>
		<homeinformationpack>
			<info>
				<hip eer_c="60" eer_p="70" eir_c="80" eir_p="90" security="5" market="true" sendToPortal="false" ordered="1/1/1900 00:00:00">
					<![CDATA[www.EPCURL.com]]>
				</hip>
			</info>
		</homeinformationpack>
		<address>
			<num display="false">
				<![CDATA[17]]>
			</num>
			<sa1 display="true">
				<![CDATA[Blue Anchor Road]]>
			</sa1>
			<sa2 display="true">
				<![CDATA[Penclawdd]]>
			</sa2>
			<town display="true">
				<![CDATA[Swansea]]>
			</town>
			<city display="true">
				<![CDATA[]]>
			</city>
			<county display="true">
				<![CDATA[West Glamorgan]]>
			</county>
			<country display="true">
				<![CDATA[]]>
			</country>
			<postcode>
				<![CDATA[SA4 3JQ]]>
			</postcode>
			<locationcodes>
				<![CDATA[(b)(g)(J)(z)(t)]]>
			</locationcodes>
			<useAddress>Blue Anchor Road, Penclawdd, Swansea, West Glamorgan</useAddress>
		</address>
		<media>
			<picture id="1" updated="18/12/2014 09:19:31" category="primary" categoryID="1" caption="Main Shot">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=1&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="2" updated="18/12/2014 09:19:43" category="secondary" categoryID="2" caption="Bedroom">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=2&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="3" updated="18/12/2014 09:20:06" category="secondary" categoryID="2" caption="Garden">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=3&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="4" updated="18/12/2014 09:19:59" category="secondary" categoryID="2" caption="Outside">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=4&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="5" updated="18/12/2014 09:19:51" category="secondary" categoryID="2" caption="Bathroom">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=5&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="6" updated="18/12/2014 09:20:14" category="floorplan" categoryID="3" caption="Floor Plan">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=6&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="7" updated="18/12/2014 09:20:20" category="maps" categoryID="4" caption="Map">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=7&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="8" updated="18/12/2014 09:20:27" category="aerial" categoryID="5" caption="Aerial">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=8&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="9" updated="18/12/2014 09:20:36" category="thumbnails" categoryID="6" caption="Thumbnail">http://www.dezrez.com/estate-agent-software/ImageResizeHandler.do?PropertyID=3384146&amp;photoID=9&amp;AgentID=127&amp;BranchID=167</picture>
			<picture id="metropixID" category="floorplan" categoryID="3">http://content.metropix.com/mtpix/planforprint.aspx?code=123456&amp;width=500&amp;rotate=0&amp;format=JPG</picture>
			<picture id="EER" category="EER" categoryID="5" caption="Energy Efficiency Rating">http://www.dezrez.com/drapp/Utilities.ASP?WCI=SAP_IMAGE&amp;Type=EER&amp;Current=60&amp;Potential=70&amp;Rotate=0&amp;width=500</picture>
			<picture id="EIR" count="12" category="EIR" categoryID="5" caption="Environmental Impact Rating">http://www.dezrez.com/drapp/Utilities.ASP?WCI=SAP_IMAGE&amp;Type=EIR&amp;Current=80&amp;Potential=90&amp;Rotate=0&amp;width=500</picture>
			<virtualtour>
				<![CDATA[www.VirtualTourUrl.com]]>
			</virtualtour>
			<document category="brochure" source="document-location-url">
				<![CDATA[www.PDFBrochureURL.com]]>
			</document>
			<document category="HIP_Link">
				<![CDATA[www.EPCURL.com]]>
			</document>
			<document category="brochure" source="internet-particulars">www.BrochureURL.com</document>
		</media>
		<text>
			<description id="1" summary="true">
				<![CDATA[Description Box 1]]>
			</description>
			<description id="2" summary="false">
				<![CDATA[Description Box 2]]>
			</description>
			<description id="3" summary="false">
				<![CDATA[Description Box 3]]>
			</description>
			<description id="4" summary="false">
				<![CDATA[Description Box 4]]>
			</description>
			<description id="5" summary="false">
				<![CDATA[Description Box 5]]>
			</description>
			<description id="6" summary="false">
				<![CDATA[Description Box 6]]>
			</description>
			<notes>
				<![CDATA[This is the property notes section.]]>
			</notes>
			<charges>
				<![CDATA[Charges Text]]>
			</charges>
			<pricetext>
				<![CDATA[Offers In Excess Of]]>
			</pricetext>
			<particularsText>
				<![CDATA[This is the particulars text.]]>
			</particularsText>
			<areas>
				<area title="Ground Floor">
					<feature type="Reception" guid="73deaece-6ed5-46c7-ae6c-d57fb9541937" length="1000" width="1000" units="metre">
						<heading>
							<![CDATA[Reception]]>
						</heading>
						<description>
							<![CDATA[32' 10" x 32' 10" (10.00m x 10.00m) Reception Room Description]]>
						</description>
					</feature>
					<feature type="Kitchen" guid="cc3bfa19-4f3c-4032-a9fe-fb786c76f215" length="1000" width="1000" units="metre">
						<heading>
							<![CDATA[Kitchen]]>
						</heading>
						<description>
							<![CDATA[32' 10" x 32' 10" (10.00m x 10.00m) Kitchen Room Description]]>
						</description>
					</feature>
					<feature type="Special" guid="c9413877-cbf6-4788-8798-5dd019c6e80c">
						<heading>
							<![CDATA[Special Feature]]>
						</heading>
						<description>
							<![CDATA[Special Feature Room Type]]>
						</description>
					</feature>
				</area>
				<area title="First Floor">
					<feature type="Bedroom" guid="7a39faec-bb57-44a3-a4a2-5587ffd97388" length="1000" width="1000" units="metre">
						<heading>
							<![CDATA[Main Bedroom]]>
						</heading>
						<description>
							<![CDATA[32' 10" x 32' 10" (10.00m x 10.00m) Bedroom Description]]>
						</description>
					</feature>
					<feature type="Bedroom" guid="f18a8613-138d-4619-ab05-d511e2969b70" length="1000" width="1000" units="metre">
						<heading>
							<![CDATA[Master Bedroom]]>
						</heading>
						<description>
							<![CDATA[32' 10" x 32' 10" (10.00m x 10.00m) Master Room Description]]>
						</description>
					</feature>
					<feature type="bathroom" guid="4dbfc0d5-35ea-4d53-837b-9abd0fc03890" length="1000" width="1000" units="metre">
						<heading>
							<![CDATA[Bathroom]]>
						</heading>
						<description>
							<![CDATA[32' 10" x 32' 10" (10.00m x 10.00m) Bathroom Room Description]]>
						</description>
					</feature>
				</area>
				<area title="Outside">
					<feature type="Garden" guid="d955b09f-ba5e-431d-9976-cc1812fdb49b">
						<heading>
							<![CDATA[Garden]]>
						</heading>
						<description>
							<![CDATA[Garden Description]]>
						</description>
					</feature>
					<feature type="Garage" guid="84c8ff84-0a23-4d43-b8c7-f5c5e84874ad">
						<heading>
							<![CDATA[Garage]]>
						</heading>
						<description>
							<![CDATA[Garage Description]]>
						</description>
					</feature>
				</area>
			</areas>
		</text>
		<NewHomesDetails/>
	</property>
</propertyFullDetails>

                                

                                    <property id="1680980" eaid="398" bid="603" 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="11/6/2010 09:15:55" bedrooms="3" bathrooms="1" receptions="2" leaseType="3" garages="1" gardens="1" otherrooms="2" specials="1" parkingSpaces="1" metropix="0" propertyType="5" period="Period" latitude="51.6424866741" longitude="-0.186223924" sold="0" branchRef="123" DtCreated="11/06/2010 10:29:35" SmallPicWidth="300" LargePicWidth="500" PortalID="999" visibility="private" />
                                

XML structure

Element	Element type	Data type
property	XML node	n/a	The root element of the xml
property/@id	XML attribute	int	The unique identifier for the property
property/@visibility	XML attribute	string	The visibility of 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/@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/@DtCreated	XML attribute	date time	The date the property was created 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: SALES Lettings PreVal 7 PreVal Val 8 Val Write-Up 10 Write-Up OnMarket 0 To Let Reduced 1 To Let (red) SSTC 2 -----NA----- Exchanged 6 -----NA----- Completed 4 Let Withdrawn Val 9 Withdrawn Val Withdrawn Inst 5 Withdrawn Inst
property/@statusFlag	XML attribute	string	The optional status flag of the property, possible values are: empty Under offer 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. Please contact Metropix regarding methods of obtaining the floorplan with the use of the Metropix ID
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/@branchRef	XML attribute	int	The unique branch reference supplied by the portal
property/@portalID	XML attribute	int	The unique portal ID
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/@SmallPicWidth	XML attribute	int	The requested width for thumbnail images
property/@LargePicWidth	XML attribute	int	The requested width for full images
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 the raw values of the EER and EIR ratings
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: num sa1 (street address 1) sa2 (street address 2) town city county country postcode locationcodes useAddress Within Dezrez customers can select what address lines they would like visible. This can be different for each agent, however their selection will apply a display="true or false" to each address line, dictating what is populated in the useAddress node. 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 It is recommended that you use the widths on the property node.
media/picture/@id	XML attribute	int	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 EER EIR aerialphoto thumbnail
media/picture/@categoryID	XML attribute	int	The id of the category the picture belongs to, possible values are: primary secondary floorplan maps Possibilities available: EER EIR aerialphoto 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. Descriptive information can contain alphanumeric data
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/particularsText	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. Its intended use is for price qualifiers such as: POA, Guide Price, Fixed Price, Offers in excess of, OIRO, Sale by Tender, From, Shared Ownership, Offers over, Part Buy Part Rent, Shared Equity
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	In Dezrez each room particular can be assigned to a specific area or floor. This is denoted in the area node title attribute. Some popular examples are: Ground Floor, First Floor, Garden or outside. Within each room particular a number of attributes are contained within the feature node. This will supply you with information on the type of room created along with the length and width dimensions in metric. Each room is accompanied with a heading node. The estate agent can type in any title required as this is an open text field. The description node will contain the room description. The estate agent can type in any descriptive information required as this is an open text field.
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
NewHomesDetails	XML element	string	This denotes if the property is a new build

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 & Second Floor (Maisonette)
9	Flat
49	Ground & 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

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 initially 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.