XML Specification for Yazuul! ! ! ! ! ! ! ! ! ! ! XML! Specification! for! Yazuul! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! Version 1.0 Approved! ! Prepared by Stefan van Zanden! ! Yazuul BV! ! ! ! 1 januari 2014 Page i XML Specification for Yazuul! 1. Table of Contents! ! 1. Revision History! iii! 1. Introduction! iv! 2. XML Feed!iv! XML Feed! v! XML Property! v Page ii XML Specification for Yazuul! Page iii 2. Revision History! ! Date Author Reason for Changes Version 2014-01-01 SvZ Initial version 1.0 2014-01-19 SvZ Added Indonesia specific fields and added video support 1.1 2014-07-18 SvZ Added type house / resort / chalet / castle / hotel and removed terracedhouse / specials! Added provisioning of features 1.2 XML Specification for Yazuul! 1. Introduction! ! The Yazuul XML offers 3th party’s the ability to connect to our portals.! ! This document contains the specification and the description of the Yazuul XML.! ! ! ! 2. XML Feed! ! For us to be able to read your XML, you need to create a so called XML Feed and generate this in a public location, for example:! http://www.yazuul.com/feed.xml! ! The XML that has to be generated by you will look something like the following:! Page iv XML Specification for Yazuul! Page v ! XML Feed! ! Start your XML feed with the following:! ! <?xml version="1.0"?>! <root>! ! <yazuul version=“1"/>! ! <properties>! ! ! ! </properties>! </root>! ! ! In between the <properties></properties> node you will need to define your individual properties.! ! You can test your XML using our test tool which can be found on:! http://www.yazuul.com/xml/test! ! ! XML Property! ! An example of a single property is shown below, every single node will be explained later on in this document:! ! <property>! ! <date_last_changed>1388752771</date_last_changed>! ! <id>59</id>! ! <kind>exist</kind>! ! <name>! ! ! <![CDATA[ Appartement Avenida in Albir ]]>! ! </name>! ! <type>apartment</type>! ! <build_style>bungalow</build_style>! ! <ref_nr>AS01</ref_nr>! ! <status>available</status>! ! <address>! ! ! <region>Costa Blanca</region>! ! ! <location>Albir</location>! ! ! <zipcode>3844AD</zipcode>! ! ! <street>Some street</street>! ! ! <housenumber>40</housenumber>! ! ! <housenumber_addition>a</housenumber_addition>! ! ! <floor>3</floor>! ! ! <geocode>! ! ! ! <latitude>40.3233</latitude>! ! ! ! <longitude>40.4444</longitude>! ! ! </geocode>! ! </address>! ! <bedrooms>1</bedrooms>! ! <bathrooms>1</bathrooms>! ! <living_space>230</living_space>! ! <lot_size>400</lot_size>! ! <garages>! ! ! <garage>! XML Specification for Yazuul! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! <type>garage</type>! ! ! <capacity>20</capacity>! ! </garage>! </garages>! <pools>! ! <pool>communal</pool>! </pools>! <views>! ! <view>mountain-view</view>! ! <view>town</view>! </views>! <features>! ! <feature>furnished</feature>! ! <feature>guesthouse</feature>! </features>! <price>! ! <rent>! ! ! <price>38</price>! ! ! <condition>per-day</condition>! ! </rent>! ! <buy>! ! ! <price>38</price>! ! ! <on_request>true</on_request>! ! ! <ownership>freehold</ownership>! ! </buy>! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! </price>! <texts>! ! <text>! ! ! ! ! ! ! ! ! ! ! ! ! ! ! ! Page vi <language>nl</language>! <type>offering</type>! <content>! ! ! <![CDATA[! ! t met oven, wasmachine, vaatwasser, strijkijzer, magnetron, broodrooster, ! koffiezetapparaat, elektronische mixer en sinaasappelpers. De luxe ! ! badkamer heeft twee wastafels, Jacuzzi bad en thermostatische douche.! ! ! ! De appartementen beschikken over airconditioning en centrale verwarming, ! ! ! een audio systeem met DVD/CD-speler die in elke kamer beluisterd kan ! ! ! worden, automatische rolgordijn! ! ! ! ]]>! ! ! </content>! ! </text>! ! </texts>! <media>! ! <images>! ! ! <image>! ! ! ! <url>http://www.real-estate-properties-spain.com/xml/yazuul/image/?! ! ! ! propertyId=59&fileName=02.jpg</url>! ! ! </image>! ! </images>! ! <videos>! ! ! <video>! ! ! ! <url>http://www.youtube.com/watch?v=ljBklalNxRY</url>! ! ! ! <type>youtube</type>! ! ! </video>! ! </videos>! ! <links>! ! ! <link>! ! ! ! <url>http://www.real-estate-properties-spain.com/nl/property/details/59</url>! XML Specification for Yazuul! Page vii ! ! ! ! <type>project-on-website</type>! ! ! ! </link>! ! ! </links>! ! </media>! </property>! ! ! /root/properties/property! This XML node contains the property information and can be provided multiple times in the ! <properties> XML node.! ! /root/properties/property/date_last_changed! (Required) This is a timestamp used by our service to detect if there are any changes to the property made since the last time we have imported it. In case your project is new just add the timestamp of the time te project was created here.! ! /root/properties/property/id! (Required) This is the id of the property in your own system, we can use this to uniquely identify the property (should be a valid integer).! ! ! /root/properties/property/kind! (Required) Define if this property is a new or existing property, valid values are:! new! exist! ! /root/properties/property/name! (Required) Define a recognizable name for your property to see in your Yazuul account, this text must be contained within: ! <![CDATA[ ! ]]>! ! /root/properties/property/type! (Required) What type is this property, valid values are:! apartment! penthouse! farmhouse! chalet! resort! castle! villa! bungalow! two-in-1-hood! business-space! finca! building-plot! bed-and-breakfest! hotel! other! ! /root/properties/property/ref_nr! XML Specification for Yazuul! Page viii (Required) This is your own reference number that you use in your own system to recognize the property, on our website this will be displaced prefixed by your realtor reference number in our system, for example, in your system AS01 will be translated to R23-AS01 in our system.! ! /root/properties/property/status! (Required) The status of this property, valid values are:! available! sold! sold-under-subject! ! /root/properties/property/build_style! (Required) The build style of this property, valid values are:! design-villa! ibiza! moorish! traditional! nationwide! urban! modern! ! /root/properties/property/address/region! (Required) The address region of where the property resides in, accepted values can be found on:! http://www.yazuul.com/xml/regions ! ! /root/properties/property/address/location! (Required) The address location of where the property resides in, accepted values can be found on:! http://www.yazuul.com/xml/locations! ! /root/properties/property/address/zipcode! The address zipcode, for example:! 3846AH! 3000B! ! /root/properties/property/address/street! The address street! ! /root/properties/property/address/housenumber! The address house number! ! /root/properties/property/address/housenumber_addition! The address house number addition! ! /root/properties/property/address/floor! The address floor (for example in case of an apartment), this must a valid integer, for example:! 2! 3! ! /root/properties/property/geocode/latitude! XML Specification for Yazuul! Page ix The address geocode latitude, this must a valid integer, for example:! 200.3333! 32.33333! ! /root/properties/property/geocode/longitude! The address geocode longitude, this must a valid integer, for example:! 200.3333! 32.33333! ! /root/properties/property/bedrooms! The number of bedrooms this property has, this must a valid integer, for example:! 2! 3! ! /root/properties/property/bathrooms! The number of bathrooms this property has, this must a valid integer, for example:! 2! 3! ! /root/properties/property/living_space! The size of the living space, this must a valid integer, for example:! 200! 300! ! /root/properties/property/lot_size! The size of the lot, this must a valid integer, for example:! 300! 500! ! /root/properties/property/garages/garage! This XML node contains the garage information and can be provided multiple times in the ! <garages> XML node.! ! ! /root/properties/property/garages/garage/type! This property contains the type of the specific garage provided, valid values are:! garage! carport! parking-place! ! /root/properties/property/garages/garage/capacity! This property contains the capacity of the specific garage provided, this must a valid integer, for example:! 2! 3! ! /root/properties/property/pools/pool! This XML node contains the pool information and can be provided multiple times in the ! <pools> XML node, valid values are:! communal! private! optional! XML Specification for Yazuul! Page x yes! ! /root/properties/property/views/view! This XML node contains the view information and can be provided multiple times in the ! <views> XML node, valid values are:! sea-view! mountain-view! forest! panorama! valley! town! ! /root/properties/property/features/feature! This XML node contains the feature information and can be provided multiple times in the ! <views> XML node, valid values are:! furnished! guesthouse! storey! ! /root/properties/property/price/rent/price! This XML node contains the rent price for this property, this must a valid integer, for example:! 200! 400! ! /root/properties/property/price/rent/condition! This XML node contains the rent price condition for the rent price, valid values are:! per-day! per-week! per-month! ! /root/properties/property/price/rent/valuta! This XML node contains the rent price valuta for the rent price, valid values can be found on:! http://www.yazuul.com/xml/pricevaluta! ! /root/properties/property/price/rent/on_request! This XML node contains if the rent price is on request, valid values are:! yes! ! /root/properties/property/price/buy/price! This XML node contains the buy price for this property, this must a valid integer, for example:! 200! 400! ! /root/properties/property/price/buy/valuta! This XML node contains the rent price valuta for the buy price, valid values can be found on:! http://www.yazuul.com/xml/pricevaluta! ! /root/properties/property/price/buy/on_request! XML Specification for Yazuul! This XML node contains if the buy price is on request, valid values are:! true! ! /root/properties/property/price/buy/ownership! This XML node contains is only used for properties in Indonesia, valid values are:! freehold! leasehold Page xi XML Specification for Yazuul! Page xii /root/properties/property/texts/text! This XML node contains the text information and can be provided multiple times in the ! <texts> XML node (for each language a separate node is required).! ! /root/properties/property/texts/text/language! This XML node contains the language of the text, valid values can be found on:! http://www.yazuul.com/xml/languages! ! /root/properties/property/texts/text/type! This XML node contains the type of this text, valid values are:! intro! ! /root/properties/property/texts/text/content! This XML node contains the actual text in the provided language, this text must be contained within: ! <![CDATA[ ! ]]>! ! XML Specification for Yazuul! Page xiii ! /root/properties/property/media/images/image! This XML node contains the image information and can be provided multiple times in the ! <images> XML node (for each language a separate node is required).! ! ! /root/properties/property/media/images/image/url! This XML node contains the url to the image, for example:! http://www.real-estate-properties-spain.com/xml/yazuul/image/?! propertyId=59&fileName=02.jpg! ! ! ! Some additional notes about the images:! 1. The images will be shown on the website in the order they have been provided, so make sure the right order is been generated in the XML feed;! 2. Make sure the images contain no watermark, Yazuul will make sure your images will be shown with our own watermark;! 3. For best result provide images with a minimum width of 450 pixels and minimum height of 243 pixels;! 4. For high quality display of the property on the property detail pages, please use a minimum width of 947 pixels and minimum height of 510 pixels for your images;! ! /root/properties/property/media/links/link! This XML node contains the link information and can be provided multiple times in the ! <links> XML node.! ! /root/properties/property/media/links/link/type! This XML node contains the type of the link, for example:! project-on-website! ! ! (Links to the object detail page of your own website)! ! /root/properties/property/media/links/link/url! This XML node contains the url to the location, for example:! http://www.real-estate-properties-spain.com/nl/property/details/59! ! ! /root/properties/property/media/videos/video! This XML node contains the video information and can be provided multiple times in the ! <videos> XML node.! ! /root/properties/property/media/videos/video/type! This XML node contains the type of the video, for example:! youtube! ! ! ! ! /root/properties/property/media/videos/video/url! This XML node contains the url to the location, for example:! http://www.youtube.com/watch?v=ljBklalNxRY! !
© Copyright 2024 ExpyDoc
