XML файл для импорта событий

Материал из Map.BY
(Различия между версиями)
Перейти к: навигация, поиск
(Новая страница: «zzz»)
 
Строка 1: Строка 1:
zzz
+
Для импорта компании, юридического лица или объектов сетей Вы можите воспользоваться функцией XML импорта данных на сайт map.by. Для этого Вам необходимо подготовить и разместить у себя на хостинге файл XML в соответствии со спецификацией с описанием данных о импортируемой организации, и внести его в нашу систему "Актуализатор".
 +
 
 +
== Спецификация XML файла ==
 +
{| class="wikitable"
 +
|-
 +
! Узел!! Описание !! Аттрибуты
 +
|-
 +
| companies || Родительский узел для описания компаний ||
 +
*''version'' - указывает версию используемого протокола. На данный момент актуальная версия 1.0
 +
|-
 +
|company|| информация о компании, юридическом лице, сети ||
 +
*''type'' - информация о типе компании. Возможны следующие варианты:
 +
**'''object''' - объект на карте, например "Ресторан Павлинка"
 +
**'''entity''' - юридическое лицо, например "ООО Рестораны Павлинка"
 +
**'''network''' - сеть, наприме "ООО Сеть ресторанов Павлинка". Сеть может иметь в себе несколько адресов объектов.
 +
*''lang''- Язык предоставленной информации о компании, юр лице, сети. Возможны варианты:
 +
** '''RU''' - Русский
 +
** '''EN''' - Английский
 +
|-
 +
|item|| начало описание единицы компании, юридического лица, сети ||
 +
*''id'' - уникальный идентификатор компании в Вашем каталоге. Служит для однозначной идентификации компании. Рекомендуем использовать целые числа, Например '''100'''
 +
|-
 +
|name||Название организации, юридического лица, сети. Например '''ООО "Васильки INC"'''
 +
|-
 +
!address!!Блок адресов компании. При типе компании '''network''' данный блок может повторяться неограниченное количество раз с описанием адресов различных точек сети
 +
|-
 +
|city||Город. Должен быть указан в соответствии с данным о городах сайта map.by. Список всех городов можно получить посредством [[Определение географических координат населенных пунктов]]
 +
|-
 +
|street||Название улицы. Должно быть указано в соответствии с данными о улицах городов сайта map.by. Список всех улиц можно получить посредством [[Определение географических координат улиц]]
 +
|-
 +
|building||Номер строения. Если номер строения имеет корпус, то его необходимо так же указать в этом узле, например ''168к3'' означает строение номер 168 корпус 3
 +
|-
 +
|room||Номер комнаты (офиса). Если таковой отсутствует, или их нескольно - рекомендуется оставлять данный узел пустым
 +
|-
 +
!coordinates!!Блок географических координат
 +
|-
 +
|lat||Географическая широта. Должна быть представлена в виде дробного числа с разделителем целой части - знаком точка (.) например 55.123144
 +
|-
 +
|lon||Географическая долгота. Должна быть представлена в виде дробного числа с разделителем целой части - знаком точка (.) например 25.324224
 +
|-
 +
!categories!!Блок описания разделов каталога, к которому может быть отнесена компания, юридическое лицо, сеть
 +
|-
 +
|category||Текстовое наименование раздела, к которому может быть отнесена компания. Каждая категоря должна быть перечислина отдельным узлом. Допускается до 3 разелов каталога для одной компании, организации,  сети. Например: ''Аптеки''
 +
|-
 +
!phones!!Блок описания телефонов
 +
|-
 +
|phone||Блок описания номера телефона
 +
|-
 +
|num||Номер телефона в международном формате. Допускаются только цифры, Например: ''375171234567''
 +
|-
 +
|description||Описание номера телефона, например ''Городской'' или ''Отдел продаж'' или ''Velcom''
 +
|-
 +
| fax ||Номер факса в международном формате. Допускаются только цифры, Например: ''375171234567''
 +
|-
 +
| url ||Адрес сайта в интернете. Рекомендуеся использовать префикс ''http://'' например ''http://www.map.by''
 +
|-
 +
| email ||Адрес контактной электронной почты организации, юридического лица, сети, например: ''sales@map.by''
 +
|-
 +
!webpages!!Список Web страниц организации, юридического лица или сети
 +
|-
 +
|page||Начало блока описания сети Web страниц организации
 +
|-
 +
|url||Адрес страницы организации, юридического лица или сети в интернете. Рекомендуеся использовать префикс ''http://'' Например ''http://vk.com/mapby''
 +
|-
 +
|description||Описание страницы. Например ''Наше сообщество ВКонтакте''
 +
|-
 +
|logo||URL адрес логотипа организации, юридического лица или сети. Допустимые форматы: GIF, JPEG, PNG. Рекомендуется указывать полный адрес к логотипу, например http://www.map.by/images/logo.png
 +
|-
 +
|short_description||Краткое описание деятельности компании. Разрешено использовать HTML разметку. Ограничение - 255 символов. Разрешенные теги: <soucrce lang="html4strict"><br/></source>
 +
Внимание! Данные для полного текста должны быть заключены в контейнер CDATA
 +
|-
 +
|description||Полное описание деятельности. Разрешено использовать HTML разметку. Разрещенные теги: <soucrce lang="html4strict"><br/></source>
 +
Внимание! Данные для полного текста должны быть заключены в контейнер CDATA
 +
|-
 +
!tags!!Блок описание тегов компании
 +
|-
 +
|tag||Тег (слово, словосочетание) которое может кратко характериховать компанию. Каждая тег должн быть перечислин отдельным узлом. Допускается до 5 тегов для одной компании, организации,  сети. Например: ''Лекарства''
 +
|-
 +
!attributes!!Блок описание аттрибутов компании
 +
|-
 +
|working_hours||Блок, описывающий время работы компании.
 +
|-
 +
|day||Описание дня|| Аттрибуты:
 +
* nameofday - номер дня недели. ПН считается 1, ВТ - 2 и т.д.
 +
* starting - время начала работы. Время в формате 24H, ЧЧ:MM:CC
 +
* finish - время окончания работы. Время в формате 24H, ЧЧ:MM:CC
 +
|-
 +
|interrupt||Описание перерывов в работе ||Аттрибуты:
 +
* starting - время начала перерыва. Время в формате 24H, ЧЧ:MM:CC
 +
* finish - время окончания перерыва. Время в формате 24H, ЧЧ:MM:CC
 +
|}
 +
 
 +
== Валидация XML файла ==
 +
Для Валидации подготовленных Вами данных вы можите использовать готовую схему валидации данных, расположенную по адресу: http://www.map.by/repo/sample.xsd.
 +
Обращаем ваше внимание что Валидация не является гарантом логической правильности введенных данных. Валидация означает что данные составлены в соответствии со XML спецификацией и не содержит синтаксических ошибок.
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
== Пример файла ==
 +
 
 +
<source lang="xml">
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<companies version="1.0">
 +
<company type="object" lang="RU">
 +
<!-- object|entity|network -->
 +
<item id="0001">
 +
<name>{NAME}</name>
 +
<address>
 +
<city>{CITY}</city>
 +
<street>{STREET}</street>
 +
<building>{BUILDING}</building>
 +
<room>{ROOM}</room>
 +
<coordinates>
 +
<lat>53.1122</lat>
 +
<lon>27.11111</lon>
 +
</coordinates>
 +
</address>
 +
<categories>
 +
<category>{CATEGORY1}</category>
 +
<category>{CATEGORY2}</category>
 +
<category>{CATEGORY3}</category>
 +
</categories>
 +
<phones>
 +
<phone>
 +
<num>{NUM}</num>
 +
<description>{DESCRIPTION}</description>
 +
</phone>
 +
<phone>
 +
<num>{NUM2}</num>
 +
<description>{DESCRIPTION2}</description>
 +
</phone>
 +
<fax>
 +
<num>{NUM}</num>
 +
</fax>
 +
</phones>
 +
<url>{URL}</url>
 +
<email>{EMAIL}</email>
 +
<webpages>
 +
<page>
 +
<url>{URL}</url>
 +
<description>{DESCRIPTION}</description>
 +
</page>
 +
<page>
 +
<url>{URL2}</url>
 +
<description>{DESCRIPTION2}</description>
 +
</page>
 +
</webpages>
 +
<logo>{LOGO_URL}</logo>
 +
<short_description><![CDATA[ {SHORT_DESCRIPTION} ]]></short_description>
 +
<description><![CDATA[ {DESCRIPTION} ]]></description>
 +
<tags>
 +
<tag>{TAG1}</tag>
 +
<tag>{TAG2}</tag>
 +
</tags>
 +
<attributes>
 +
<working_hours>
 +
<day nameofday="1" starting="09:30:00" finish="18:00:00">
 +
<interrupt starting="14:00:00" finish="15:00:00"/>
 +
</day>
 +
<day nameofday="2" starting="09:30:00" finish="18:00:00">
 +
<interrupt starting="14:00:00" finish="15:00:00"/>
 +
</day>
 +
<day nameofday="6" starting="09:30:00" finish="14:00:00"/>
 +
</working_hours>
 +
</attributes>
 +
</item>
 +
</company>
 +
</companies>
 +
</source>

Версия 10:45, 15 октября 2012

Для импорта компании, юридического лица или объектов сетей Вы можите воспользоваться функцией XML импорта данных на сайт map.by. Для этого Вам необходимо подготовить и разместить у себя на хостинге файл XML в соответствии со спецификацией с описанием данных о импортируемой организации, и внести его в нашу систему "Актуализатор".

Спецификация XML файла

Узел Описание Аттрибуты
companies Родительский узел для описания компаний
  • version - указывает версию используемого протокола. На данный момент актуальная версия 1.0
company информация о компании, юридическом лице, сети
  • type - информация о типе компании. Возможны следующие варианты:
    • object - объект на карте, например "Ресторан Павлинка"
    • entity - юридическое лицо, например "ООО Рестораны Павлинка"
    • network - сеть, наприме "ООО Сеть ресторанов Павлинка". Сеть может иметь в себе несколько адресов объектов.
  • lang- Язык предоставленной информации о компании, юр лице, сети. Возможны варианты:
    • RU - Русский
    • EN - Английский
item начало описание единицы компании, юридического лица, сети
  • id - уникальный идентификатор компании в Вашем каталоге. Служит для однозначной идентификации компании. Рекомендуем использовать целые числа, Например 100
name Название организации, юридического лица, сети. Например ООО "Васильки INC"
address Блок адресов компании. При типе компании network данный блок может повторяться неограниченное количество раз с описанием адресов различных точек сети
city Город. Должен быть указан в соответствии с данным о городах сайта map.by. Список всех городов можно получить посредством Определение географических координат населенных пунктов
street Название улицы. Должно быть указано в соответствии с данными о улицах городов сайта map.by. Список всех улиц можно получить посредством Определение географических координат улиц
building Номер строения. Если номер строения имеет корпус, то его необходимо так же указать в этом узле, например 168к3 означает строение номер 168 корпус 3
room Номер комнаты (офиса). Если таковой отсутствует, или их нескольно - рекомендуется оставлять данный узел пустым
coordinates Блок географических координат
lat Географическая широта. Должна быть представлена в виде дробного числа с разделителем целой части - знаком точка (.) например 55.123144
lon Географическая долгота. Должна быть представлена в виде дробного числа с разделителем целой части - знаком точка (.) например 25.324224
categories Блок описания разделов каталога, к которому может быть отнесена компания, юридическое лицо, сеть
category Текстовое наименование раздела, к которому может быть отнесена компания. Каждая категоря должна быть перечислина отдельным узлом. Допускается до 3 разелов каталога для одной компании, организации, сети. Например: Аптеки
phones Блок описания телефонов
phone Блок описания номера телефона
num Номер телефона в международном формате. Допускаются только цифры, Например: 375171234567
description Описание номера телефона, например Городской или Отдел продаж или Velcom
fax Номер факса в международном формате. Допускаются только цифры, Например: 375171234567
url Адрес сайта в интернете. Рекомендуеся использовать префикс http:// например http://www.map.by
email Адрес контактной электронной почты организации, юридического лица, сети, например: sales@map.by
webpages Список Web страниц организации, юридического лица или сети
page Начало блока описания сети Web страниц организации
url Адрес страницы организации, юридического лица или сети в интернете. Рекомендуеся использовать префикс http:// Например http://vk.com/mapby
description Описание страницы. Например Наше сообщество ВКонтакте
logo URL адрес логотипа организации, юридического лица или сети. Допустимые форматы: GIF, JPEG, PNG. Рекомендуется указывать полный адрес к логотипу, например http://www.map.by/images/logo.png
short_description Краткое описание деятельности компании. Разрешено использовать HTML разметку. Ограничение - 255 символов. Разрешенные теги: <soucrce lang="html4strict">
</source>

Внимание! Данные для полного текста должны быть заключены в контейнер CDATA

description Полное описание деятельности. Разрешено использовать HTML разметку. Разрещенные теги: <soucrce lang="html4strict">
</source>

Внимание! Данные для полного текста должны быть заключены в контейнер CDATA

tags Блок описание тегов компании
tag Тег (слово, словосочетание) которое может кратко характериховать компанию. Каждая тег должн быть перечислин отдельным узлом. Допускается до 5 тегов для одной компании, организации, сети. Например: Лекарства
attributes Блок описание аттрибутов компании
working_hours Блок, описывающий время работы компании.
day Описание дня Аттрибуты:
  • nameofday - номер дня недели. ПН считается 1, ВТ - 2 и т.д.
  • starting - время начала работы. Время в формате 24H, ЧЧ:MM:CC
  • finish - время окончания работы. Время в формате 24H, ЧЧ:MM:CC
interrupt Описание перерывов в работе Аттрибуты:
  • starting - время начала перерыва. Время в формате 24H, ЧЧ:MM:CC
  • finish - время окончания перерыва. Время в формате 24H, ЧЧ:MM:CC

Валидация XML файла

Для Валидации подготовленных Вами данных вы можите использовать готовую схему валидации данных, расположенную по адресу: http://www.map.by/repo/sample.xsd. Обращаем ваше внимание что Валидация не является гарантом логической правильности введенных данных. Валидация означает что данные составлены в соответствии со XML спецификацией и не содержит синтаксических ошибок.




Пример файла

<?xml version="1.0" encoding="UTF-8"?>
<companies version="1.0">
	<company type="object" lang="RU">
		<!-- object|entity|network -->
		<item id="0001">
			<name>{NAME}</name>
			<address>
				<city>{CITY}</city>
				<street>{STREET}</street>
				<building>{BUILDING}</building>
				<room>{ROOM}</room>
				<coordinates>
					<lat>53.1122</lat>
					<lon>27.11111</lon>
				</coordinates>
			</address>
			<categories>
				<category>{CATEGORY1}</category>
				<category>{CATEGORY2}</category>
				<category>{CATEGORY3}</category>
			</categories>
			<phones>
				<phone>
					<num>{NUM}</num>
					<description>{DESCRIPTION}</description>
				</phone>
				<phone>
					<num>{NUM2}</num>
					<description>{DESCRIPTION2}</description>
				</phone>
				<fax>
					<num>{NUM}</num>
				</fax>
			</phones>
			<url>{URL}</url>
			<email>{EMAIL}</email>
			<webpages>
				<page>
					<url>{URL}</url>
					<description>{DESCRIPTION}</description>
				</page>
				<page>
					<url>{URL2}</url>
					<description>{DESCRIPTION2}</description>
				</page>
			</webpages>
			<logo>{LOGO_URL}</logo>
			<short_description><![CDATA[ {SHORT_DESCRIPTION} ]]></short_description>
			<description><![CDATA[ {DESCRIPTION} ]]></description>
			<tags>
				<tag>{TAG1}</tag>
				<tag>{TAG2}</tag>
			</tags>
			<attributes>
				<working_hours>
					<day nameofday="1" starting="09:30:00" finish="18:00:00">
						<interrupt starting="14:00:00" finish="15:00:00"/>
					</day>
					<day nameofday="2" starting="09:30:00" finish="18:00:00">
						<interrupt starting="14:00:00" finish="15:00:00"/>
					</day>
					<day nameofday="6" starting="09:30:00" finish="14:00:00"/>
				</working_hours>
			</attributes>
		</item>
	</company>
</companies>
Личные инструменты
Пространства имён

Варианты
Действия
Навигация
Инструменты