Docusign:带标签的复合模板

时间:2015-11-25 15:34:12

标签: docusignapi docusigncompositetmplts

如何在创建信封时使用复合模板指定预填充字段。

我尝试在inlineTemplate.recipients.signers[0].tabs中添加标签信息,但收到错误System.String cannot be cast to API_REST.Models.v2.tabs

如果我在templateRoles中将信息作为模板角色包含在内,则会被忽略。该文档详细介绍了有关如何执行此操作的信息。看起来应该在内联模板中指定预填充数据。

我提出的其他开放性问题包括recipientId做了什么。 clientUserId用于什么?我们目前将clientUserId设置为所有签名者的相同值。我看到当签名者请求签名时使用它。它是否应该由于某种原因而对每个签名者都是唯一的?

它看起来像是一个复合模板,它将服务器和内联模板叠加在一起。在单个复合模板中使用多个服务器模板或多个内联模板的用例是什么?

是否计划改进文档以描述如何将复合模板用于各种目的?

签名者/模板角色:

{
  "clientUserId": "clientUserId",
  "email": "first+last@email.com",
  "name": "First Last",
  "roleName": "role1",
  "tabs": {
    "textTabs": [
      {
        "locked": true,
        "tabLabel": "\\*FieldName",
        "value": "prefillValue"
      }
    ]
  }
}

示例请求:

{
  "compositeTemplates": [
    {
      "inlineTemplates": [
        {
          "recipients": {
            "signers": [
              {
                "clientUserId": "clientUserId",
                "email": "first+last@email.com",
                "name": "First Last",
                "recipientId": 1,
                "roleName": "role1",
                "tabs": {
                  "textTabs": [{"tabLabel": "label", "value": "val"}]
                }
              }
            ]
          },
          "sequence": 1
        }
      ],
      "serverTemplates": [
        {
          "sequence": 1,
          "templateId": "templateId1"
        }
      ]
    },
    {
      "inlineTemplates": [
        {
          "recipients": {
            "signers": [
              {
                "clientUserId": "clientUserId",
                "email": "first+last@better.com",
                "name": "First Last",
                "recipientId": 1,
                "roleName": "role1",
                "tabs": {
                  "textTabs": [{"tabLabel": "label", "value": "val"}]
                }
              }
            ]
          },
          "sequence": 2
        }
      ],
      "serverTemplates": [
        {
          "sequence": 2,
          "templateId": "templateId2"
        }
      ]
    }
  ],
  "emailSubject": "Email subject",
  "status": "sent",
  "templateId": null,
  "templateRoles": null
}

1 个答案:

答案 0 :(得分:0)

可以找到有关从服务器模板发送信封的信息here.

tab元素使用RecipientID来指示哪个收件人要签署Document,而clientuserID指定用户是否为remote or embedded,并且建议每个签名者都是唯一的(但不是必需的)。

我还建议阅读有关复合模板的this page,希望这个概念会更有意义,但我和你在一起,缺乏复合模板的文档可能很麻烦。

不幸的是,我没有包含标签数据的示例,但是从下面的示例中添加每个收件人下的标签部分应该没有问题。

{
  "emailSubject": "DocuSign Comp Test 1",
  "emailBlurb": "Example - Composite Templates",
  "status": "sent",
  "compositeTemplates": [
    {
      "serverTemplates": [
        {
          "sequence": "1",
          "templateId": "templateId1"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "1",
          "recipients": {
            "signers": [
              {
                "email": "testsigner123@gmail.com",
                "name": "Test Tester",
                "recipientId": "1",
                "roleName": "Signer 1"
              }
            ]
          }
        }
      ]
    },
    {
      "serverTemplates": [
        {
          "sequence": "2",
          "templateId": "templateId2"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "2",
          "recipients": {
            "signers": [
              {
                "email": "testsigner123@gmail.com",
                "name": "Test Tester",
                "recipientId": "1",
                "roleName": "Signer 1"
              }
            ]
          }
        }
      ]
    },
    {    
      "serverTemplates": [
        {
          "sequence": "3",
          "templateId": "templateId3"
        }
      ],
      "inlineTemplates": [
        {
          "sequence": "2",
          "recipients": {
            "signers": [
              {
                "email": "testsigner123@gmail.com",
                "name": "Test Tester",
                "recipientId": "1",
                "roleName": "Signer 1"
              }
            ]
          }
        }
      ]
    }
  ]
}