PrepareDocumentsToSignRequest

Запрос на подготовку документов к подписанию методом PrepareDocumentsToSign.

Подробнее про подготовку в подписанию в инструкции Подготовка документа к подписанию.

message PrepareDocumentsToSignRequest {
    required string BoxId = 1;
    repeated DraftDocumentToPatch DraftDocuments = 2;
    repeated DocumentToPatch Documents = 3;
    repeated ContentToPatch Contents = 4;
}

message DraftDocumentToPatch {
    required DocumentId DocumentId = 1;
    optional string ToBoxId = 2;
    optional Signer Signer = 3;
    repeated ExtendedSigner ExtendedSigner = 4;
    optional bytes SignerContent = 5;
}

message DocumentToPatch {
    required DocumentId DocumentId = 1;
    optional Signer Signer = 2;
    repeated ExtendedSigner ExtendedSigner = 3;
    optional bytes SignerContent = 4;
}

message ContentToPatch {
    required string TypeNamedId = 1;
    required string Function = 2;
    required string Version = 3;
    required UnsignedContent Content = 4;
    optional string ToBoxId = 5;
    optional Signer Signer = 6;
    repeated ExtendedSigner ExtendedSigner = 7;
    optional bytes SignerContent = 8;
}

  • BoxId — идентификатор ящика, документы из которого нужно подготовить к подписанию.

  • DraftDocuments — список черновиков документов, которые нужно подготовить к подписанию. Отправить подготовленные черновики можно с помощью метода SendDraft. Каждый элемент списка представлен структурой DraftDocumentToPatch с полями:

    • DocumentId — идентификатор черновика документа, который нужно подготовить к подписанию и отправке. Представлен структурой DocumentId.

    • ToBoxId — идентификатор ящика, в который нужно отправить документ. Если значение не указано, используется идентификатор ящика получателя из черновика.

    • Signer — информация о подписанте документа в упрощенном формате, представленная структурой Signer. Упрощенный формат устарел и больше не используется. Применялся при подписании документов в форматах приказов №93 и 172.

    • ExtendedSigner — информация о подписанте документа в расширенном формате, представленная структурой ExtendedSigner. Если у документа больше одного подписанта, вернется ошибка 400 (Bad Request). Используется для документов в форматах приказов №551, 552 и 736.

    • SignerContent — бинарное представление упрощенного XML-файла подписанта. Инструкция о формировании файла подписанта приведена в разделе Универсальный формат заполнения данных подписанта.

  • Documents — список документов, которые нужно подготовить к подписанию и отправке. Отправить подготовленные документы можно с помощью метода PostMessagePatch (V3) или PostMessagePatch (V4). Каждый элемент списка представлен структурой DocumentToPatch с полями:

  • Contents — список содержимого документов, которые нужно подготовить к подписанию и отправке. Отправить документы можно с помощью метода PostMessage (V3). Каждый элемент списка представлен структурой ContentToPatch с полями:

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

    • Function — функция документа.

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

    • Content — содержимое документа, представленное структурой UnsignedContent.

    • ToBoxId — идентификатор ящика, в который нужно отправить документ. Если значение не указано, используется идентификатор ящика получателя из документа.

    • Signer — информация о подписанте документа в упрощенном формате, представленная структурой Signer. Упрощенный формат устарел и больше не используется. Применялся при подписании документов в форматах приказов №93 и 172.

    • ExtendedSigner — информация о подписанте документа в расширенном формате, представленная структурой ExtendedSigner. Если у документа больше одного подписанта, вернется ошибка 400 (Bad Request). Используется для документов в форматах приказов №551, 552 и 736.

    • SignerContent — бинарное представление упрощенного XML-файла подписанта. Инструкция о формировании файла подписанта приведена в разделе Универсальный формат заполнения данных подписанта.

См. также

Структура используется: