Interface for the transfer of adverts

menyfält
Land                     
Språk

Interface for the transfer of adverts

Version 2.3


Principals of the transfer

Green-acres.com offers an XML interface that allows software or Internet sites ,on which the agencies enter their adverts, to export the adverts so as to publish them directly on Green-acres.com

a) Configuration Green-acres.com

Each agency has a 'Transfer' tab on their administrative interface to request the activation of the transfer system.

Send the adverts

The adverts are transferred with photos according to the format below. All the adverts sent will be published and the agency invoiced accordingly.

Unless otherwise requested, the publication of adverts is done on the basis of cancel and replace: All the adverts not in the flow will be taken off line automatically.

In compliance with the general sales conditions Green-acres.com, the agency is responsible for checking that the result of the transfer has been suitably carried out.

2) Test an xml file

Before doing anything else, open the file in a browser (Internet Explorer, or Firefox which give more detail) and check that the file does not contain any errors, and that all the characters are correctly displayed. Then use the validation formula here after.

Agency logon for this file
Xml file

3) File format

Name of files

The adverts are to be supplied in the form of an XML file that respects the format below (see part 3). 2 options are possible for the supply of the file:
  • FTP transmission: The file is supplied directly by FTP (example '212a.xml' or '212a-644.xml') using the access codes provided by Green-acres.com.

  • HTTP collection: Every day we collect a correctly formated XML file through a URL that is given to us.

b) Bilder

  • FTP transmission: The photos for the advert will be sent by FTP with the Green-acres.com reference number for the advert followed by the character '_' then the number of the photo starting by 1. Example: '212a-644_1.jpg' etc. Green-acres.com can accept up to 25 photos per advert.

    Be careful! The reference number being in lower case letters in the following specification, the names of the photos must also be in lower case.

  • HTTP collection: The photos can also be supplied by URL in the XML file by the tags <pic_1>,...<pic_25>, the URL must start with 'http: //' and finish with '.jpg' in lower case letters.
    Example: <pic_1>http://www.my-internet-site.com/photo/vrw6789.jpg</pic_1>

So as to limit the CPU on our servers, if the photos are already present on an advert, new photos will not be taken into account unless the agency ticks the box 'Force the update of the photos' ('Transfer' tab), before the transfer.

b) Contents of XML file

The text file describing an advert contains all the obligatory fields below and possibly the optional fields. The file must be in the xml format as follows:
File heading:

<?xml version="1.0" encoding="ISO-8859-1"?>
<Envelope>
<Body>
<add_adverts>

For each advert:

<advert>
(...)
</advert>

For each field of the element 'advert':

<field_name>field_text</field_name>

At the end of the file:
</add_adverts>
</Body>
</Envelope>

c) Example of file

To see an example of the file: Klicka här

d) Zip

The text and photo files can be grouped together in one zip file that will then be named according to the name of the agency. Eg. '212a.zip'.

e) Coding

The Occidental 'ISO-8859-1' coding is used as the default setting. The international 'utf-8' coding is also accepted. In this case, it is necessary to put 'utf-8' in the XML heading and to code the file in utf-8, then to contact us so that we can deal with the file as 'utf-8' on reception.

4) Obligatory fields

Field name Type Comment Example
owner varchar(15) Account reference at Green-acres.com 212a
reference varchar(20) Account reference and product reference for the agency. To contain only numbers, letters, '_' and '-'. Must be in lower case. By default, it is recommended to use the agencies mandate number as product reference, if the mandate number can be taken as a unique definition of the product. 212a-644 for property 644 for agency 212a
type enum ('properties', 'rentals', 'holidays') Type of advert (sale, rental, holiday rental  
price int(10) unsigned Price including agency fees - Charges for rental included in the case of a rental property 215000
currency char(3) Code for international currency (3 letters) EUR
postal_code varchar(5) Post code for the property 47300
commune varchar(75) Must only contain the name of the area without additional information (not 'near' or '5 mins from')
This field does not have to be the exact town of the property and can be a nearby town (See field 'precise location') 		Villeneuve sur lot
country_code char(2) Country code for the property fr
habitat enum ('old', 'recent', 'luxury', 'land', 'appartement', 'business', 'new', 'mobile_home', 'parking', 'bed_breakfast', 'gite' ) Type of property. The exact denomination depends on the country (in France: 'old' gives 'old house' - in Morocco: 'old' gives 'Riad') old

If you cannot fill out one of the obligatory fields, the advert is nevertheless, by default, created and put on hold. The agency can later access the adverts that have been put on hold and fill out the missing information. If only the environment and / or the habitat are missing, this will be guessed from the text summary (beware, the error rate is high) and the optional field 'status' can be pushed to 'ok' (see below).

5) Optional fields

Field name Type Comment Example
mandate_number varchar 16 Mandate number. If the number number used is a computer reference, you can use the mandate number here, as well as any number relevent to the agency, to find a property quickly. Wd-5913
title_XX varchar 60 The title of the advert in the XX language where it is necessary to replace XX by the language code (title_fr). It is possible to insert a title _XX for each language that is active on the site. Limited to 60 characters.
Automatic translations are forbidden in that section. 		Charmante propriété sur 5 ha de terrain
summary_XX blob Text giving the general presentation of the property in language XX, where XX must be replaced by the language code (summary_en). It is possible to enter a summary element_XX for each active language on the site.
Automatic translations are forbidden in that section. 		Située dans le village de Laz, avec bar et commerce à une courte distance à pied, cette maison qui nécessite de travaux de rénovation bénéficie d'une vue étonnante sur la vallée de l'Aulne et au-delà.
h_surface int Habitable surface in m² 250
l_surface int Land area in m² 20000
n_rooms int Number of rooms 6
n_beds int Number of bedrooms 3
n_baths int Number of bathrooms 2
environment enum ('country', 'village', 'town', 'city', 'beach', 'mountain') The type of area where the property is located country
precise_location int Locality compared to the post code:
0 = near (default value)
1 = Exact locality 		0
street_number varchar(12) Street number 17 bis
street_name varchar(64) Street name Avenue Aristide Briand
metro varchar(32) Name of the closest metro / tube station Porte d'Orléan
distance_metro int Distance in minutes from the nearest metro / tube station 5
airport varchar(32) Name of the nearest airport Bergerac
distance_airport int Distance in minutes from the nearest airport 5
train varchar(32) Name of the nearest station Bergerac
distance_train int Distance in minutes from the nearest station 5
charges int Rental charges 150
furnished enum(0,1) Unfurnished / furnished for rental properties (Default: 0 unfurnished) 0


6) Display the xsd specifications file

Klicka här

Legal considerations

Green-acres.com declines any responsibility for problems and possible loss of data whatsoever due to the use of the software or the internet site offering a gateway to these sites.

The agency is responsible for checking that the result of the transfer corresponds to their expectations and that they effect any necessary modifications directly on Green-acres.com