时间戳

首页 > 解决方案 > 从模板中检索文档

docusignapi - 从模板中检索文档

问题描述

我在我的 DocuSign 开发人员沙箱中创建了一个包含一个文档的模板。我正在使用 C# SDK 尝试根据模板向用户发送信封。

这是我检索所有模板的代码。

TemplatesApi templateApi = new TemplatesApi(ApiClient.Configuration);

         EnvelopeTemplateResults templateResults = templateApi.ListTemplates(AccountID);

我遇到的问题是EnvelopeTemplateResults 没有与之关联的任何文档。

当我使用 POSTMAN 使用 REST API，对这个 URL 执行 GET 时，我可以看到有一个信封TemplateDefinition，上面有一个 Document，这是我想要的。

我的问题是，如何使用 SDK API 获取信封模板定义？

标签： docusignapi

解决方案

为了让ListTemplates方法包含文档信息，您必须设置一个 Include 参数：

        var templatesApi = new TemplatesApi(apiClient.Configuration);
        var listTemplatesOptions = new TemplatesApi.ListTemplatesOptions { include = "documents" };
        var templateResults = templatesApi.ListTemplates(accountId, listTemplatesOptions);

如果您尝试获取单个模板的模板定义，则该templatesApi.Get()方法可以与它自己的一组包含选项一起使用：

        var getTemplateOptions = new TemplatesApi.GetOptions { include = "documents" };
        var templateDefinition = templatesApi.Get(accountId, templateId, getTemplateOptions);

最后，如果您尝试从特定模板中获取实际的 PDF，则可以采用以下templatesApi.GetDocument()方法：

templatesApi.GetDocument(accountId, templateId, documentId);

DocumentId 是您要提取的特定文档，如果您要将所有文档作为单个 PDF 提取，则为“组合”。

推荐阅读