Формат передачи данных в службу поддержки

Версия формата	1.1

Содержание

Общая информация
Структура сообщения
Ссылки на объекты
Абоненты
- Взаимоотношения абонентов
- Пользователи абонентов
Пользователи сервиса
Приложения
- Пользователи приложений
- Свойства объекта
Тарифы
Подписки на тарифы
Контактная информация
Дополнительные реквизиты
Перечисления
Абстрактные классы
Удаление объектов

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

Назначение

Предназначен для получения информации о пользователях сервисов, их правах, тарифах и т.д. из программы Менеджер сервиса для облачных сервисов Фреш или управляющих программ других сервисов в программу 1С:Управление службой поддержки. Формат может использоваться для получения информации из любых информационных систем, так как он не зависит от особенностей собственного программного обеспечения или структур информационных баз, которые участвуют в обмене.

Формат сообщения

Объекты, предназначенные к обмену, упакованы в сообщение - структуру в формате XML. Корневой элемент сообщения называется Message и содержит два дочерних элемента:

Header - описывает заголовок сообщения (описан в схеме ExchangeMessage.xsd).
Body - является коллекцией элементов-наследников Object , т.е. содержит все объекты, которые нужно синхронизировать.

Объект может содержать в себе ссылки на другие объекты (например, документ Подписка на тариф может содержать в себе одну или несколько ссылок на тарифы). В этом случае, если мы импортируем данные в информационную базу, все объекты, на которые мы ссылаемся из родительского объекта, должны либо уже существовать в системе, либо их описание должно содержаться в том же XML файле.
Если нам необходимо удалить какой-то объект, в коллекцию Body надо добавить элемент типа УдалениеОбъекта , и в этом элементе сослаться на удаляемый объект.
С помощью формата доступны операции создания, обновления и удаления объектов. Для корректной загрузки данных в приложение все объекты должны содержать заполненный элемент Ссылка из элемента КлючевыеСвойства (GUID в форме строки). Это первичный ключ объекта. Приложение ведет себя следующим образом:

Если в системе нет объекта с ключом из поля Ссылка - создается новый объект.
Если в системе уже есть объект с ключом из поля Ссылка - существующий объект обновляется новыми данными, пришедшими в XML.
Если пришел элемент типа УдалениеОбъекта - объект с соответствующим ключом удаляется из системы.

Пример сообщения

<Message xmlns:msg="http://www.1c.ru/SSL/Exchange/Message" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <msg:Header>
        <msg:Format>http://www.1cfresh.com/sd/data</msg:Format>
        <msg:CreationDate>2015-12-15T13:06:23</msg:CreationDate>
        <msg:AvailableVersion>1.0</msg:AvailableVersion>
    </msg:Header>
    <Body xmlns="http://www.1cfresh.com/sd/data/1.1">                
        <Справочник.Конфигурации>
            <КлючевыеСвойства>
                <Ссылка>15ee9feb-696e-11e4-a6fc-5404a67fc69d</Ссылка>
                <Имя>БухгалтерияПредприятия</Имя>
            </КлючевыеСвойства>                        
            <Наименование>Бухгалтерия предприятия</Наименование>
            <Код>ea</Код>
        </Справочник.Конфигурации>
        <УдалениеОбъекта>
            <СсылкаНаОбъект>
                <СсылкаНаОбъект>
                    <КонфигурацияСсылка>15ee9feb-696e-11e4-a6fc-5404a67fc69d</КонфигурацияСсылка>
                </СсылкаНаОбъект>                        
            </СсылкаНаОбъект>
        </УдалениеОбъекта>
    </Body>
</Message>

В секции <Header> - ссылка на формат сообщения, дата создания сообщения и версия формата.
В секции <Body> - описание новой конфигурации (тип Справочник.Конфигурации ) с наименованием БухгалтерияПредприятия и описание удаления объекта по ключу. Ключ в объекте <УдалениеОбъекта> – тот же, что и у нового объекта конфигурации. В результате обработки этого сообщения приложение создаст новый элемент справочника Конфигурации и тут же удалит его.

Структура сообщения

Класс Header

Описывает заголовок сообщения обмена.

Свойство	Тип	Обязательное	Описание
AvailableVersion	string	Да	Поддерживаемые версии обмена
Confirmation	Confirmation		Подтверждение
CreationDate	dateTime	Да	Дата создания
Format	string	Да	Формат обмена

Свойство	Тип	Описание
ExchangePlan	string	План обмена
From	string	Конфигурация - источник
MessageNo	integer	Номер сообщения
ReceivedNo	integer	Номер полученного сообщения
To	string	Конфигурация - приемник

Свойство	Тип	Обязательное
ДополнительныеРеквизиты	ДополнительныеРеквизиты
КлючевыеСвойства	КлючевыеСвойстваАбоненты	Да
КонтактнаяИнформация	КонтактнаяИнформация

Свойство	Тип
Код	int
Наименование	string (64)
Ссылка	СправочникСсылка.Абоненты

Свойство	Тип
АбонентОтбор	КлючевыеСвойстваАбоненты
ВедущийАбонентОтбор	КлючевыеСвойстваАбоненты
ВидВзаимоотношенийОтбор	ВидыВзаимоотношений
Записи	Справочник.ВзаимоотношенияАбонентов.Записи
ПериодОтбор	dateTime

Свойство	Тип
Абонент	КлючевыеСвойстваАбоненты
ВедущийАбонент	КлючевыеСвойстваАбоненты
ВидВзаимоотношений	ВидыВзаимоотношений
Период	dateTime

Свойство	Тип
Абонент	КлючевыеСвойстваАбоненты
Пользователь	КлючевыеСвойстваПользователи

Свойство	Тип
Логин	string (150)
Наименование	string (150)
Ссылка	СправочникСсылка.Пользователи

Свойство	Тип
Абонент	КлючевыеСвойстваАбоненты
ИнформационнаяБаза	КлючевыеСвойстваИнформационныеБазы
КлючевыеСвойства	КлючевыеСвойстваПриложения
Код	int

Свойство	Тип
Наименование	string (100)
Ссылка	СправочникСсылка.Приложения

Свойство	Тип
Записи	Справочник.ПользователиПриложений.Записи
ПользовательОтбор	КлючевыеСвойстваПользователи
ПравоОтбор	ПраваПользователейПриложений
ПриложениеОтбор	КлючевыеСвойстваПриложения

Свойство	Тип	Обязательное
ДатаНачалаДействия	dateTime
ДатаОкончанияДействия	dateTime
ДоступныеТарифы	Справочник.Тарифы.ДоступныеТарифы
КлючевыеСвойства	КлючевыеСвойстваТарифы	Да
Конфигурации	Справочник.Тарифы.Конфигурации
Ограничения	Справочник.Тарифы.Ограничения
ОписаниеДляАбонентов	любой тип
ОписаниеДляОбслуживающихОрганизаций	string
ПериодДействияПродлевающейПодписки	decimal
ПериодДействияРасширяющейПодписки	decimal
ПериодДобавленияПродлевающейПодписки	decimal
РасширениеТарифа	boolean

Свойство	Тип
ВидОграничений	КлючевыеСвойстваВидыОграниченийТарифов
КоличествоДопЛицензийРасширяющейПодписки	decimal
КоличествоЛицензий	decimal

Свойство	Тип
Пользователь	КлючевыеСвойстваПользователи
Право	ПраваПользователейПриложений
Приложение	КлючевыеСвойстваПриложения
Разрешено	boolean

Свойство	Тип	Обязательное
КлючевыеСвойства	КлючевыеСвойстваКонфигурации	Да
Код	string (9)
Наименование	string (64)

Свойство	Тип
Имя	string (255)
Ссылка	СправочникСсылка.Конфигурации

Свойство	Тип	Обязательное
ВерсияКонфигурации	КлючевыеСвойстваВерсииКонфигураций
КлючевыеСвойства	КлючевыеСвойстваИнформационныеБазы	Да
Код	int

Свойство	Тип
Конфигурация	КлючевыеСвойстваКонфигурации
Наименование	string (18)
Ссылка	СправочникСсылка.ВерсииКонфигураций

Свойство	Тип
Дата	dateTime
Номер	ТипНомерДокумента
Ссылка	ДокументСсылка.Подписки

Свойство	Тип	Обязательное
ВидКонтактнойИнформации	ВидыКИ	Да
ЗначенияПолей	string	Да
НаименованиеКонтактнойИнформации	string

Свойство	Тип	Обязательное
ВладелецДополнительныхЗначений	КлючевыеСвойстваДополнительныеРеквизиты
ДополнительныеЗначенияИспользуются	boolean
ДополнительныеЗначенияСВесом	boolean
Заголовок	string
ЗаголовокФормыВыбораЗначения	string
ЗаголовокФормыЗначения	string
ЗаполнятьОбязательно	boolean
КлючевыеСвойства	КлючевыеСвойстваДополнительныеРеквизиты	Да
Комментарий	string
МногострочноеПолеВвода	decimal
Подсказка	string
ФорматСвойства	string

Свойство	Тип	Обязательное
Вес	decimal
КлючевыеСвойства	КлючевыеСвойстваЗначенияДополнительныхРеквизитов	Да

Свойство	Тип
Владелец	КлючевыеСвойстваДополнительныеРеквизиты
Наименование	string
Ссылка	СправочникСсылка.ЗначенияДополнительныхРеквизитов

Формат передачи данных в службу поддержки

Содержание

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

Назначение

Формат сообщения

Пример сообщения

Структура сообщения

Класс Header

Класс Object

Класс Confirmation

Класс Ref

Ссылки на объекты

Класс ЛюбаяСсылка

Абоненты

Класс СправочникСсылка.Абоненты

Класс Справочник.Абоненты

Класс КлючевыеСвойстваАбоненты

Взаимоотношения абонентов

Класс Справочник.ВзаимоотношенияАбонентов

Класс Справочник.ВзаимоотношенияАбонентов.Записи

Класс Справочник.ВзаимоотношенияАбонентов.Записи.Строка

Пользователи абонентов

Класс Справочник.ПользователиАбонентов

Класс Справочник.ПользователиАбонентов.Записи

Класс Справочник.ПользователиАбонентов.Записи.Строка

Пользователи сервиса

Класс СправочникСсылка.Пользователи

Класс Справочник.Пользователи

Класс КлючевыеСвойстваПользователи

Приложения

Класс СправочникСсылка.Приложения

Класс Справочник.Приложения

Класс КлючевыеСвойстваПриложения

Пользователи приложений

Класс Справочник.ПользователиПриложений

Класс Справочник.ПользователиПриложений.Записи

Класс Справочник.ПользователиПриложений.Записи.Строка

Свойства объекта

Конфигурации

Класс СправочникСсылка.Конфигурации

Класс Справочник.Конфигурации

Класс КлючевыеСвойстваКонфигурации

Информационные базы

Класс СправочникСсылка.ИнформационныеБазы

Класс Справочник.ИнформационныеБазы

Класс КлючевыеСвойстваИнформационныеБазы

Версии конфигураций

Класс СправочникСсылка.ВерсииКонфигураций

Класс Справочник.ВерсииКонфигураций

Класс КлючевыеСвойстваВерсииКонфигураций

Тарифы

Класс СправочникСсылка.Тарифы

Класс Справочник.Тарифы

Класс КлючевыеСвойстваТарифы

Доступные тарифы

Класс Справочник.Тарифы.ДоступныеТарифы

Класс Справочник.Тарифы.ДоступныеТарифы.Строка

Конфигурации

Класс Справочник.Тарифы.Конфигурации

Класс Справочник.Тарифы.Конфигурации.Строка

Ограничения

Класс Справочник.Тарифы.Ограничения

Класс Справочник.Тарифы.Ограничения.Строка

Свойства объекта

Виды ограничений тарифов

Класс СправочникСсылка.ВидыОграниченийТарифов

Класс Справочник.ВидыОграниченийТарифов

Класс КлючевыеСвойстваВидыОграниченийТарифов

Подписки на тарифы

Класс ДокументСсылка.Подписки

Класс Документ.Подписка

Класс КлючевыеСвойстваПодписка

Контактная информация

Класс КонтактнаяИнформация

Класс КонтактнаяИнформация.Строка

Дополнительные реквизиты

Определение

Класс СправочникСсылка.ДополнительныеРеквизиты

Класс Справочник.ДополнительныеРеквизиты

Класс КлючевыеСвойстваДополнительныеРеквизиты

Свойство	Тип	Обязательное
Булево	boolean
Дата	date
ЗначениеДополнительногоРеквизитаСсылка	КлючевыеСвойстваЗначенияДополнительныхРеквизитов
ЗначениеСвойства	любой тип
ПользовательСсылка	КлючевыеСвойстваПользователи
Свойство	КлючевыеСвойстваДополнительныеРеквизиты	Да
Строка	string
Число	decimal