角色名称存储在哪里以及它的进一步用途是什么?

时间:2018-04-19 12:29:54

标签: docusignapi

我正在尝试使用REST API将基于模板的信封发送给多个收件人,我需要将TemplateRoles设置为向其他用户发送模板,但我需要将RoleName设置为每个模板角色条目。想知道创建信封后这个角色名称会在哪里使用?或者在设置TemplateRoles时是否需要juts?我在哪里可以看到信封内的角色名称?

对不起,对DocuSign来说是新手:)

谢谢。

1 个答案:

答案 0 :(得分:1)

DocuSign模板类似于蓝图或可重复使用的设计,可随时重复使用,以创建包含新收件人的新信封。在创建DocuSign模板时,您需要为收件人添加一些placeholders,这些占位符称为roleNames。现在,当您基于服务器模板创建新信封时,此时您将传递角色名称的收件人的实际值,如名称和电子邮件。例如,在您的服务器模板中,您创建了BuyerSeller等角色名称,服务器模板中使用的文档是卖家协议。现在,您希望一次又一次地为不同的卖家和买家重复使用模板,因此您将根据SellerBuyer roleNames将实际值放在信封中。

有关详细信息,请参阅Creating Templates

使用服务器模板的API示例如下所示,其中07a2484d-c144-4ad6-a218-85b96bcea4cb是servertemplateId,以下调用中的roleName应与服务器模板中存在的完全匹配,在此如果是SellerBuyer

{
    "compositeTemplates": [{
        "compositeTemplateId": "1",
        "inlineTemplates": [{
            "recipients": {
                "signers": [{
                    "email": "selleremail@email.com",
                    "name": "Seller Name",
                    "recipientId": "1",
                    "roleName": "Seller",
                },
                {
                    "email": "buyeremail@email.com",
                    "name": "Buyer Name",
                    "recipientId": "1",
                    "roleName": "Buyer",
                }]
            },
            "sequence": "2"
        }],
        "serverTemplates": [{
            "sequence": "1",
            "templateId": "07a2484d-c144-4ad6-a218-85b96bcea4cb"
        }]
    }],
    "emailSubject": "Test flow with Templates",
    "status": "sent"
}

我还会使用上面的Design模式,即CompositeTemplate来创建一个信封而不是TemplateRole设计模式,因为CompositeTemplate具有更大的灵活性,并且可以在将来轻松更改任何新的用例。