如何在 Server Template 和 Inline Template Docusign 中使用序列

Question

我在docusign中看到了这样的例子：

服务器模板和内联模板的每个复合模板具有相同的序列号 注意：

CompositeTemplate: ServerTemplate Sequence = 1
                   InlineTemplate Sequence = 1
CompositeTemplate: ServerTemplate Sequence = 2
                   InlineTemplate Sequence = 2

{
    "emailSubject": "DocuSign API - Composite Templates",
    "emailBlurb": "Composite Templates Sample 1",
    "status": "sent",
    "compositeTemplates": [{
        "serverTemplates": [{
            "sequence": "1",
            "templateId": "55A80182-2E9F-435D-9B16-FD1E1C0F9D74"
        }],
        "inlineTemplates": [{
            "sequence": "1",
            "recipients": {
                "signers": [{
                    "email": "johndoe@email.com",
                    "name": "John Doe",
                    "recipientId": "1",
                    "roleName": "Buyer"
                }]
            }
        }]
    }, {
        "serverTemplates": [{
            "sequence": "2",
            "templateId": "44D9E888-3D86-4186-8EE9-7071BC87A0DA"
        }],
        "inlineTemplates": [{
            "sequence": "2",
            "recipients": {
                "signers": [{
                    "email": "sallydoe@email.com",
                    "name": "Sally Doe",
                    "recipientId": "1",
                    "roleName": "Seller"
                }]
            }
        }]
    }]
}

但我也看到一些堆栈溢出以这种方式使用它：

多个Server Templates的序号相同，inline Templates是有区别的

CompositeTemplate: ServerTemplate Sequence = 1
                   InlineTemplate Sequence = 2
CompositeTemplate: ServerTemplate Sequence = 1
                   InlineTemplate Sequence = 2
    {
        "emailSubject": "DocuSign API - Composite Templates",
        "emailBlurb": "Composite Templates Sample 1",
        "status": "sent",
        "compositeTemplates": [{
            "serverTemplates": [{
                "sequence": "1",
                "templateId": "55A80182-2E9F-435D-9B16-FD1E1C0F9D74"
            }],
            "inlineTemplates": [{
                "sequence": "2",
                "recipients": {
                    "signers": [{
                        "email": "johndoe@email.com",
                        "name": "John Doe",
                        "recipientId": "1",
                        "roleName": "Buyer"
                    }]
                }
            }]
        }, {
            "serverTemplates": [{
                "sequence": "1",
                "templateId": "44D9E888-3D86-4186-8EE9-7071BC87A0DA"
            }],
            "inlineTemplates": [{
                "sequence": "2",
                "recipients": {
                    "signers": [{
                        "email": "sallydoe@email.com",
                        "name": "Sally Doe",
                        "recipientId": "1",
                        "roleName": "Seller"
                    }]
                }
            }]
        }]
    }

我尝试阅读docusign api doc，但仍然不确定何时使用每个场景

Answer 1

根据我的经验，您认为关于 sequence 属性的 DocuSign API 文档有些缺乏是正确的。也就是说，这里有一个指向（较旧的）API 文档页面的链接，该页面的描述与我在任何地方看到的一样好：https://www.docusign.com/p/APIGuide/Content/Sending%20Group/Rules%20for%20CompositeTemplate%20Usage.htm。

如本文档所述，复合模板结构中 sequence 属性的目的是指定您希望 DocuSign 在创建信封时应用您指定的模板（ServerTemplates、InlineTemplates 等）的顺序.就个人而言，我总是按照文档中的示例进行操作，并为请求正文中存在的模板中的序列指定增量值。在您的示例中，这意味着使用以下值：

CompositeTemplate: ServerTemplate Sequence = 1
                   InlineTemplate Sequence = 2
CompositeTemplate: ServerTemplate Sequence = 3
                   InlineTemplate Sequence = 4

Answer 2

一个复合模板的序号不影响其他复合模板的序号。这意味着，如果您有一个复合模板数组，则在数组的每个复合模板元素中定义的序列号独立于另一个复合模板中定义的序列号。

现在让我们进入每个复合模板，为了将文档添加到复合模板中，降低文档将成为该复合模板的基础文档的序列值。例如，

CompositeTemplate: ServerTemplate Sequence = 1
                   InlineTemplate Sequence = 2

在上面的场景中，这个复合模板的文档将由服务器模板提供，而在下面的场景中，

CompositeTemplate: ServerTemplate Sequence = 2
                   InlineTemplate Sequence = 1

文档将来自内联模板，它将覆盖服务器模板中存在的文档。

但是接收者信息的序号规则会发生变化。序列号较高的模板会将收件人信息添加到复合模板中。

所以简而言之，文档被添加到具有较低值的复合模板中，而接收者信息则被添加到具有较高值的​​组合模板中。

大多数情况下，您会看到复合模板的用法：

CompositeTemplate: ServerTemplate Sequence = 1
                   InlineTemplate Sequence = 2

在上述场景中，文档将从 ServerTemplate（序列值较低）添加，收件人信息将从 Inline Template（序列值较高）添加。