GenerateRecipientTitleXml¶
-
POST
/GenerateRecipientTitleXml
¶ Query Parameters: - documentVersion – строковый идентификатор версии типа документа
- boxId – идентификатор ящика
- senderTitleMessageId – идентификатор сообщения, содержащего соответствующий титул продавца
- senderTitleAttachmentId – идентификатор сущности, представляющей титул продавца, для которого требуется изготовить титул заказчика
Request Headers: - Authorization – данные, необходимые для авторизации
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 – при обработке запроса возникла непредвиденная ошибка
Если не указан параметр documentVersion, то по умолчанию используется значение версии взятое из документа, для которого выполняется генерация титула.
В теле запроса должен содержаться заполненный XML-файл, соответствующий XSD-схеме контракта для генерации титула получателя данного типа документа. XSD-схема контракта, необходимого для генерации титула, может быть получена с помощью ссылки, доступной в поле UserDataXsdUrl контракта DocumentTitle, который можно получить с помощью метода GetDocumentTypes.
В теле ответа содержится сгенерированный XML-файл титула получателя для указанного документа, построенный на основании данных из запроса. Файл изготавливается в соответствии с XSD-схемой соответствующего типа документа.
Имя файла сгенерированного титула возвращается в стандартном HTTP-заголовке Content-Disposition.