Требования к XML-файлу
Требования к XML-файлу
Файл данных XML содержит описание рекламных объявлений, предназначенных для подачи на сайт Citysakh. ru. Файл данных должен:
§ Иметь кодировку UTF-8.
§ Файл данных XML должен быть правильно построенным (well-formed), то есть, иметь правильный синтаксис, и действительным (valid), то есть, соответствовать определенному ниже Описанию структуры и состава файла данных XML.
Общие положения
Файл данных обязательно должен содержать корневой элемент Ads с атрибутами target="Citysakh. ru" и formatVersion="1".
Корневой элемент Ads может содержать одно или несколько объявлений, каждое из которых должно быть описано элементом Ad.
Имена элементов чувствительны к регистру и состоят из английских букв.
Общие атрибуты объявления
Для всех объявлений существует неизменный набор атрибутов, вне зависимости от типа объявления. Данные атрибуты описаны в разделе Общие атрибуты для всех категорий.
Специфические атрибуты для категорий
Каждый тип объявлений выделен в отдельную категорию. Категория объявления указывается элементом Category внутри каждого элемента Ad. В зависимости от категории к заполнению данных объявления предъявляются разные требования к набору специфических атрибутов. Эти требования представлены в таблицах атрибутов по категориям.
Типы данных
В описании атрибутов приняты следующие обозначения типов данных:
· Строка — произвольная последовательность символов, возможные ограничения по длине указываются рядом.
· Строка, одно из перечисленных значений — в атрибуте требуется указать строковое значение, одно из возможных значений, перечисленных рядом.
· Integer — целое число
· Decimal — число с дробной частью. Целая и дробная части разделяются точкой.
Идентификатор
Каждое объявление должно обязательно иметь элемент Id, в котором содержится уникальный идентификатор объявления в вашей базе. Идентификатором может быть любая строка до 100 символов, например:
· простой номер объявления: 52, 1181
· составной номер объявления: 1-515, 10_9023
· составной буквенно-цифровой номер: АБ-23, XYZ-817
Местоположение объявления
Местоположение объекта объявления указывается с помощью элементов City, Street, Building, MapLong, MapLat.
В элементе City указывается населенный пункт из справочника городов и улиц. Этот справочник содержит далеко не все города, поэтому если требуемый населенный пункт там отсутствует, то указывается ближайший к вашему объекту. В поле Street указывается улица из справочника городов и улиц. В поле Building указывается номер дома и буква, если есть, например: 24, 24б, 24Б, 24-1, 24/1. В полях MapLong и MapLat указываются координаты на Яндекс. Картах, например:
<MapLong>46.628401</MapLong>
<MapLat>142.775042</MapLat>
Фотографии
Фотографии для объявления указываются внутри элемента Images, по одному элементу Image на каждую фотографию. На файл изображения можно ссылаться следующим образом.
· Передать вместе с xml-файлом с данными в одном zip-архиве, в корне, без поддиректорий. В элементе Image именем файла заполняется атрибут name. Пример:
<Image name="a3.jpg"/>
· Передать в виде ссылки на ресурс в интернете. В элементе Image ссылкой на фото заполняется атрибут url. Пример:
<Image url="http://img. industry-soft. ru/591F0E40-2238-48DB-8F7B-4A4F3A0F2BA1.jpg"/>
Указание обоих атрибутов не допускается.
Для каждого объявления максимальное количество фотографий равно 12. Все фотографии свыше этого количества игнорируются.
Общие атрибуты объявлений
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Id | Уникальный идентификатор объявления | + | строка не более 100 символов | |
Category | Категория объявления | + | Квартира Дом Земля Гараж Комната Коммерческая недвижимость | строка, одно из перечисленных значений |
Directory | Тип объявления | + | Продам Сдам | строка, одно из перечисленных значений |
City | Город или населенный пункт. | + | Значение из Справочника городов и улиц. | строка, одно из перечисленных значений |
Street | Улица | Значение из Справочника городов и улиц. | строка, одно из перечисленных значений | |
Building | Дом | строка | ||
MapLong | Долгота | decimal | ||
MapLat | Широта | decimal | ||
Area | Площадь (в м. кв.) | + | decimal | |
Price | Цена в рублях | + | integer | |
Text | Описание | строка не более 500 символов | ||
Tel | Контактный телефон | + | строка, содержащая от 6 до 11 цифр | |
Tel2 | Контактный телефон | строка, содержащая от 6 до 11 цифр | ||
Tel3 | Контактный телефон | строка, содержащая от 6 до 11 цифр |
Атрибуты по категориям
Квартиры
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Category | Категория объявления | + | Квартира | строка |
Daily | Посуточно Только для типа «Сдам» | да | строка | |
Type | Планировка Для типа «Продам» поле ОБЯЗАТЕЛЬНО | +/- | серия 97 серия 97-С серия 102 серия 138 серия 306 сталинка хрущевка брежневка гостинка индивидуальная новая планировка новостройка | строка, одно из перечисленных значений |
Rooms | Количество комнат в квартире Для типа «Продам» поле ОБЯЗАТЕЛЬНО | +/- | integer | |
Floor | Этаж, на котором находится объект Для типа «Продам» поле ОБЯЗАТЕЛЬНО | +/- | integer | |
Floors | Количество этажей в доме Для типа «Продам» поле ОБЯЗАТЕЛЬНО | +/- | integer | |
Furniture | Мебель | отсутствует частично полностью | строка, одно из перечисленных значений | |
Phone | Телефон | да | строка | |
Tv | Кабельное ТВ | да | строка | |
Internet | Интернет | да | строка | |
Gas | Газ | есть | строка |
Дома
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Category | Категория объявления | + | Дом | строка |
Rooms | Количество комнат в квартире Для типа «Продам» поле ОБЯЗАТЕЛЬНО | +/- | integer | |
Floors | Количество этажей в доме Для типа «Продам» поле ОБЯЗАТЕЛЬНО | +/- | integer | |
Own | Земля | + | в аренде в собственности | строка, одно из перечисленных значений |
Furniture | Мебель | отсутствует частично полностью | строка, одно из перечисленных значений | |
Phone | Телефон | да | строка | |
Tv | Кабельное ТВ | да | строка | |
Internet | Интернет | да | строка | |
Water | Водоснабжение | скважина центральное | строка | |
Sewage | Канализация | септик центральная | строка | |
Heating | Отопление | автономное центральное | строка | |
Gas | Газ | есть | строка |
Земля
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Category | Категория объявления | + | Земля | строка |
Own | Земля | + | в аренде в собственности | строка, одно из перечисленных значений |
Water | Водоснабжение | скважина центральное | строка | |
Sewage | Канализация | септик центральная | строка | |
Heating | Отопление | автономное центральное | строка | |
Use | Использование | ИЖС дачное подсобное хозяйство ком. застройка сельское хозяйство | строка | |
Gas | Газ | есть | строка | |
Elec | Электричество | есть | строка |
Гаражи
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Category | Категория объявления | + | Гараж | строка |
Elec | Электричество | есть | строка |
Комнаты
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Category | Категория объявления | + | Комната | строка |
Daily | Посуточно Только для типа «Сдам» | да | строка | |
Furniture | Мебель | отсутствует частично полностью | строка, одно из перечисленных значений | |
Phone | Телефон | да | строка | |
Tv | Кабельное ТВ | да | строка | |
Internet | Интернет | да | строка | |
Gas | Газ | есть | строка |
Коммерческая недвижимость
Название элемента | Описание | Обязательное | Возможные значения параметра | Тип данных и ограничения |
Category | Категория объявления | + | Коммерческая недвижимость | строка |
Own | Земля | + | в аренде в собственности | строка, одно из перечисленных значений |
Water | Водоснабжение | скважина центральное | строка | |
Sewage | Канализация | септик центральная | строка | |
Heating | Отопление | автономное центральное | строка | |
Use | Использование | производство магазин склад офис | строка | |
Gas | Газ | есть | строка | |
Elec | Электричество | есть | строка |
Пример xml-объявления
<?xml version="1.0"?>
<Ads target="Citysakh. ru" formatVersion="1">
<Ad>
<Id>5257</Id>
<Directory>Продам</Directory>
<Category>Квартира</Category>
<City>Корсаков</City>
<Street>Краснофлотская ул.</Street>
<Building>6</Building>
<MapLong>46.628401</MapLong>
<MapLat>142.775042</MapLat>
<Area>45</Area>
<Rooms>2</Rooms>
<Floor>4</Floor>
<Floors>5</Floors>
<Price>1700000</Price>
<Text>Срочно, в связи с переездом продам 2-х комнатную квартиру в хорошем состоянии. Окна ПВХ, балкон застеклён, ж/дверь, солнечная сторона. Рядом школа, поликлиника, остановка, магазины. Торг. Звонить в любое время.</Text>
<Phone>+7 (924) 285-12-35</Phone>
<Phone2>89146434353</Phone2>
<Phone3>8-924-282-82-38</Phone3>
<Images>
<Image name="164530.jpg"/>
<Image name="164465.jpg"/>
<Image name="164466.jpg"/>
</Images>
</Ad>
<Ad>
<Id>81548</Id>
<Directory>Продам</Directory>
<Category>Комната</Category>
<City>Корсаков</City>
<Area>36</Area>
<Rooms>2</Rooms>
<Floor>1</Floor>
<Floors>1</Floors>
<Price>1780000</Price>
<Text>12-А мкрн. Эксклюзивное малобюджетное предложение! Комната в секционном общежитии, в хорошем состоянии. Сухая, теплая, светлая, просторная комната. Окна ПВХ выходят на юг. Места общего пользования (душевые комнаты, бытовка, кухня) в хорошем состоянии. Приличные соседи. Парковка для автомобиля. Здание не у дороги.</Text>
<Phone>27-22-55</Phone>
</Ad>
</Ads>
