Технические требования к xml-файлу продаж

Общие требования

XML-документ, далее по тексту (Фид), должен быть составлен на языке XML и быть закодирован кодировкой UTF-8 или Windows-1251.

URL-адрес xml-файла должен быть постоянным и доступным по HTTP протоколу. При изменении разположения документа, необходимо сообщить в службу технической поддержки сайта. Если фид подключается на платной основе и информация из него не размещается на сайте по причине его недоступности URL-адреса, денежные средства не возвращаются.

Описание основной структуры xml-файла

Пролог или заголовок документа.

Фид должен начинаться со стандартного XML-заголовка, с нулевого символа первой строки и должен указывать версию языка и информацию о кодировке.

<?xml version="1.0" encode="utf-8"?>

или

<?xml version="1.0" encode="windows-1251"?>

Корневой элемент flats_sale.

Корневой элемент xml-файла. Должен содержать в только элементы offer, в каждом из которых должна находиться информация из одного объявления.

<flats_sale>
	<offer></offer></flats_sale>
			

Элемент offer.

Элемент несет всю инфомацию об одном размещаемом объявлении. Информация об объявлении передается в элементах и их атрибутах раположенных внутри элемента offer.

<offer>
	<id>1</id>
	<address />
</offer>

Описание элементов offer

Обязательные элементы

Элемент id.
Идентификатор объявления на ресурсе источнике. Целое положительное число. (Заполняется обязательно).

Элемент rooms_num.
Идентификатор количества комнат в объекте. Целое число от 0 до 5. (Заполняется обязательно).
0 = комната, 5 = 5 комнат и более.

Элемент address.
Информация о расположении объекта. Пустой элемет, всю информацию несет в атрибутах.
Атрибут locality - наименование населенного пункта. Cтрока.
Атрибут street - наименование улицы. Cтрока.
Атрибут house_str - строковое представление номера дома. Cтрока.
(пример: д. 17/1, д. 17 кор. 1 и т.п.)
Атрибут full_address - строковое представление полного адреса. Cтрока.
(пример: МО, Ивантеевка, Хлебозаводская, 41а)
Должны быть заполнены либо locality, street и house_str, либо full_address (объявления без адреса на ресурс могут не загружаются).

Элемент area.
Информация о площадях объекта. Пустой элемент, всю информацию несет в атрибутах.
Атрибут total - общая площадь объекта. Положительное десятичное число.
Атрибут living - жилая площадь объекта. Положительное десятичное число.
Атрибут kitchen - площадь кухни. Положительное десятичное число.
Атрибут rooms - строковое представление площадей объекта. Cтрока (максимум 100 символов).
(пример: 57/45.5/20/16/9.5)

Элемент price.
Информация о стоимости объета в рублях. Положительное целое число. (Заполняется обязательно).

Элемент floor.
Номер этажа на котором расположен объект. Положительное целое число. (Заполняется обязательно).
Атрибут total - общее количество этажей в доме в котором распологается объект. Положительное целое число. (Заполняется обязательно).

Элемент phone.
Контактный телефон. Cтрока. (Заполняется обязательно).
Допускается до двух номеров по 10 цифр без пробелов, разделенные между символом ";".
(примеры: один номер "9653331155", два номера "9653331155;4957757575")

Необязательные элементы

Элемент metro.
Станция метро (для Москвы). Пустой элемент, всю информацию несет в атрибутах.
Атрибут mid - Идентификатор станции метро согласно списка идентификаторов станций. Положительное целое число. (Заполняется обязательно).

Элемент options.
Информация по дополнительным условиям и ограничениям сдачи объекта. Пустой элемент, всю информацию несет в атрибутах.
"0" - означает: нет или запрещено, "1" - означает: есть или разрешено.
Атрибут object_type - Вторичное жилье или новостройка. Положительное целое число. (значения "1" – вторичное жилье, "2" – новостройка. По умолчанию, вторичное жилье.).
Атрибут sale_type - Тип сделки. Строка (значения "F" – свободная продажа, "A" – альтернатива. По умолчанию, свободная продажа.).
Атрибут phone - Наличие телефона. Строка (значения "1" или "0") По умолчанию "0".
Атрибут lift_passanger - Количество пассажирских лифтов. Положительное целое число (допустимые значения "0" - "9") По умолчанию "0".
Атрибут lift_cargo - Количество грузовых лифтов. Положительное целое число (допустимые значения "0" - "9") По умолчанию "0".
Атрибут wc_combined - Количество совмещенных санузлов. Строка (допустимые значения "0" - "9") По умолчанию "0".
Атрибут wc_separated - Количество раздельных санузлов. Строка (допустимые значения "0" - "9") По умолчанию "0".
Атрибут balcony - Количество балконов. Строка (допустимые значения "0" - "9". По умолчанию "0") По умолчанию "0".
Атрибут loggia - Количество лоджий. Строка (допустимые значения "0" - "9". По умолчанию "0") По умолчанию "0".
Атрибут windows - Вид из окна. Строка (значения "1" - на улицу, "2" - во двор, "3" - на улицу и во двор. По умолчанию "1").
Атрибут garbage - Наличие мусоропровода. Строка (значения "1" или "0". По умолчанию "0").
Атрибут repair - Общее состояние объекта. Строка (значения "1" - требуется капитальный ремонт, "2" - плохое состояние, "3" - без отделки, "4" - требуется ремонт, "5" - среднее состояние, "6" - хорошее состояние, "7" - сделан ремонт, "8" - отличное состояние, "9" - евроремонт, "10" - эксклюзивный евроремонт, "11" - первичная отделка, "12" - не указанно. По умолчанию "4", для новостройки "3").
Атрибут ipoteka - Возможность ипотеки. Положительное целое число (значения "1" или "0". По умолчанию "0").

Элемент photo.
Постоянная, абсолютная ссылка на изображение. Строка.
(В одном элементе допускается только одна ссылка. Если изображений больше одного, то ссылку на каждое изображение помещать в отдельный элемент photo)

Элемент note.
Комментарии к объявлению. Текст помещенный внутрь раздела символьных данных элемента CDATA.

Элемент source_link.
Ссылка на страницу объявления на сайте пользователя.
(примеры: " www.my_site.my/folder?id=1, http://my_site.my/folder?id=1, https://my_site.my/offer ")

Пример правильно сформированного xml-файла

<?xml version="1.0" encode="utf-8"?>
<flats_sale>
	<offer>
		<id>1</id>
		<address locality="Москва" street="Красина ул." house_str="13" />
		<metro_id id="8" />
		<rooms_num>3</rooms_num>
		<floor total="5">3</floor>
		<price>16000000</price>
		<area total="57.8" living="43.7" kitchen="6" rooms="19,1-13,4-11,2" />
		<options
			object_type="1"
			sale_type="F"
			lift_passanger="1"
			lift_cargo=""
			loggia=""
			balcony="1"
			wc_combined="1"
			wc_separated=""
			phone="0"
			windows="1"
			ipoteka="1"
		/>
		<phone>9635667700</phone>
	</offer>
	<offer>
		<id>2</id>
		<address full_address="Москва, Донецкая улица, д. 1 стр. 2" />
		<rooms_num>2</rooms_num>
		<metro_id id="146" />
		<floor total="12">12</floor>
		<price>9200000</price>
		<area total="54.3" living="31" kitchen="9" rooms="15-16" />
		<note><![CDATA[Хорошие метражи, очень удачная планировка.]]></note>
		<options
			object_type="1"
			sale_type="A"
			lift_passanger="2"
			lift_cargo="1"
			loggia="1"
			balcony=""
			wc_combined=""
			wc_separated="2"
			phone="1"
			ipoteka="1"
		/>
		<phone>9653336565;4997557700</phone>
		<photo>http://site.net/img/photo_1.jpg</photo>
		<photo>http://site.net/img/photo_2.jpg</photo>
		<photo>http://site.net/img/photo_3.jpg</photo>
		<photo>http://site.net/img/photo_4.jpg</photo>
		<source_link>http://my_site@zona/sale?ad_id=123</source_link>
	</offer>
</flats_sale>