DocuSign API - 自定义字段

时间:2014-09-09 10:47:27

标签: vb.net docusignapi

我在Visual Studio Project(VB.NET)中使用他们的REST API使用DocuSign。

我已经在界面中成功创建了一个模板,然后使用API​​将其发送给用户。这功能正常。

我们在页面上设置了名字,姓氏,电子邮件地址,公司和签名标签。我们可以使用XML文档获取FirstName,Last Name,EMail Address。

  Dim requestBody As String = "<envelopeDefinition xmlns=""http://www.docusign.com/restapi"">" & "<status>sent</status>" & "<emailSubject>DocuSign API - Signature Request from Template</emailSubject>" & "<templateId>" & templateId & "</templateId>" & "<templateRoles>" & _
           "<templateRole>" & "<name>" & recipientName & "</name>" & "<email>" & recipientEmail & "</email>" & "<roleName>" & "User" & "</roleName>" & "</templateRole>" 

但是我不能让公司的财产通过?我不知道这会通过哪里?

接下来,如何使用自定义字段实现相同的解决方案。我创造了一个 - 标签:Custom2 类型:注意 所有其他字段都是默认的。 但我不确定如何使用API​​预先填充这些值?

谢谢, 亚历

1 个答案:

答案 0 :(得分:0)

要在使用模板创建信封时使用API​​请求指定选项卡值,您需要在API请求中使用 compositeTemplates 结构。

例如,以下请求使用指定的DocuSign模板创建一个信封,该模板包含单个收件人(Role = User )和该收件人的3个选项卡:a < em>公司标签,标签= UserCompany 注意标签,标签= Custom2 ,以及标签= PhoneNumber 文字标签。该请求为每个标签指定(预填充信封中的每个字段)。

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

<envelopeDefinition xmlns="http://www.docusign.com/restapi">
   <accountId>ACCOUNT_ID_HERE</accountId>
   <status>sent</status>
   <compositeTemplates>
    <compositeTemplate>
        <serverTemplates>
            <serverTemplate>
                <sequence>1</sequence>
                <templateId>TEMPLATE_ID_HERE</templateId>
            </serverTemplate>
        </serverTemplates>
        <inlineTemplates>
            <inlineTemplate>
                <sequence>2</sequence>
                <recipients>
                    <signers>
                        <signer>
                             <email>johnsemail@outlook.com</email>
                             <name>John Doe</name>
                             <roleName>User</roleName>
                             <recipientId>1</recipientId>
                             <tabs>
                                <companyTabs>
                                    <company>
                                        <tabLabel>UserCompany</tabLabel>
                                        <value>ABC Widgets</value>
                                    </company>
                                </companyTabs>
                                <noteTabs>
                                    <note>
                                        <tabLabel>Custom2</tabLabel>
                                        <value>This is the note!</value>
                                    </note>
                                </noteTabs>                             
                                <textTabs>
                                    <text>
                                        <tabLabel>PhoneNumber</tabLabel>
                                        <value>111-222-3333</value>
                                    </text>
                                </textTabs>
                            </tabs>
                        </signer>
                  </signers>
               </recipients>
            </inlineTemplate>
        </inlineTemplates>
    </compositeTemplate>
  </compositeTemplates>
</envelopeDefinition>

由于您使用的是XML格式,因此您会发现此文档非常有用 - &gt; https://www.docusign.net/restapi/help。该页面显示了所有请求的XML格式(而DocuSign REST API Guide主要包含JSON格式的请求/响应)。

注意:尽管上面的示例要求与DocuSign的文档一致,但由于某些原因,公司标签在今天的(有限的)测试中没有成功预填充。如果您遇到同样的问题,那么解决方法就是使用&#34; 数据字段&#34;选项卡(即文本标签)收集/存储&#34;公司&#34;在DocuSign模板中(而不是使用&#34; 公司&#34;标签),然后您可以在API请求中使用TextTab填充该字段(就像上面的示例所做的那样) PhoneNumber字段)。