Docusign API: составные шаблоны - невозможно получить доступ к вкладкам из шаблонов сервера

В настоящее время я отправляю свой запрос на подпись в формате XML и ссылаюсь на руководство по REST API, а также на пример в Правилах использования составных шаблонов, и, хотя мне удалось успешно добавить дополнительные шаблоны серверов в соответствующей последовательности, безопасный вкладки в этих шаблонах не были доступны для редактирования; единственным шаблоном, который показал их, был "основной" шаблон (не включенный в объект составных шаблонов). На странице 104 в руководстве по API видно, что суть встроенных шаблонов заключается в расширении заявленных шаблонов сервера (добавление документов и т. Д.). Вот мой пример XML:

<envelopeDefinition xmlns=\"http://www.docusign.com/restapi\">
<accountId>#####</accountId>
<status>sent</status>
<emailSubject>testing 11/18 -3</emailSubject>
<emailBlurb>Email Blurb</emailBlurb>
<templateId>TEMPLATE ID 1</templateId>
<templateRoles>
<templateRole>
<email>insured@email.com</email>
<name>Insured Test</name>
<roleName>Signer</roleName>
</templateRole>
<templateRole>
<email>test@email.com</email>
<name>Test Agent</name>
<roleName>Agent</roleName>
</templateRole>
</templateRoles>
<compositeTemplates>
<compositeTemplate>
<serverTemplates>
<serverTemplate>
<sequence>1</sequence>
<templateId>TEMPLATE ID 2</templateId>
</serverTemplate>
</serverTemplates>
</compositeTemplate>
<compositeTemplate>
<serverTemplates>
<serverTemplate>
<sequence>2</sequence>
<templateId>TEMPLATE ID 3</templateId>
</serverTemplate>
</serverTemplates>
</compositeTemplate>
<compositeTemplate>
<serverTemplates>
<serverTemplate><sequence>3</sequence>
<templateId>TEMPLATE ID 4</templateId>
</serverTemplate></serverTemplates>
</compositeTemplate>
</compositeTemplates>
</envelopeDefinition>

По сути, мне нужно иметь возможность добавлять шаблоны серверов на основе параметров, выбранных пользователем, к основному.

РЕДАКТИРОВАТЬ: я предполагаю, что мне нужно было бы передать роли шаблона для каждого из последующих идентификаторов, но единственное место, чтобы передать это будет встроенный - который, как представляется, не подходит для этого варианта использования,

РЕДАКТИРОВАТЬ 2: Вот мое тело запроса с обновлениями. На этот раз я получаю INCOMPLETE_ENVELOPE.. Я запустил это с API Explorer и по какой-то причине, когда я добавил исходный идентификатор шаблона верхнего уровня и соответствующие роли, я не получил ошибку. При отправке обновленного XML я смог создать конверт, но добавленные составные шаблоны не были доступны для редактирования.

<envelopeDefinition xmlns=\"http://www.docusign.com/restapi\">
<accountId>1232456</accountId>
<status>sent</status>
<emailSubject>testing inline 11/18 -5</emailSubject>
<emailBlurb>This comes from me</emailBlurb>
<compositeTemplates>
<compositeTemplate>
<serverTemplates>
<serverTemplate>
<sequence>1</sequence>
<templateId>894ed334-4183-4b68-857e-01fe4829f79e</templateId>
</serverTemplate>
</serverTemplates>
<inlineTemplates>
<inlineTemplate>
<sequence>2</sequence>
<recipients>
<recipient>
<signers>
<signer>
<email>email@email.com</email>
<name>Test insured</name>
<roleName>Signer</roleName>
<recipientId>1</recipientId>
</signer>
<signer>
<email>test@gmail.com</email>
<name>Test Agent</name>
<roleName>Agent</roleName>
<recipientId>2</recipientId>
</signer>
</signers>
</recipient>
</recipients>
</inlineTemplate>
</inlineTemplates>
</compositeTemplate>
<compositeTemplate>
<serverTemplates>
<serverTemplate>
<sequence>3</sequence>
<templateId>d1c43bee-2c6b-4910-89f0-64e3fbcce19a</templateId>
</serverTemplate>
</serverTemplates>
<inlineTemplates>
<inlineTemplate>
<sequence>4</sequence>
<recipients>
<recipient>
<signers>
<signer>
<email>email@email.com</email>
<name>Test insured</name>
<roleName>Signer</roleName>
<recipientId>1</recipientId>
</signer>
<signer>
<email>test@gmail.com</email>
<name>Test Agent</name>
<roleName>Agent</roleName>
<recipientId>2</recipientId>
</signer>
</signers>
</recipient>
</recipients>
</inlineTemplate>
</inlineTemplates>
</compositeTemplate>
</compositeTemplates>
</envelopeDefinition>
Источник

1 ответ

Решение

Во-первых, я не уверен, что можно использовать составные шаблоны, а также указывать templateId и templateRoles на верхнем уровне запроса (т. Е. Вне коллекции Сборник шаблонов). Итак, мое первое предложение - изменить ваш запрос таким образом, чтобы все шаблоны (включая ваш первый) были указаны в коллекции Сборник шаблонов.

Далее, я подозреваю, что причина того, что ни одна из вкладок не видна в документах, представленных шаблонами, на которые вы ссылаетесь в коллекции Сборник шаблонов, заключается в том, что вы не предоставляете информацию о получателе для каждого шаблона. Как вы упомянули в "РЕДАКТИРОВАНИИ", это должно быть достигнуто с помощью inlineTemplate внутри каждого элемента CompositeTemplate. Например, следующий запрос с использованием InlineTemplate предоставляет информацию о получателях для роли Signer1 и роли Cc1, которую определяет шаблон сервера.

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes

<envelopeDefinition xmlns="http://www.docusign.com/restapi">
   <accountId>ACCOUNT_ID</accountId>
   <status>sent</status>
   <compositeTemplates>
    <compositeTemplate>
        <serverTemplates>
            <serverTemplate>
                <sequence>1</sequence>
              <templateId>3C9D42D3-3E76-4669-861E-9670415E1AD3</templateId>
            </serverTemplate>
        </serverTemplates>
        <inlineTemplates>
            <inlineTemplate>
                <sequence>2</sequence>
                <recipients>
                  <signers>
                    <signer>
                     <email>johnsemail@outlook.com</email>
                     <name>John Doe</name>
                     <recipientId>1</recipientId>
                     <roleName>Signer1</roleName>
                    </signer>
                  </signers>
                  <carbonCopies>
                    <carbonCopy>
                      <email>janesemail@outlook.com</email>
                      <name>Jane Doe</name>
                      <recipientId>2</recipientId>
                      <roleName>Cc1</roleName>
                    </carbonCopy>
                  </carbonCopies>
               </recipients>
            </inlineTemplate>
        </inlineTemplates>
    </compositeTemplate>
  </compositeTemplates>
</envelopeDefinition>

Если вы обновите свой запрос, чтобы включить информацию о получателях для каждого элемента CompositeTemplate (используя inlineTemplates, как я показал выше), я подозреваю, что вкладки в шаблонных документах должны быть назначены соответствующим получателям (согласно информации, которую вы предоставляете в каждый inlineTemplate).

РЕ "РЕДАКТИРОВАТЬ 2":

Что касается XML, который вы разместили в своем вопросе под заголовком "РЕДАКТИРОВАТЬ 2", удалите теги получателей, которые я выделил здесь - это должно привести к правильному запросу, который создает конверт с использованием указанного шаблона (шаблонов) и назначает теги соответствующим образом. получателям, которых вы указали в запросе.

введите описание изображения здесь

Источник
Другие вопросы по тегам