Описание XML-формата системы

Заголовок:

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

Примеры XML-файлов для описания различных типов недвижимости:

Общая структура и корневой элемент:

<root>

    <offers>
        <offer>
        ...
        </offer>
        ...
    </offers>
</root>
 

Структура блока offer:

Звездочками * обозначены обязательные поля.

Для полей, подразумевающих выбор одного из вариантов, регистр символов неважен.

Общая информация.

Информация об условиях сделки.

Информация о продавце.

Географические данные.

Детальная информация об объекте.

Общая информация:

Тег   Описание
id *   Идентификатор объявления в базе данных партнера, предоставляющего выгрузку. Тип: целое число, только цифры, без букв. id объявлений не должен превышать 10 символов.
part*  

Общий тип недвижимости, к которому относится объявление. Допустимые значения:

  • жилая
  • загородная
  • коммерческая
object-type*  

Тип объекта. Допустимые значения:

Для жилой недвижимости:

  • Квартира
  • Квартира в новостройке
  • Комната
  • Новостройка (данный тип доступен для размещения только для застройщиков)
  • Жилой комплекс (данный тип доступен для размещения только для застройщиков)

Для загородной недвижимости:

  • Коттедж
  • Дом
  • Дача
  • Таунхаус
  • Загородный участок 
  • Участок

Для коммерческой недвижимости

  • Помещение свободного назначения
  • Производство
  • Офис
  • Торговое помещение
  • Сфера услуг
  • Склад
  • Здание
  • Участок
  • Другое
description*   Описание объявления в свободной форме (не менее 50 символов)
url   Ссылка на объявление
created-at*   Дата подачи объявления в формате (YYYY-MM-DD / DD-MM-YYY / DD.MM.YYY )
updated-at*   Дата последнего изменения объявления (YYYY-MM-DD / DD-MM-YYY / DD.MM.YYY )
images   Набор элементов со ссылками на фотографии объекта (обязательно для всех видов недвижимости для проекта Юла). Размер одной фотографии не должен превышать 10 мб
  image primary="1/0" Фотография объекта. Атрибут primary определяет - будет ли данное изображение использоваться в качестве основного

Информация об условиях сделки:

Тег     Описание
bargain*     Набор элементов, описывающих условия сделки
  type*  

Тип сделки. Доступные значения:

  • продажа
  • аренда

Не обязательно для новостроек

  share   Предлагается к продаже доля от объекта (только продажа), например часть комнаты, часть загородного дома. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  haggle  

Торг возможен. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  objects-count   Количество объектов в предложении
  mortgage   Возможна ипотека (только продажа). Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  prepayment   Предоплата в %. Неотрицательное целое число
  pledge   Залог. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  fee  

Комиссия арендатора (только аренда). Доступные значения:чения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  fee-value  

Размер комиссии арендатора. Доступные значения:

  • размер комиссии в процентах, число со знаком процента в конце, напр. "15%"
  • размер комиссии в рублях, например, "5000 рублей" или "5000 руб." или просто "5000"
  pets   Возможно заселение с животными (только аренда). Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  children   Возможно заселение с детьми (только аренда). Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  price*   Набор элементов, описывающих цену
    value*

Значение цены. Положительное число с плавающей точкой

Не обязательно для новостроек (при условии наличия информации о ценах (обязательно для всех видов недвижимости для проекта Юла) внутри блока housing-stock)

    value-max Верхняя граница диапазона цен (если в предложении несколько объектов)
    unit

Единица измерения для цены. Доступные значения:

  • total (по-умолчанию)
  • m2 или м2 - цена указана за м2
    currency Валюта. Трехбуквенный индекс валюты, например, RUR, USD, EUR
    period

Период, за который указана цена (только аренда). Доступные значения: 

  • year или год
  • month или месяц
  • day или сутки
  • hour или час
 

Только для новостроек

fz214

 

Продажа по ФЗ №214. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

sales-started

 

Продажи начались. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

maternity-capital

 

Ипотека с использованием материнского капитала. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

military-mortgage

 

Военная ипотека. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

payment-installment

 

Возможна рассрочка. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

discount

  Акции и скидки. Текст.

Информация о застройщике (Только для Новостроек):

Тег   Описание
developer   Набор элементов, описывающих продавца
  name* Название застройщика. Строка
  description Описание, строка
  email E-mail застройщика
  url Ссылка на сайт
  phone Телефон
  address Адрес
  logo-url Ссылка на логотип

Документы, связанные с ЖК (Только для Новостроек):

Тег     Описание
documents     Контейнер для множества записей document
  document    
    name Название документа
    url Ссылка на документ в формате PDF
  ...    

Информация о продавце (обязательна для всех объявлений):

Тег   Описание
seller   Набор элементов, описывающих продавца
  phone* Телефон для связи (не более одного)
  extension Добавочный тел. (не более одного)
  name Название компании или имя продавца (не более одного)
  email* Адрес почты для связи (не более одного)

Дополнительный список продавцов для новостроек (если их несколько):

Тег     Описание
sellers     Контейнер для записей seller
  seller    
    name Название компании
    phone Телефон для связи

Географические данные:

Детальное описание обязательных полей:

  • Для всех объектов обязательными полями являются country, state, town
  • Для объявлений в РФ по объектам недвижимости, обладающим адресом (т.е. не земельные участки), обязательным полем является street и информация о нумерации дома в блоке house
  • Для земельных участков в РФ указание улицы и дома (street, house) необязательно
  • Для объявлений на Украине, в Беларуси и Узбекистане, указание улицы и дома (street, house) необязательно (но желательно)
  • Для всех объектов кроме квартир и комнат в небольших деревнях или поселках, а также для новостроек (без утвержденной адресации) обязательна улица street, но номер дома, то есть блок house можно опустить.
Тег     Описание
location*     Набор элементов, описывающих географической положение объекта объявления
  country*   Страна
  state*   Регион внутри страны, в которой размещается объект.  Для РФ – область.
  region   Район внутри региона или области, в котором размещается объект
  town*   Город/поселок/деревня/село 
  town-region   Район внутри города
  district   Округ (только для Москвы)
  street*  

Улица

Не обязательно для новостроек

  house*  

Набор элементов, описывающих номер дома

Не обязательно для новостроек

    number Номер дома, включая дробь
    building Номер или литера строения
    struct Номер корпуса
  subway   Набор элементов, описывающих удаленность объекта от метро (для городов с метро)
    name Название станции
    distance Значение удаленности
    distance-type

Тип удаленности. Доступные значения:

(если ничего не указано, по умолчанию ставится "минут пешком")

  • км
  • минут пешком
  • минут транспортом
  highway   Для объектов в Московской области. Набор элементов, описывающих ближайшее к объекту шоссе и удаленность от МКАД
    name Название шоссе
    distance Значение удаленности от МКАД в км.
  latitude   Широта (Обязательно для Новостроек и квартир в новостройках.)
  longitude   Долгота (Обязательно для Новостроек и квартир в новостройках.)
 

Только для новостроек

route

  Маршруты проезда к объекту.
    transport На общественном транспорте. Текст.
    car На машине. Текст.

Детальная информация об объекте:

Тег         Описание
floor*         Описание этажности (обязательно для квартир)
  total*       Всего этажей (обязательно для квартир для realty.mail.ru и для квартир и комнат проекта Юла)
  current*       Этаж, на котором располагается объект (обязательно для квартир для realty.mail.ru и для квартир и комнат проекта Юла)
area*        

Описание площадей

Не обязательно для новостроек

  total*       Общая площадь объекта в м2 (обязательно для всех видов недвижимости для проекта Юла)
  total-max       Верхняя граница диапазона площади (если в предложении участвует несколько объектов)
  living       Жилая площадь, м2
  living-max       Верхняя граница диапазона жилой площади (если в предложении участвует несколько объектов)
  kitchen       Площадь кухни, м2
  kitchen-max       Верхняя граница площади кухни (если в предложении участвует несколько объектов)
  plot       Площадь участка, сот (обязательно за загородной недвижимости)
  plot-max       Верхняя граница площади участка (если в предложении участвует несколько объектов)
house-info         Информация о доме
  house-type      

Тип дома. Доступные значения:

  • Панельный
  • Кирпичный
  • Монолитный
  • Кирпично-монолитный
  • Сталинский дом
  • Старый фонд
  • Индивидуальный проект
  • Деревянный
  • Блочный 
  commercial-building-type      

Тип коммерческого строения. Доступные значения:

  • Бизнес центр
  • Торгово-развлекательный центр
  • Нежилой фонд
  • Жилой фонд
  • Старый фонд
  elevator       Наличие лифта. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  refuse       Наличие мусоропровода. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  building-serial       Серия дома. Строка
  concierge       Наличие консьержа. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  security       Наличие охраны в доме. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  garage       Наличие гаража. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  parking       Наличие парковки. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  hatched-area       Охраняемая площадь. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  building-class      

Класс коммерческого строения. Доступные значения:

  • A+
  • A
  • B+
  • B
  • C+
  heating-type      

Тип отопления в доме. Доступные значения:

  • Есть
  • Центральное газовое
  • Центральное угольное
  • Печь
  • Камин
  • Нет отопления
  watercloset-type      

Тип туалета (для загородной недвижимости). Доступные значения:

  • В доме
  • На улице

videos Видео (список элементов video)
video
youtube-id Youtube ID видеоролика 
  newbuilding*       Детальное описание новостройки или жилого комплекса (только для этих типов)
    name*     Название ЖК. Обязательно для "квартир в новостройке".
    date*     Дата гос. приемки дома
    status*     Текущее состояние дома. Строка, описывающая положение дел на объекте. Доступные значения
  • Выдача ключей
  • Идут ремонты
  • Переуступка прав от физического лица
  • Дом сдан
  • Дом строится
   

Только для новостроек

new-building-class

   

Класс строения. Доступные значения:

  • эконом
  • бизнес
  • элита
  • комфорт
   

Только для новостроек

housing-stock*

   
 
Контейнер для записей housing - множество записей
о предложениях доступного жилого фонда
(однушки/двушки) с указанием общих данных по
каждому типу
     

Только для новостроек

housing*

 

Контейнер данных записи жилого фонда

       

Только для новостроек

type*

 
 
 
Тип объекта. Доступные значения:
  • Или число комнат: [1/2/3/4/...]
  • Или "студия"
  • Или "свободная планировка"
       

Только для новостроек

area

Нижняя граница площади для объектов данного
предложений
       

Только для новостроек

area-max

Верхняя граница площади для объектов данного
предложений
       

Только для новостроек

price

Нижняя граница цен для объектов данного
предложения
       

Только для новостроек

price-max

Верхняя граница цен для объектов данного
предложения
       

Только для новостроек

count

Число объектов, доступных в предложении

   

Только для новостроек

layouts

   

Изображения планировок (список элементов image)

     

Только для новостроек

image

 

Ссылка на изображение планировки

   

Только для новостроек

progress-images

   

Ход строительства объекта (список элементов image)

     

Только для новостроек

image

 

Ссылка на изображение хода строительства

   

Только для новостроек

videos

   

Видео новостройки (список элементов video)

     

Только для новостроек

video

   
       

Только для новостроек 

youtube-id

Youtube ID видеоролика 

     

Только для новостроек

...

   
object-info         Описание объекта сделки
  rooms       Описание комнатности
    total     Всего комнат в объекте сделки (*обязательно для квартир для realty.mail.ru и для квартир и комнат проекта Юла)
    operate     Комнат в предложении
    to     Макс. число комнат в предложении (если в предложении участвует несколько объектов)
  apartments      

Это апартаменты. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  balcony       Наличие балкона. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  loggia       Наличие лоджии. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  ceil-height       Высота потолков в метрах. Положительное число с плавающей точкой
  furniture       Наличие мебели. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  refrigerator       Наличие холодильника. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  washing-machine       Наличие стиральной машины. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  internet       Наличие интернета. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  tv       Наличие телевизора (антенна). Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  conditioner       Наличие кондиционера. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  phone       Наличие телефона. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  bathroom-type      

Тип санузла. Доступные значения:

  • Совмещенный
  • Раздельный
  free-planning       Свободная планировка. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  renovation      

Тип ремонта. Доступные значения:

  • Евро
  • Евроремонт
  • Косметический
  • Дизайнерский
  • Без ремонта
  common-state      

Общее состояние. Доступные значения:

  • Отличное
  • Хорошее
  • Удовлетворительное
  flat-type      

Тип квартиры. Доступные значения:

  • Квартира
  • Студия
  • Пентхаус
  • Линктхаус 
 

Только для новостроек

low-floor-building

     
 
Малоэтажная застройка. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

developer-decoration-info

     

Детальная информация об отделке. Строка

 

Только для новостроек

parking-type

     

Тип парковки. Доступные значения:

  • наземная
  • подземная
  • стихийная
 

Только для новостроек

children-ground

     

Наличие детской площадки. Доступные значения:

  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

sports-ground

     
 
Наличие спортивной площадки. Доступные
значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

freight-elevator

     
 
Наличие грузового лифта. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
 

Только для новостроек

conditioning-type

     
 
Тип кондиционирования. Доступные значения:
  • индивидуальное
  • центральное
plot-info         Информация об участке
  electricity       Подведено электричество. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  sewage       Подведен водоотвод. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  water-supply       Подведено водоснабжение. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  gas       Подведен газ. Доступные значения:
  • 1 или 0
  • да или нет
  • yes или no
  • true или false
  • + или -
  plot-status*      

Статус участка. Доступные значения:

  • ИЖС
  • Садоводство

   

Только для новостроек

videos

   

Видео новостройки (список элементов video)

Описание XML-формата системы
Описание XML-формата системы для новостройки
Описание XML-формата системы для квартиры в новостройке
Обновлено 23 декабря 2021 г.