Новое в API: метод генерации GenerateTitleXml — Диадок

Новое в API: метод генерации GenerateTitleXml

23 августа 2019
Работа системы

В Диадоке появился новый метод генерации GenerateTitleXml. Это универсальный метод, который создает xml-файл любого титула любого типа документа. 

На вход метода нужно передать параметры — идентификатор ящика, тип, версию, функцию документа, номер (индекс) титула. В теле запроса должен быть  передан соответствующий usedatacontract.xml. Описание xsd-схемы файла UserDataContract можно получить из ответа метода GetDocumentTypes. Подробнее о работе метода GenerateTitleXml можно узнать из документации.

Зачем еще один метод?

В Диадоке уже есть методы генерации:

  • “универсальные”, предназначенные для генерации титулов отправителя GenerateSenderTitleXml и получателя GenerateRecipientTitleXml любого типа документа,

  • старые методы  для генерации титулов определенных типов.

Появление универсальных методов генерации обусловлено созданием новых типов документов с разным количеством титулов (более двух), а также регулярными обновлениями форматов документов ФНС. Универсальные методы позволяют не изменять API (обновлять и создавать контракты, повышать версии отдельных методов) при появлении новых типов или изменениях форматов документов. Как следствие, интеграторам теперь проще обновлять интеграционные решения.

Какие методы использовать?

Рекомендуем использовать новый метод генерации GenerateTitleXml, если Вы:

  • только начинаете интеграцию с Диадоком;

  • реализуете поддержку нового формата 820 (подробно), но еще не перешли на использование универсальных методов GenerateRecipientTitleXml и GenerateSenderTitleXml

  • работаете с формализованными документами не в формате ФНС.

Если вы уже поддержали в интеграции методы  GenerateSenderTitleXml  и GenerateRecipientTitleXml - переходить на использование нового метода необязательно. Эти методы будут поддерживаться. 

Если в будущем возникнет потребность работать с документами, у которых более двух титулов — генерировать их следует только новым методом GenerateTitleXml.

Мы рекомендуем отказаться от старых методов генерации:

Эти методы не будут дорабатываться и в будущем могут быть сняты с поддержки — об этом будет сообщено дополнительно. 

2 комментария
Виктория    18 сентября, 16:44
Подскажите, пожалуйста, какие документы требуют более 2-ух титулов?
Наталья    19 сентября, 15:28
Добрый день! В настоящее время в диадоке есть только 1 тип документа с 3 титулами - это транспортная накладная.