ParseTitleXml

Парсит файл титула любого формализованного документа.

POST /ParseTitleXml
Query Parameters:

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

  • documentTypeNamedId – строковый идентификатор типа документа. Доступные типы можно получить с помощью метода GetDocumentTypes (V2).

  • documentFunction – функция документа.

  • documentVersion – версия документа.

  • titleIndex – числовой идентификатор титула документа.

Request Headers:
Request Body:

Тело запроса должно содержать XML-файл титула, соответствующий XSD-схеме. Получить XSD-схему титула можно с помощью метода GetDocumentTypes (V2) в поле XsdUrl. Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.

Status Codes:

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

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

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

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

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

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

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

Response Headers:

  • Content-Disposition – имя файла сгенерированного титула.

Response Body:

Тело ответа содержит упрощенный XML-файл, соответствующий XSD-схеме. Получить XSD-схему титула можно с помощью метода GetDocumentTypes (V2) в поле UserDataXsdUrl. Инструкция о получении данных из метода GetDocumentTypes приведена на странице Получение информации о типе документа.

Подробное описание и примеры использования метода приведены на странице Парсинг формализованного документа.

См. также

Инструкции:
Методы для работы с титулом:

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

  • GenerateTitleXml — генерирует файл титула любого формализованного документа

  • ParseTitleXml — парсит файл титула любого формализованного документа