DetectDocumentTypes

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

Метод устарел. Для определения типов используйте метод DetectDocumentTitles.

Метод DetectDocumentTypes определяет возможные типы указанного документа.

POST /DetectDocumentTypes

Query Parameters:

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

• nameOnShelf – имя файла на полке документов.

Request Headers:

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

Request Body:

Тело запроса должно хранить бинарное содержимое документа.

Status Codes:

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

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

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

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

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

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

Response Body:

Тело ответа содержит описание типов документов, представленное структурой DetectDocumentTypesResponse:

message DetectDocumentTypesResponse {
        repeated DetectedDocumentType DocumentTypes = 1;
}

message DetectedDocumentType {
        required string TypeNamedId = 1;
        required string Function = 2;
        required string Version = 3;
}

Метод можно использовать в двух вариантах:

• POST запрос с заполненным Request Body,

• GET запрос с параметром nameOnShelf, если содержимое документа было загружено на полку методом ShelfUpload.