DetectDocumentTitles

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

POST /DetectDocumentTitles
Query Parameters:

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

Request Body:

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

GET /DetectDocumentTitles
Query Parameters:
Request Headers:
Status Codes:

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

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

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

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

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

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

Response Body:

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

message DetectTitleResponse {
        repeated DetectedDocumentTitle DocumentTitles = 1;
}

message DetectedDocumentTitle {
        required string TypeNamedId = 1;
        required string Function = 2;
        required string Version = 3;
        required int32 TitleIndex = 4;
        repeated Events.MetadataItem Metadata = 5;
}

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

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

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

Метод анализирует содержимое документа и определяет, с какими значениями TypeNamedId можно отправить документ с таким содержимым. Если таких типов несколько, то метод вернет массив с описанием всех этих типов. Так бывает в случае, когда у нескольких типов документов схожее содержимое. Например, накладную в 820 формате можно отправить с типами UniversalTransferDocument и XmlTorg12. В этом случае для накладной в 820 формате вернется массив с двумя типами документов. Если содержимому документа соответствует только один тип, то метод вернет массив с единственным элементом.

Примечание

Метод будет определять только те типы документов, которые доступны в текущей организации.