GetTemplate

Предупреждение

Метод устарел. Для получения шаблона используйте метод GetMessage.

Получает шаблон документов.

GET /GetTemplate
Query Parameters:
  • boxId – идентификатор ящика организации.

  • templateId – идентификатор сообщения.

  • entityId – идентификатор документа из сообщения. Необязательный параметр; если указан, то возвращаются только сущности, связанные с данным документом.

Request Headers:
Status Codes:
  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у организации с указанным идентификатором boxId закончилась подписка на API.

  • 403 Forbidden – доступ к ресурсу с предоставленным авторизационным токеном запрещен.

  • 404 Not Found – не найден ящик или шаблон с указанными идентификаторами.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Выдаваемая структура Template включает в себя сущности из всех дополнений, составляющих цепочку документооборота templateId.

Вся информация, относящаяся к данной цепочке (в частности, документы и подписи), по возможности помещается в протобуфер. Суммарный размер бинарных представлений (структура Content, поле Data) не может превышать 1 048 576 байт. Если добавление очередного бинарного представления вызовет превышение этого ограничения, то это бинарное представление не будет добавлено в протобуфер.