Обмен данными ЕГАИС

ЗапуститьОбработкуОтветовЕГАИС

Описание, пример вызова

// Процедура запуска регламентного задания ОбработкаОтветовЕГАИС.
//
Процедура ЗапуститьОбработкуОтветовЕГАИС() Экспорт

Пример вызова

ОбменДаннымиЕГАИС.ЗапуститьОбработкуОтветовЕГАИС()

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

Описание, пример вызова

// Формирует пустую структуру сообщения XML
//
// Параметры:
//  ДляКлиента - Булево - Для клиента
//
// Возвращаемое значение:
//  Структура -- Структура со свойствами:
// * ТекстОшибки - Строка - Текст ошибки.
// * Ошибки - Соответствие из Строка - Описание ошибок.
// * Описание - Строка - Описание для отображения в форме подписания.
// * ТекстСообщенияXML - Строка - Текст сообщения XML.
// * ТипСообщения - ПеречислениеСсылка.ТипыЗапросовИС - Тип сообщения.
// * ОрганизацияЕГАИС - СправочникСсылка.КлассификаторОрганизацийЕГАИС - Организация ЕГАИС.
// * Документ - ДокументСсылка, Неопределено - Документ.
// * Версия - Число - Версия сообщения.
// * ДокументОснование - ДокументСсылка - Документ основание.
// * Операция - ПеречислениеСсылка - Операция
// * ФорматОбмена - ПеречислениеСсылка.ФорматыОбменаЕГАИС - формат обмена
Функция СтруктураСообщенияXML(ДляКлиента = Ложь) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.СтруктураСообщенияXML(ДляКлиента);

ПараметрыОбновленияСтатуса

Описание, пример вызова

// Возвращает доступные параметры обновления статуса:
//   * ОбновлятьДвижения- Булево - Признак необходимости обновления движений документа.
//   * ОперацияКвитанции - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//   * СтатусОбработки - ПеречислениеСсылка.СтатусыОбработкиСообщенийЕГАИС - Статус обработки сообщения.
//   * ДокументОбъект - ДокументОбъект - Документ-объект.
//   * ИдентификаторЗапроса - Строка - Идентификатор запроса.
//   * ФорматОбмена - ПеречислениеСсылка.ФорматыОбменаЕГАИС - Формат обмена.
//
// Возвращаемое значение:
//  Структура - структура параметров обновления статуса.
//
Функция ПараметрыОбновленияСтатуса() Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ПараметрыОбновленияСтатуса()

ПодготовитьСообщениеКПередаче

Описание, пример вызова

// Подготавливает сообщение к передаче в сервис ЕГАИС.
//
// Параметры:
//  ТекстСообщенияXML - Строка - Текст исходящего сообщения.
//  Реквизиты - Структура - Реквизиты передаваемого сообщения:
//   * ТипСообщения - ПеречислениеСсылка.ТипыЗапросовИС - Тип сообщения.
//   * Операция - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//   * Документ - ДокументСсылка - Документ.
//   * СообщениеОснование - СправочникСсылка.ЕГАИСПрисоединенныеФайлы - Сообщение-основание
//   * Описание - Строка - Описание сообщения.
//   * ИдентификаторЗапроса - Строка - Идентификатор запроса.
//   * ФорматОбмена - ПеречислениеСсылка.ФорматыОбменаЕГАИС - Формат обмена.
//   * ОрганизацияЕГАИС - СправочникСсылка.КлассификаторОрганизацийЕГАИС - Организация ЕГАИС.
//   * СтатусОбработки - ПеречислениеСсылка.СтатусыОбработкиСообщенийЕГАИС - Статус обработки сообщения.
//   * Версия - Число - Номер версии.
//  Немедленно - Булево - Признак немедленной передачи сообщения в УТМ, без очереди сообщений.
//
// Возвращаемое значение:
//  Массив из Структура - содержит коллекцию структур:
//    * НовыйСтатус - ПеречислениеСсылка.СтатусыИнформированияЕГАИС - новый статус документа
//    * ИсходящееСообщение - Строка - подготовленное сообщение.
//    * ИсходящееСообщение - Строка - подготовленное сообщение.
//
Функция ПодготовитьСообщениеКПередаче(ТекстСообщенияXML, Реквизиты, Немедленно = Ложь) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ПодготовитьСообщениеКПередаче(ТекстСообщенияXML, Реквизиты, Немедленно);

ДобавитьСообщениеВОчередьНаПередачуДанных

Описание, пример вызова

// Добавить сообщение в регистра сведений ОчередьПередачиДанныхЕГАИС.
//
// Параметры:
//  Сообщение - СправочникСсылка.ЕГАИСПрисоединенныеФайлы - сообщение, которое добавляется в очередь.
//  ОрганизацияЕГАИС - СправочникСсылка.КлассификаторОрганизацийЕГАИС - организация ЕГАИС
//
Процедура ДобавитьСообщениеВОчередьНаПередачуДанных(Сообщение, ОрганизацияЕГАИС) Экспорт

Пример вызова

ОбменДаннымиЕГАИС.ДобавитьСообщениеВОчередьНаПередачуДанных(Сообщение, ОрганизацияЕГАИС));

УдалитьСообщениеИзОчередиПередачиДанных

Описание, пример вызова

// Удалить сообщение из регистра сведений ОчередьПередачиДанныхЕГАИС.
//
// Параметры:
//  Сообщение - СправочникСсылка.ЕГАИСПрисоединенныеФайлы - сообщение, которое удаляется из очереди.
//
Процедура УдалитьСообщениеИзОчередиПередачиДанных(Сообщение) Экспорт

Пример вызова

ОбменДаннымиЕГАИС.УдалитьСообщениеИзОчередиПередачиДанных(Сообщение)

ДобавитьЗаписьВПротоколОбмена

Описание, пример вызова

// Добавить запись в протокол обмена.
//
// Параметры:
//  ТекстСообщенияXML - Строка - Текст сообщения XML.
//  Реквизиты - Структура - Значения реквизитов сообщения.
//  ПроверятьХешБезСсылки - Булево - Признак проверки хеша без ссылки.
//
// Возвращаемое значение:
//  Структура - Структура со свойствами:
//   * НовоеСообщение - Булево - Это новое сообщение.
//   * Ссылка - СправочникСсылка.ЕГАИСПрисоединенныеФайлы - Ссылка на присоединенный файл.
//
Функция ДобавитьЗаписьВПротоколОбмена(ТекстСообщенияXML, Реквизиты, ПроверятьХешБезСсылки = Ложь) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ДобавитьЗаписьВПротоколОбмена(ТекстСообщенияXML, Реквизиты, ПроверятьХешБезСсылки);

УстановитьВидимостьКомандыВыполнитьОбмен

Описание, пример вызова

// Устанавливает видимость команды "Выполнить обмен" в формах документов, протокола и панели обмена с ЕГАИС.
//
// Параметры:
//  Форма - ФормаКлиентскогоПриложения - Форма
//  ИмяЭлемента - Строка - Имя элемента формы
Процедура УстановитьВидимостьКомандыВыполнитьОбмен(Форма, ИмяЭлемента) Экспорт

Пример вызова

ОбменДаннымиЕГАИС.УстановитьВидимостьКомандыВыполнитьОбмен(Форма, ИмяЭлемента)

ЧекXDTOВXML

Описание, пример вызова

// Преобразует объект XDTO чека в XML.
//
// Параметры:
//  ОбъектXDTO - ОбъектXDTO - Объект XDTO
//  ПространствоИмен - Строка - Имя пространства имен.
//  ИмяТипа - Строка - Имя типа
//
// Возвращаемое значение:
//  Строка - Текст сообщения XML.
//
Функция ЧекXDTOВXML(ОбъектXDTO, ПространствоИмен, ИмяТипа) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ЧекXDTOВXML(ОбъектXDTO, ПространствоИмен, ИмяТипа)

ОписаниеОперации

Описание, пример вызова

// Сформировать описание операции для документа.
//
// Параметры:
//  Описание - Строка - Описание операции.
//  ДокументСсылка - ДокументСсылка - Документ.
//  НомерВерсии - Число - Номер версии.
//
// Возвращаемое значение:
//  Строка - Описание операции.
//
Функция ОписаниеОперации(Описание, ДокументСсылка, НомерВерсии = Неопределено) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ОписаниеОперации(Описание, ДокументСсылка, НомерВерсии);

ОписаниеОперацииПередачиДанных

Описание, пример вызова

// Сформировать описание операции для документа
//
// Параметры:
//  ОперацияПередачиДанных - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция обмена с ЕГАИС
//  ДокументСсылка - ДокументСсылка - Документ ссылка
//  НомерВерсии - Число - Номер версии
//
// Возвращаемое значение:
//  Строка - Описание операции
//
Функция ОписаниеОперацииПередачиДанных(ОперацияПередачиДанных, ДокументСсылка = Неопределено, НомерВерсии = Неопределено) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ОписаниеОперацииПередачиДанных(ОперацияПередачиДанных, ДокументСсылка, НомерВерсии);

ОписаниеОперацииПолученияДанных

Описание, пример вызова

//Сформировать описание операции для документа
//
//Параметры:
//   ОперацияПередачиДанных - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция обмена с ЕГАИС
//
//Возвращаемое значение:
//   Строка - Описание операции
//
Функция ОписаниеОперацииПолученияДанных(ОперацияПередачиДанных) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ОписаниеОперацииПолученияДанных(ОперацияПередачиДанных)

КатегорииОпераций

Описание, пример вызова

// Возвращает операции обмена с ЕГАИС, разбитые на категории
//
// Возвращаемое значение:
//  Структура - со свойствами:
//    * ПередачаДанных - Соответствие Из ПеречислениеСсылка.ВидыДокументовЕГАИС - Операции передачи данных.
//    * ПолучениеДанных - Соответствие Из ПеречислениеСсылка.ВидыДокументовЕГАИС - Операции получения данных.
//
Функция КатегорииОпераций() Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.КатегорииОпераций()

ПустаяТаблицаПоследовательностьОпераций

Описание, пример вызова

// Создает таблицу последовательности операций.
//
// Возвращаемое значение:
//  ТаблицаЗначений - Таблица с колонками:
//   * Операция - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//   * Индекс - Число - Индекс операции в последовательности.
//   * ТипСообщения - ПеречислениеСсылка.ТипыЗапросовИС - Тип сообщения.
//   * КвитанцияУТМ - Булево - Признак наличия у операции квитанции УТМ.
//   * КвитанцияПолученЕГАИС - Булево - Признак наличия у операции квитанции Получен ЕГАИС.
//   * КвитанцияПроведенЕГАИС - Булево - Признак наличия у операции квитанции Проведен ЕГАИС.
//   * ДальнейшиеДействия - Массив Из ПеречислениеСсылка - Дальнейшие действия при операции.
//
Функция ПустаяТаблицаПоследовательностьОпераций() Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ПустаяТаблицаПоследовательностьОпераций()

ДобавитьОперациюВПоследовательность

Описание, пример вызова

// Добавляет операцию в последовательность операций.
//
// Параметры:
//  ПоследовательностьОпераций - ТаблицаЗначений - см. функцию ПустаяТаблицаПоследовательностьОпераций().
//  Индекс - Число - Индекс добавляемой операции.
//  ТипСообщения - ПеречислениеСсылка.ТипыЗапросовИС - Тип сообщения.
//  Операция - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//  РассчитатьДействияДляДокумента - ДокументСсылка - Документ, для которого нужно вычислить дальнейшие действия.
//  КвитанцияПолученЕГАИС - Булево - Признак наличия у операции квитанции Получен ЕГАИС.
//  КвитанцияПроведенЕГАИС - Булево - Признак наличия у операции квитанции Проведен ЕГАИС.
//
// Возвращаемое значение:
//  СтрокаТаблицыЗначений - см. функцию ПустаяТаблицаПоследовательностьОпераций().
//
Функция ДобавитьОперациюВПоследовательность(ПоследовательностьОпераций, Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ДобавитьОперациюВПоследовательность(ПоследовательностьОпераций, );

ОбработатьОтветНаЗапросПолученияДокумента

Описание, пример вызова

// Обрабатывает ответ ЕГАИС на запрос о получении документа.
//
// Параметры:
//  ВходящиеДанные - (См. ОбменДаннымиЕГАИСКлиентСервер.СтруктураЗагрузкиВходящегоДокумента).
//  ТаблицаСоответствияДокументовТипамЕГАИС - ТаблицаЗначений - см. функцию Перечисления.ВидыДокументовЕГАИС.ТаблицаСоответствияДокументовТипамЕГАИС().
//
// Возвращаемое значение:
//  Структура:
//   * Результат         - Неопределено, Структура - результат выполнения запроса.
//   * ТекстОшибки       - Строка - текст ошибки, в случае ее возникновения.
//   * ТекстСообщенияXML - Строка - содержит ответ, полученный на запрос.
//   * СтатусОбработки   - ПеречислениеСсылка.СтатусыОбработкиСообщенийЕГАИС - Статус обработки сообщения.
//
Функция ОбработатьОтветНаЗапросПолученияДокумента(ВходящиеДанные, ТаблицаСоответствияДокументовТипамЕГАИС = Неопределено) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ОбработатьОтветНаЗапросПолученияДокумента(ВходящиеДанные, ТаблицаСоответствияДокументовТипамЕГАИС);

ДанныеОрганизации

Описание, пример вызова

// Возвращает объект XDTO организации, которую требуется загрузить.
//
// Параметры:
//  ДанныеОрганизации - ОбъектXDTO - Данные организации
//
// Возвращаемое значение:
//  ОбъектXDTO - Данные организации
Функция ДанныеОрганизации(ДанныеОрганизации) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ДанныеОрганизации(ДанныеОрганизации)

ЗагрузитьОрганизацию

Описание, пример вызова

//Загружает организацию ЕГАИС в базу.
//  * При загрузке запросом из классификатора - безусловно.
//  * При загрузке в составе пакета (например ТТН) - создание новых элементов и обновление контрагентов
//    (флаг "Соответствует организации" установлен в Ложь).
//
//Параметры:
//   ДанныеОрганизацииXDTO - ОбъектXDTO - данные классификатора организаций ЕГАИС
//   ЗагрузкаИзКлассификатора - Булево - признак запроса данных из классификатора
//
//Возвращаемое значение:
//   СправочникСсылка.КлассификаторОрганизацийЕГАИС - найденный или загруженный элемент классификатора.
//
Функция ЗагрузитьОрганизацию(ДанныеОрганизацииXDTO, ЗагрузкаИзКлассификатора = Ложь) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ЗагрузитьОрганизацию(ДанныеОрганизацииXDTO, ЗагрузкаИзКлассификатора);

НайтиОбъектПоИдентификаторуЗапроса

Описание, пример вызова

// Возвращает данные последнего исходящего запроса по идентификатору.
//
// Параметры:
//  ИдентификаторЗапроса - Строка - идентификатор исходящего запроса.
//
// Возвращаемое значение:
//   Структура - данные последнего исходящего запроса. Неопределено - если запрос не найден.
//
Функция НайтиОбъектПоИдентификаторуЗапроса(ИдентификаторЗапроса, ИскатьДокументОснование = Истина) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.НайтиОбъектПоИдентификаторуЗапроса(ИдентификаторЗапроса, ИскатьДокументОснование);

ПараметрыИдентификатораЗапросаV4

Описание, пример вызова

Функция ПараметрыИдентификатораЗапросаV4(ИдентификаторЗапроса) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ПараметрыИдентификатораЗапросаV4(ИдентификаторЗапроса)

ИсходящееСообщение

Описание, пример вызова

Функция ИсходящееСообщение(ИдентификаторЗапроса) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ИсходящееСообщение(ИдентификаторЗапроса)

ЗагрузитьОтветНаЗапросДанныхОрганизации

Описание, пример вызова

// Загружает список организаций ЕГАИС в базу.
//
// Параметры:
//  ДанныеДокумента - см. ОбработатьОтветНаЗапросПолученияДокумента
//  ОрганизацияЕГАИС - СправочникСсылка.КлассификаторОрганизацийЕГАИС - организация ЕГАИС
//  ДополнительныеПараметры - Неопределено, Произвольный - дополнительные параметры
//
// Возвращаемое значение:
//  см. ОбменДаннымиЕГАИСКлиентСервер.СтруктураИзменения
Функция ЗагрузитьОтветНаЗапросДанныхОрганизации(ДанныеДокумента, ОрганизацияЕГАИС, ДополнительныеПараметры = Неопределено) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ЗагрузитьОтветНаЗапросДанныхОрганизации(ДанныеДокумента, ОрганизацияЕГАИС, ДополнительныеПараметры);

РассчитатьСтатус

Описание, пример вызова

// Рассчитать статус документа ЕГАИС.
//
// Параметры:
//  ДокументСсылка - ДокументСсылка - Документ ЕГАИС.
//  ЕстьЗаписиВПротоколеОбмена - Булево - Признак наличия записей в протоколе обмена (Возвращаемый параметр).
//
// Возвращаемое значение:
//  РегистрСведенийНаборЗаписей.СтатусыДокументовЕГАИС - Набор записей регистра сведений СтатусыДокументовЕГАИС.
//
Функция РассчитатьСтатус(ДокументСсылка, ЕстьЗаписиВПротоколеОбмена = Неопределено, ЭтоОбновлениеИБ = Ложь) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.РассчитатьСтатус(ДокументСсылка, ЕстьЗаписиВПротоколеОбмена, ЭтоОбновлениеИБ);

ПараметрыОбновленияПослеПолученияДанных

Описание, пример вызова

// Возвращает параметры обновления после получения данных.
//
// Параметры:
//  ЗаписьНабора - Структура - Запись набора.
//  МенеджерОбъекта - ДокументМенеджер - Менеджер документа.
//  ДокументСсылка - ДокументСсылка - Ссылка на документ.
//  Операция - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//  ЭтоКвитанция - Булево - Признак квитанции.
//  ОперацияКвитанции - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция квитанции.
//  СтатусОбработки - ПеречислениеСсылка.СтатусыОбработкиСообщенийЕГАИС - Статус обработки сообщения.
//
// Возвращаемое значение:
//  Структура - Структура со свойствами:
//   * НовыйСтатус - ПеречислениеСсылка.СтатусыОбработкиАктаПостановкиНаБалансЕГАИС - Новый статус.
//   * ДальнейшееДействие1 - ПеречислениеСсылка.ДальнейшиеДействияПоВзаимодействиюЕГАИС - Дальнейшее действие 1.
//   * ДальнейшееДействие2 - ПеречислениеСсылка.ДальнейшиеДействияПоВзаимодействиюЕГАИС - Дальнейшее действие 2.
//   * ДальнейшееДействие3 - ПеречислениеСсылка.ДальнейшиеДействияПоВзаимодействиюЕГАИС - Дальнейшее действие 3.
//
Функция ПараметрыОбновленияПослеПолученияДанных(ЗаписьНабора, МенеджерОбъекта, ДокументСсылка, Операция, Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ПараметрыОбновленияПослеПолученияДанных(ЗаписьНабора, МенеджерОбъекта, ДокументСсылка, Операция, );

ТипОрганизации

Описание, пример вызова

// Возвращает тип организации ЕГАИС.
//
// Параметры:
//  ДанныеОрганизации - ОбъектXDTO - Данные организации ЕГАИС.
//
// Возвращаемое значение:
//  ПеречислениеСсылка.ТипыОрганизацийЕГАИС - Тип организации ЕГАИС.
//
Функция ТипОрганизации(ДанныеОрганизации) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ТипОрганизации(ДанныеОрганизации));

ДополнитьПараметрыОбновленияСтатуса

Описание, пример вызова

// Дополнить параметры обновления статуса.
//
// Параметры:
//  ПараметрыОбновленияСтатуса - см. ПараметрыОбновленияСтатуса
//
// Возвращаемое значение:
//  Структура - см. ПараметрыОбновленияСтатуса
//
Функция ДополнитьПараметрыОбновленияСтатуса(ПараметрыОбновленияСтатуса = Неопределено) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.ДополнитьПараметрыОбновленияСтатуса(ПараметрыОбновленияСтатуса);

РасширеннаяИнформацияОбОшибке

Описание, пример вызова

Функция РасширеннаяИнформацияОбОшибке(КраткоеПредставлениеОшибки, ПодробноеПредставлениеОшибки) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.РасширеннаяИнформацияОбОшибке(КраткоеПредставлениеОшибки, ПодробноеПредставлениеОшибки)

ОбработатьОшибку

Описание, пример вызова

Процедура ОбработатьОшибку(ТекстОшибки, ИнформацияОбОшибке, ВозвращаемоеЗначение) Экспорт

Пример вызова

ОбменДаннымиЕГАИС.ОбработатьОшибку(ТекстОшибки, ИнформацияОбОшибке, ВозвращаемоеЗначение)

СообщатьОбОшибкахПриЗагрузкеДанных

Описание, пример вызова

// Сообщать об ошибках при загрузке данных.
//
// Возвращаемое значение:
//  Булево - Необходимость сообщения об ошибках при загрузке данных.
//
Функция СообщатьОбОшибкахПриЗагрузкеДанных() Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.СообщатьОбОшибкахПриЗагрузкеДанных()

СлужебныеДанные

Описание, пример вызова

// Возвращает структура данных для удаления запросов из УТМ.
//
// Параметры:
//  ОрганизацияЕГАИС - СправочникСсылка.КлассификаторОрганизацийЕГАИС - Организация ЕГАИС.
//  Операция - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//  АдресЗапроса - Строка - Адрес запроса.
//
// Возвращаемое значение:
//  Структура - Структура со свойствами:
//   * ОрганизацияЕГАИС - СправочникСсылка.КлассификаторОрганизацийЕГАИС - Организация ЕГАИС.
//   * Операция - ПеречислениеСсылка.ВидыДокументовЕГАИС - Операция.
//   * АдресЗапроса - Строка - Адрес запроса.
//
Функция СлужебныеДанные(ОрганизацияЕГАИС, Операция, АдресЗапроса) Экспорт

Пример вызова

Результат = ОбменДаннымиЕГАИС.СлужебныеДанные(ОрганизацияЕГАИС, Операция, АдресЗапроса)