DetectCustomPrintForms

POST /DetectCustomPrintForms
Query Parameters:
 
  • boxId – идентификатор ящика
Request Headers:
 
Status Codes:
  • 200 OK – операция успешно завершена
  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры
  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization, или в этом заголовке содержатся некорректные авторизационные данные
  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен; нет доступа к каким-то документам из запроса;
  • 405 Method Not Allowed – используется неподходящий HTTP-метод
  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка

Тело запроса: CustomPrintFormDetectionRequest

Тело ответа: CustomPrintFormDetectionResult

Метод позволяет по списку документов определить, есть ли у документов нестандартная печатная форма. Скачать печатную форму документа можно при помощи метода GeneratePrintForm.

Максимальное количество документов в списке на один запрос — 100.

CustomPrintFormDetectionRequest

message CustomPrintFormDetectionRequest {
    repeated DocumentId DocumentIds = 1;
}

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

  • DocumentId — идентификатор документа

CustomPrintFormDetectionResult

message CustomPrintFormDetectionResult {
   repeated CustomPrintFormDetectionItemResult Items = 1;
}

message CustomPrintFormDetectionItemResult {
   required DocumentId DocumentId = 1;
   required bool HasCustomPrintForm = 2;
}

Структура данных CustomPrintFormDetectionResult содержит результат проверки.

  • DocumentId — идентификатор документа
  • HasCustomPrintForm — флаг, показывающий, что данный документ имеет нестандартную печатную форму