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

Содержание

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

Назначение

Предназначен для получения информации о пользователях сервисов, их правах, тарифах и т.д. из программ Менеджер сервиса для сервисов, работающих по технологии 1сFresh, или управляющих программ других сервисов, в программу 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

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

СвойствоТипОбязательноеСписокОписание
AvailableVersionstringДа
Поддерживаемые версии обмена
ConfirmationConfirmation

Подтверждение
CreationDatedateTimeДа
Дата создания
FormatstringДа
Формат обмена

▲ в начало

Класс Object

Абстрактный класс. Объекты этого класса не могут быть созданы.
Описывает объект обмена.

СвойствоТипОписание
AdditionalInfoлюбой типОписывает дополнительную информацию об объекте.

Производные классы:

▲ в начало

Класс Confirmation

Описывает подтверждение получения данных обмена.

СвойствоТипОписание
ExchangePlanstringПлан обмена
FromstringКонфигурация - источник
MessageNointegerНомер сообщения
ReceivedNointegerНомер полученного сообщения
TostringКонфигурация - приемник

▲ в начало

Класс Ref

Описывает ссылку на объект.

Производные классы:

▲ в начало

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

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

СвойствоТипОбязательное
СсылкаНаОбъектлюбой типДа

▲ в начало

Абоненты

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Абоненты

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

▲ в начало

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

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

▲ в начало

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

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

Описывает данные о взаимоотношениях между абонентами.

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

▲ в начало

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

▲ в начало

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

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

▲ в начало

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

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

Описывает данные по пользователям абонентов.

▲ в начало

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

▲ в начало

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

▲ в начало

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

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Пользователи сервисов

СвойствоТипОбязательное
КлючевыеСвойстваКлючевыеСвойстваПользователиДа
КонтактнаяИнформацияКонтактнаяИнформация
ЧасовойПоясstring (20)

▲ в начало

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

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

▲ в начало

Приложения

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

Базовый класс: Ref

▲ в начало

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

Описывает справочник Приложения

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

▲ в начало

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

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

▲ в начало

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

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

Описывает данные пользователей приложений.

▲ в начало

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

▲ в начало

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

▲ в начало

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

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

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Конфигурации

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

▲ в начало

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

▲ в начало

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

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Информационные базы

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

▲ в начало

Класс КлючевыеСвойстваИнформационныеБазы
СвойствоТип
Наименованиеstring (64)
СсылкаСправочникСсылка.ИнформационныеБазы

▲ в начало

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

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Версии конфигурации

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

▲ в начало

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

▲ в начало

Тарифы

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Тарифы

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

▲ в начало

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

СвойствоТип
Кодstring (9)
Наименованиеstring (150)
СсылкаСправочникСсылка.Тарифы

▲ в начало

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

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

Описывает табличную часть Доступные тарифы справочника Тарифы

▲ в начало

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

Описывает строку табличной части Доступные тарифы справочника Тарифы

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

▲ в начало

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

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

Описывает табличную часть Конфигурации справочника Тарифы

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

▲ в начало

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

Описывает строку табличной части Конфигурации справочника Тарифы

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

▲ в начало

Ограничения

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

Описывает табличную часть Ограничения тарифов справочника Тарифы

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

▲ в начало

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

Описывает строку табличной части Ограничения тарифов справочника Тарифы

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

▲ в начало

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

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

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает справочник Виды ограничений тарифов

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

▲ в начало

Класс КлючевыеСвойстваВидыОграниченийТарифов
СвойствоТип
Кодstring (9)
Наименованиеstring (100)
СсылкаСправочникСсылка.ВидыОграниченийТарифов

▲ в начало

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

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает документ Подписка на тариф

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

▲ в начало

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

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

▲ в начало

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

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

Описывает контактную информацию

СвойствоТипСписок
СтрокаКонтактнаяИнформация.СтрокаДа

▲ в начало

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

Описывает строку контактной информации

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

▲ в начало

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

Объекты, входящие в этот раздел обеспечивают передачу данных по дополнительным реквизитам объектов.

Определение

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает дополнительные реквизиты объектов.

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

▲ в начало

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

СвойствоТип
Наименованиеstring
СсылкаСправочникСсылка.ДополнительныеРеквизиты
ЭтоДополнительноеСведениеboolean

▲ в начало

Значения реквизитов

Часть дополнительных реквизитов могут иметь значения данного типа.

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

Базовый класс: Ref

▲ в начало

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

Базовый класс: Object
Описывает значения дополнительных реквизитов.

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

▲ в начало

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

▲ в начало

Табличная часть объектов

Объекты используются для указания дополнительных реквизитов в объектах Справочник.Абоненты.

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

Описывает табличную часть Дополнительные реквизиты для объектов с дополнительными реквизитами.

СвойствоТипОбязательное
СтрокаДополнительныеРеквизиты.СтрокаДа

▲ в начало

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

Описывает строку дополнительных реквизитов объекта.

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

▲ в начало

Перечисления

Виды взаимоотношений

Класс ВидыВзаимоотношений

Описывает перечисление Виды взаимоотношений 
Значения перечисления:

  • ПровайдерАбонент
  • ПровайдерОбслуживающаяОрганизация
  • ОбслуживающаяОрганизацияАбонент

▲ в начало

Виды контактной информации

Класс ВидыКИ

Описывает перечисление Виды контактной информации 
Значения перечисления:

  • ПочтовыйАдрес
  • ЮридическийАдрес
  • ФактическийАдрес
  • Телефон
  • ТелефонДомашний
  • ТелефонРабочий
  • Факс
  • ВебСтраница
  • АдресЭлектроннойПочты
  • ПользовательскаяКИДругая
  • ПользовательскаяКИТелефон
  • ПользовательскаяКИАдрес
  • ПользовательскаяКИАдресЭлектроннойПочты
  • ПользовательскаяКИВебСтраница
  • ПользовательскаяКИФакс

▲ в начало

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

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

Описывает перечисление Права пользователей приложений 
Значения перечисления:

  • Запуск
  • ЗапускИАдминистрирование
  • ПросмотрРезервныхКопий
  • Чтение
  • Удаление
  • ВладелецАбонента
  • АдминистраторАбонента
  • УдаленныйДоступ
  • ЧтениеСлужебныхДанных
  • Оператор

▲ в начало

Типы подписок

Класс ТипыПодписок

Описывает перечисление Типы подписок 
Значения перечисления:

  • Основная
  • Расширяющая
  • Продлевающая

▲ в начало

Абстрактные классы

Класс ТипНомерДокумента

Описывает тип для номеров документов - string (256) 
▲ в начало

Удаление объектов

Класс УдалениеОбъекта

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

СвойствоТипОбязательное
СсылкаНаОбъектЛюбаяСсылкаДа

▲ в начало