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

Общие требования
Описание основной структуры xml-файла
Описание элементов offer
Пример правильно сформированного xml-файла

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

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

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

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

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

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

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

или

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

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

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

<flats_rent>
	<offer>
		…
	</offer>
	…
</flats_rent>

Элемент 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.
Информация о стоимости аренды объекта в рублях за один месяц. Положительное целое число. (Заполняется обязательно).
Атрибут prepay - количество месяцев предоплаты. Положительное целое число. (по умолчанию принимает значение 1)
Атрибут deposit - наличие страхового депозита. Целое число (значения "0" или "1"). (по умолчанию принимает значение 0)

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

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

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

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

Элемент com.
Информация о размере коммисионных. Пустой элемент, всю информацию несет в атрибутах.
Атрибут client - Коммиссионные клиенту. Положительное десятичное число.
Атрибут agent - Коммиссионные агенту. Положительное десятичное число.

Элемент options.
Информация по дополнительным условиям и ограничениям сдачи объекта. Пустой элемент, всю информацию несет в атрибутах.
"0" - означает: нет или запрещено, "1" - означает: есть или разрешено.
Атрибут kids - Допускается ли арендатор с детми. Положительное целое число (значения "1" или "0").
Атрибут pets - Допускается ли арендатор с животными. Положительное целое число (значения "1" или "0").
Атрибут rfgr - Наличие холодильника. Положительное целое число (значения "1" или "0").
Атрибут mebel_kitchen - Наличие кухонной мебели. Положительное целое число (значения "1" или "0").
Атрибут wm - Наличие стиральной машины. Положительное целое число (значения "1" или "0").
Атрибут mebel - Наличие комнатной мебели. Положительное целое число (значения "1" или "0").
Атрибут internet - Наличие интернета. Положительное целое число (значения "1" или "0").
Атрибут phone - Наличие стационарного телефона. Положительное целое число (значения "1" или "0").
Атрибут tv - Наличие телевизора. Положительное целое число (значения "1" или "0").
Атрибут balcony - Наличие балкона. Положительное целое число (значения "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" encoding="windows-1251"?>
<flats_rent>
	<offer>
		<id>1</id>
		<address locality="Москва" street="Гражданская 4-я ул." house_str="35" />
		<metro_id id="40" />
		<rooms_num>0</rooms_num>
		<floor total="5">2</floor>
		<price prepay="1" deposit="1">18000</price>
		<area total="42" living="28" kitchen="7" />
		<note><![CDATA[Квартира с дизайнерским ремонтом, делали для себя]]></note>
		<options
			kids="0"
			pets="1"
			rfgr="1"
			mebel_kitchen="1"
			wm="0"
			mebel="1"
			internet="0"
			phone="1"
			tv="1"
			balcon="0"
		/>
		<phone>9673332255;4953123687</phone>
		<photo>http://mysite.ru/img/image_1.jpg</photo>
		<com client="20" agent="20" />
	</offer>
	<offer>
		<id>2</id>
		<address full_address="MO г. Балашиха ул. Советская д. 14" />
		<rooms_num>2</rooms_num>
		<floor total="9">4</floor>
		<price>25000</price>
		<area rooms="57/45.5 20/16/9.5" />
		<note><![CDATA[Добираться маршруткой от метро Новогиреево]]></note>
		<options
			kids="1"
			pets="1"
			rfgr="1"
			mebel_kitchen="0"
			wm="0"
			mebel="1"
			internet="1"
			phone="0"
			tv="1"
			balcon="1"
		/>
		<phone>9633862282</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>
		<com client="0" agent="0" />
		<source_link>http://my_site@zona/sale?ad_id=123</source_link>
	</offer>
</flats_rent>