Перейти к основному содержимому

DetectCustomPrintForms

Определяет нестандартную печатную форму для документов из указанного списка.

Получить печатную форму документа можно с помощью методов GeneratePrintForm или GeneratePrintFormPng.

POST /DetectCustomPrintForms

Параметры запроса

  • boxId — идентификатор ящика организации в формате GUID.

Заголовки запроса

Тело запроса

Тело запроса должно содержать список идентификаторов документов, для которых нужно определить наличие нестандартной печатной формы, представленный структурой CustomPrintFormDetectionRequest:

message CustomPrintFormDetectionRequest {
repeated DocumentId DocumentIds = 1;
}
  • DocumentIds — список идентификаторов документов, представленных структурой DocumentId.

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя нет доступа к каким-то документам из запроса.
  • 405 — используется неподходящий HTTP-метод.
  • 415 — тип содержимого запроса не поддерживается.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит результат определения нестандартных печатных форм для документов, представленный структурой CustomPrintFormDetectionResult:

message CustomPrintFormDetectionResult {
repeated CustomPrintFormDetectionItemResult Items = 1;
}

message CustomPrintFormDetectionItemResult {
required DocumentId DocumentId = 1;
required bool HasCustomPrintForm = 2;
}
  • Items — список результатов определения нестандартных печатных форм, представленных структурой CustomPrintFormDetectionItemResult с полями:
    • DocumentId — идентификатор документа, представленный структурой DocumentId.
    • HasCustomPrintForm — признак того, что документ имеет нестандартную печатную форму.

Метод обрабатывает за один запрос не более 100 документов.

Примеры использования

Пример HTTP-запроса:

POST /DetectCustomPrintForms?boxId={{boxId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Content-Type: application/json; charset=utf-8
Accept: application/json

Пример тела запроса:

{
"DocumentIds" : [
{
"MessageId" : "b93e4464-b14d-4c30-a8f5-b714c390d0a0",
"EntityId" : "6c69e5bd-f421-4825-9f31-970182fee429"
},
{
"MessageId" : "f2f388b8-4a96-4ce5-bd85-23fe10131ea4",
"EntityId" : "bf16d371-3b18-47dd-b5f1-5a959628d0ef"
}
]
}

Пример тела ответа:

{
"Items": [
{
"DocumentId": {
"EntityId": "6c69e5bd-f421-4825-9f31-970182fee429",
"MessageId": "b93e4464-b14d-4c30-a8f5-b714c390d0a0"
},
"HasCustomPrintForm": false
},
{
"DocumentId": {
"EntityId": "bf16d371-3b18-47dd-b5f1-5a959628d0ef",
"MessageId": "f2f388b8-4a96-4ce5-bd85-23fe10131ea4"
},
"HasCustomPrintForm": true
}
]
}

См. также

Инструкции:

Методы для работы с печатными формами:

  • DetectCustomPrintForms — определяет нестандартную печатную форму для документов из указанного списка
  • GenerateDocumentProtocol — генерирует печатную форму протокола передачи документа и подпись к ней
  • GenerateDocumentZip — формирует ZIP-архив, содержащий файлы документооборота указанного документа
  • GeneratePrintForm — генерирует печатную форму документа в формате PDF
  • GeneratePrintFormFromAttachment — возвращает идентификатор, с помощью которого можно получить печатную форму документа в формате PDF по его содержимому
  • GeneratePrintFormPng — запускает генерацию печатной формы документа в формате PNG
  • GeneratePrintFormPngFromAttachment — запускает генерацию печатной формы документа в формате PNG по его содержимому
  • GetGeneratedPrintForm — генерирует печатную форму документа по идентификатору, полученному методом GeneratePrintFormFromAttachment
  • GetGeneratedPrintFormResult — возвращает статус и результат генерации печатной формы

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года