Описание файла справочника
Файл справочника представляет собой документ XML. Он предназначен для описания таких полей объектов недвижимости из файла дампа, которые могут принимать значения только из заранее оговоренного списка. Файл справочника состоит из последовательных описаний отдельных полей, следующих строго в приведённом ниже порядке.
Описание поля представляет собой контейнер (XML-тег), содержащий описания справочных значений. Его название состоит из названия поля плюс латинская буква «s».
Описание одного справочного значения — XML-тег, название которого совпадает с названием поля. У него имеется как минимум один атрибут — ID, целочисленный идентификатор, уникальный внутри контейнера поля. Содержимое тега (element content) и представляет собой справочное значение. Для тега с описанием справочного значения допускается присутствие других атрибутов, кроме ID, но не допускаются вложенные теги (кроме контейнера <Firms>, см. ниже).
В файле дампа поля объектов недвижимости в качестве своего значения содержат идентификаторы текстовых значений из справочника.
Пример. Пусть справочник содержит следующее описание станции метро:
<MetroStation ID="20034" MetroLine="10002">Алексеевская</MetroStation>
Тогда в файле дампа указание на то, что объект привязан к станции метро Алексеевская, даётся в таком виде:
<MetroStation>20034</MetroStation>
Содержание файла справочника
В файле справочника обязаны присутствовать следующие контейнеры:
- компании-рекламодатели: Firms; типы объектов недвижимости: ObjectTypes; контейнеры для полей, описывающих местоположение: Countrys, Oblasts, Regions, Settlements, Districts, Areas.
Кроме того, в случае использования соответствующих полей в файле дампа, являются обязательными контейнеры:
- названия станций метро: MetroStations; другие справочные значения.
Требования к файлу справочника
Файл должен соблюдать стандарт XML (http://www. w3.org/TR/REC-xml)
Он должен быть сохранён в кодировке windows-1251.
Каждый контейнер должен быть представлен в файле справочника максимум один раз.
Вложенность и порядок тегов должны строго следовать приведённому ниже описанию.
Идентификаторы справочных значений должны быть целыми числами. Идентификатор каждого значения должен быть уникальным внутри своего контейнера.
Идентификаторы словарных значений не должны меняться в течение всего времени размещения информации.
Файл справочника не должен содержать HTML-тегов.
Пример файла справочника
Формат файла справочника
<?xml version="1.0" encoding="windows-1251"?>
Стандартный XML-заголовок должен находиться на первой строке и начинаться с первого же символа в ней.
<Dictionary Date="[дата и время]" IntegrID="[ID интегратора]"></Dictionary>
Единственный контейнер, содержащий весь справочник.
Date — дата и время формирования последней версии справочника в формате YYYY-MM-dd HH:mm.
IntegrID — числовое поле, полученный интегратором идентификатор. Здесь и далее «числовое поле» означает, что поле может принимать только целочисленные значения, если не оговорено обратное.
пример:
<Dictionary Date=" 14:03" IntegrID="057"></Dictionary>
<Firm ID="[ID компании-рекламодателя]"></Firm>
Контейнер, содержащий описание отдельной компании.
ID — числовое поле, уникальный идентификатор компании для использования в файле дампа.
<FirmDescription></FirmDescription>
Обязательное текстовое поле, название компании, предпочтительно — на русском языке.
<FirmUrl></FirmUrl>
Текстовое поле, ссылка на сайт компании.
<ObjectType ID="[ID типа объекта]"></ObjectType>
Текстовое поле, перечисляющее через точку с запятой подтипы недвижимости (см. ниже).
ID — числовое поле, уникальный идентификатор типа недвижимости для использования в файле дампа.
Подтип недвижимости — текстовое значение из следующего фиксированного справочника:
· Аренда недвижимости
· Продажа недвижимости
· Городская недвижимость
· Зарубежная недвижимость
· Квартиры
· Новостройки
· Пентхаус
Внутри каждого типа недвижимости должно быть указано:
· ровно одно: либо Аренда недвижимости, либо Продажа недвижимости;
· ровно одно: Городская недвижимость.
Пример указания типов недвижимости:
<ObjectTypes>
<ObjectType ID="111">
Аренда недвижимости;Городская недвижимость;Квартиры
</ObjectType>
</ObjectTypes>
Здесь тип с идентификатором 111 соответствует аренде квартир в городе.
Примечание. Обратите внимание, что правило о составлении названия контейнера из названия поля плюс «s» строго соблюдается даже в том случае, если это противоречит английской грамматике.
<Country ID="[ID страны]"></Country>
Текстовое поле, название страны.
ID — числовое поле, уникальный идентификатор страны.
<Oblast ID="[ID области]" Country="[ID страны]"></Oblast>
Текстовое поле, название области.
ID — числовое поле, уникальный идентификатор области.
Country — числовое поле, идентификатор страны, к которой принадлежит область.
<Region ID="[ID района]" Oblast="[ID область]"></Region>
Текстовое поле, название района.
ID — числовое поле, уникальный идентификатор района.
Oblast — числовое поле, идентификатор области, к которой относится район.
Допустимо также указание дополнительного атрибута Country, содержащего идентификатор страны, в которой расположен район.
<Settlement ID="[ID города]" Region="[ID района]"></Settlement>
Текстовое поле, название города или другого населённого пункта.
ID — числовое поле, уникальный идентификатор города.
Region — числовое поле, идентификатор района, в котором находится город.
Допустимо также указание дополнительных атрибутов Country и Oblast, содержащих идентификаторы соответственно страны и области, в которых расположен город.
<District ID="[ID округа]" Settlement="[ID города]"></District>
Текстовое поле, название административного округа.
ID — числовое поле, уникальный идентификатор округа.
Settlement — числовое поле, идентификатор города, административной единицей которого является описываемый округ.
Допустимо также указание дополнительных атрибутов Country, Oblast и Region, содержащих идентификаторы соответственно страны, области и района, в которых расположен город.
<MetroStation ID="[ID станции метро]" MetroLine="[ID ветки метро]"></MetroStation>
Текстовое поле, название станции метро.
ID — числовое поле, уникальный идентификатор станции метро.
MetroLine — числовое поле, идентификатор ветки метро из приведённого справочника.
Допустимо также присутствие дополнительных атрибутов, указывающих на географическое положение станции.
Описание файла дампа
Файл дампа представляет собой документ XML. Он содержит описание объектов недвижимости, предназначенных интегратором для размещения на сайте портала ОРСН. Описание каждого объекта заключается в отдельный контейнер.
Требования к файлу дампа
- Документ должен соблюдать стандарт XML (http://www. w3.org/TR/REC-xml). Он должен быть сохранён в кодировке windows-1251. Вложенность и порядок тегов должны строго следовать приведённому ниже описанию. Типы полей должны быть строго соблюдены. Поля со справочными значениями должны быть описаны в файле справочника. Ссылки на справочник должны вести только на существующие значения. В случае отсутствия информации — соответствующие теги пропускаются. Использовать пустые теги запрещается. Идентификаторы объектов должны быть целыми числами. Идентификатор одного и того же объекта должен быть постоянен в течение его размещения на портале ОРСН. Файл не должен содержать HTML-тегов.
Пример файла дампа
Формат файла дампа
<?xml version=”1.0” encoding=”windows-1251”?>
Стандартный XML-заголовок должен находится на первой строке и начинаться с первого же символа в ней.
<Damp Date=”[дата и время]” IntegrID=”[ID интегратора]”></Damp>
Единственный контейнер для всего дампа.
Date — дата и время формирования последней версии дампа в формате YYYY-MM-dd HH:mm.
IntegrID — числовое поле, идентификатор интегратора.
пример:
<Damp Date=” 15:08” IntegrID=”057”></Damp>
<Currency ID=”[ID валюты]” Rate=”[курс]”></Currency>
Повторяющийся пустой тег, атрибуты которого описывают коэффициент перевода цены.
ID — текстовое поле, уникальный идентификатор валюты.
Rate — числовое поле, может принимать дробные значения, десятичная часть отделяется от целой при помощи ТОЧКИ, а не запятой.
Пример для дампа, в котором цены указаны в рублях:
<Currencys>
<Currency ID=”RUR” Rate=”1” />
<Currency ID=”USD” Rate=”24.45” />
<Currency ID=”EUR” Rate=”35.93” />
</Currencys>
<Object ID=”[ID объекта]” ObjectType=”[ID типа объекта]” Firm=”[ID компании-рекламодателя]”></Object>
Повторяющийся контейнер, содержащий всю информацию по одному объекту. Внутри контейнера <Object> все теги, кроме специально оговоренных, встречаются максимум один раз.
ID — обязательное числовое поле, уникальный идентификатор объекта. Для одного и того же объекта должен быть постоянным в течение всего размещения на портале ОРСН.
ObjectType — обязательное числовое поле, ссылка на справочник <ObjectTypes>, тип недвижимости.
Firm — обязательное числовое поле, ссылка на справочник <Firms>, компания, предоставившая информа-цию об объекте.
<Description></Description>
Контейнер, содержащий поля описания объекта недвижимости.
<FullTitle></FullTitle>
Обязательное текстовое поле, от 5 до 70 символов (здесь и далее: с пробелами и знаками препинания), полный заголовок объекта. Требования к содержанию заголовка зависят от раздела размещения объекта и изложены в «Требованиях к размещаемой информации»,
Примеры заголовков:
В разделе «Вторичный рынок»: 3 комн. кв-ра, м. Войковская, 5 мин.
В разделе «Аренда элитных квартир»: м. Новослободская, Новосущевская улица, дом 12.
<FullDescription></FullDescription>
Обязательное текстовое поле, от 5 до 260 символов, полное текстовое описание объекта. Смотри также «Требования к », стр. 11.
Примеры описаний.
В разделе «Вторичный рынок»:
Судостроительная ул.,49 , 2/9 эт., общ. пл. 57 м², жил. пл. 57 м², кух. пл. 5 м², хор. ремонт, стеклопакеты, тихий зеленый район, новая электрика, сантехника, выделенный интернет.
В разделе «Аренда элитных квартир»:
5-комнатная квартира, 4/5-эт. дома, общ. пл. 260 кв. м. Евроремонт в стиле «классика» выполнен по авторскому дизайн-проекту. Установлены системы «Умный дом» и климат-контроль. 3 машино-места в подземном паркинге.
<RoomsCount></RoomsCount>
Текстовое поле, количество предлагаемых комнат. Допустимые значения описываются следующей схемой.
Для квартир:
Целое число, количество комнат.
Для комнат:
‘К’ (буква кириллицы, сокр. от «Комната») — одна комната.
‘К2’ — одна комната в двухкомнатной квартире.
‘2К3’ — две комнаты в трёхкомнатной квартире.
и так далее: ‘nКm’ — n комнат в m-комнатной квартире, где n = 1 не пишется, причём n принадлежит диапазону от 1 до 4, а m не превышает 30.
<PresencePhone></PresencePhone>
Логическое поле (0 или 1), наличие телефонной линии. 0 — отсутствует, 1 — присутствует.
<Balcony></Balcony>
Числовое поле, максимум 7, количество балконов.
<Loggia></Loggia>
Числовое поле, максимум 7, количество лоджий.
<CoveringFloor></CoveringFloor>
Текстовое поле, тип покрытия пола. Значение выбирается из следующего фиксированного справочника.
Справочник ('допустимое значение' — описание; здесь и далее в справочных значениях участвуют только цифры и буквы кириллицы):
· 'Д' — доска.
· 'К' — ковролин.
· 'Ли' — линолеум.
· 'Ла' — ламинат.
· 'П' — паркет.
· 'С' — стяжка.
<TypeBathroom></TypeBathroom>
Текстовое поле, тип санузла. Значения выбираются из следующего фиксированного справочника.
· 'Р' — раздельный.
· 'С' — совмещённый.
· '2' — два санузла.
· 'У' — на улице.
· '0' (цифра) — отсутствует.
<WhereWindows></WhereWindows>
Текстовое поле, куда выходят окна квартиры в доме. Значения выбираются из следующего фиксированного справочника.
· 'Д' — двор.
· 'У' – улица.
· 'О' (буква) – обе стороны.
<HouseType></HouseType>
Текстовое поле, тип дома. Значения выбираются из следующего фиксированного справочника.
· 'Б' — блочный.
· 'К' — кирпичный.
· 'Д' — деревянный.
· 'П' — панельный.
· 'С' — сталинский.
· 'М' — монолит.
<HouseSeria></HouseSeria>
Текстовое поле, максимум 15 символов, серия дома.
<Glass></Glass>
Текстовое поле, максимум 15 символов, остекление.
<PresenceFurnish></PresenceFurnish>
Логическое поле (0 или 1), наличие отделки. 0 — нет, 1 — есть.
<PresencePrivatization></PresencePrivatization>
Логическое поле (0 или 1), наличие приватизации. 0 — нет, 1 — есть.
<TermDelivery></TermDelivery>
Текстовое поле, максимум 40 символов, срок сдачи строящегося объекта.
<Infrastructure></Infrastructure>
Текстовое поле, максимум 300 символов, описание инфраструктуры.
<Floor></Floor>
Числовое поле, максимум 100, этаж, на котором располагается предлагаемая квартира или комната.
<HouseFloors></HouseFloors>
Числовое поле, максимум 100, полная этажность здания.
<Spaces></Spaces>
Контейнер для описания площадей объекта.
<Dimension></Dimension>
Текстовое поле, единица измерения площади. Значение выбирается из следующего фиксированного справочника (кв. м.) .
<TotalSpaceMin></TotalSpaceMin>
Дробное числовое поле, не превышает , общая площадь объекта, или минимальная общая площадь в предлагаемом диапазоне, если объект обладает целым диапазоном площадей. Здесь и далее целая и дробная части разделяются ТОЧКОЙ, а не запятой.
<TotalSpaceMax></TotalSpaceMax>
Дробное числовое поле, не превышает , максимальная общая площадь в предлагаемом диапазоне.
<FloorSpace></FloorSpace>
Дробное числовое поле, максимум 5000, жилая площадь.
<KitchenSpace></KitchenSpace>
Дробное числовое поле, максимум 500, площадь кухни.
<Other></Other>
Текстовое поле, максимум 600 символов. Любая информация, не вошедшая в прочие поля описания.
<Address></Address>
Контейнер, содержащий информацию о местоположении объекта.
<Country></Country>
Числовое поле, ссылка на справочное значение, страна.
<Oblast></Oblast>
Числовое поле, ссылка на справочное значение, область.
<Region></Region>
Числовое поле, ссылка на справочное значение, регион.
<Settlement></Settlement>
Числовое поле, ссылка на справочное значение, город или поселение.
<District></District>
Числовое поле, ссылка на справочное значение, округ города.
<Area></Area>
Числовое поле, ссылка на справочное значение, район города.
<FullAddress></FullAddress>
Текстовое поле, максимум 100 символов, полный адрес объекта (без почтового индекса).
<Crossroads></Crossroads>
Текстовое поле, максимум 40 символов, перекрёсток улиц через косую черту ( / ).
Например:
<Crossroads>Кедрова/Вавилова</Crossroads>
<Street></Street>
Текстовое поле, максимум 40 символов, название улицы вместе с «ул.», «пр-д», «ш.» и т. п.
<NumberHouse></NumberHouse>
Текстовое поле, максимум 20 символов, номер дома, возможно, с дробью и другими пометами.
<NumberCase></NumberCase>
Текстовое поле, максимум 7 символов, номер корпуса, возможно, с буквенным суффиксом.
<NumberStructure></NumberStructure>
Числовое поле, максимум 300, номер строения.
<NumberPossession></NumberPossession>
Числовое поле, максимум 300, номер владения.
<NumberSite></NumberSite>
Числовое поле, максимум 300, номер участка.
<Metro></Metro>
Контейнер, содержащий указание на ближайшую к объекту станцию метро. Обязательно для объектов, расположенных в городах с метрополитеном.
<MetroStation></MetroStation>
Числовое поле, ссылка на справочник, станция метро.
<TimeDoMetro></TimeDoMetro>
Числовое поле, максимум 60, время в минутах, чтобы добраться от объекта до станции метро.
<DoMetroTransp></DoMetroTransp>
Текстовое поле, способ, которым добираться до станции метро. Значение выбирается из следующего фиксированного справочника.
· 'Т' – на общественном транспорте.
· 'П' – пешком.
<DistanceFromCity></DistanceFromCity>
Числовое поле, не больше 1000, расстояние в километрах до города (областного или районного центра).
<Price></Price>
Контейнер, содержащий описание цены объекта. Если цена неизвестна или не указывается, следует пропустить весь контейнер. Если же цена указана, то в контейнере обязано присутствовать поле <TotalPrice> или <PriceDivision> — в зависимости от типа цены.
<TotalPrice></TotalPrice>
Дробное числовое поле, максимум , общая цена.
<PriceDivision></PriceDivision>
Дробное числовое поле, цена за единицу измерения, указанную в следующем поле.
<DivisionDimension></DivisionDimension>
Текстовое поле, единица измерения цены. Значение берётся из следующего фиксированного справочника.
· 'за кв. м.'
· 'в мес.'
В настоящий момент в базе данных портала ОРСН существует следующая привязка единиц измерения к типам недвижимости.
· Аренда недвижимости руб. в мес.
· Продажа недвижимости руб.
· Продажа недвижимости; Новостройка руб. за кв. м.
<Contacts></Contacts>
Контейнер, содержащий контактную информацию.
<Phones></Phones>
Контейнер для номеров телефонов.
<Phone></Phone>
Повторяющееся текстовое поле, максимум 50 символов, номер телефона без префикса. Обязательно при отсутствии ссылки на описание объекта на сайте рекламодателя.
<PhonePrefix></PhonePrefix>
Текстовое поле, максимум 5 символов, общий префикс для номеров телефонов, без скобок. Обязательно, если телефон не московский.
<ContactPerson></ContactPerson>
Текстовое поле, максимум 40 символов, фамилия, имя, отчество контактного лица. Обязательно при указании номера телефона.
<Link></Link>
Текстовое поле, максимум 255 символов, полная ссылка с протоколом на страницу описания объекта на сайте рекламодателя. Обязательно при наличии такой страницы или если не указан номер контактного телефона.
Пример:
<Link>http://*****/cottage. asp? id=556284&mode=full&from=orsn</Link>
<Photos></Photos>
Контейнер для ссылок на фотографии.
<Photo></Photo>
Повторяющееся текстовое поле, максимум 255 символов, полная ссылка на фотографию объекта с указанием протокола. Картинки должны быть сохранены в формате jpg, gif или png и занимать меньше 100КБ.
