DetectCustomPrintForms

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

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

POST /DetectCustomPrintForms

Query Parameters:

• boxId – идентификатор ящика организации.

Request Headers:

• Authorization – данные, необходимые для авторизации.

Request Body:

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

message CustomPrintFormDetectionRequest {
    repeated DocumentId DocumentIds = 1;
}

• DocumentIds — список идентификаторов документов, представленных структурой DocumentId.

Status Codes:

• 200 OK – операция успешно завершена.

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

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

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

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

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

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

Response Body:

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

message CustomPrintFormDetectionResult {
   repeated CustomPrintFormDetectionItemResult Items = 1;
}

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

• Items — список результатов проверки, представленных структурой CustomPrintFormDetectionItemResult с полями:

  • DocumentId — идентификатор документа, представленный структурой DocumentId.

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

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

---

См. также

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

• GenerateForwardedDocumentPrintForm — генерирует печатную форму пересланного документа

• GeneratePrintForm — генерирует печатную форму документа по его идентификатору

• GeneratePrintFormFromAttachment — возвращает идентификатор, с помощью которого можно получить печатную форму документа по его содержимому

• GetGeneratedPrintForm — генерирует печатную форму документа