【问题标题】:Is it possible to retrieve entered tag values from a signed DocuSign document是否可以从签名的 DocuSign 文档中检索输入的标签值
【发布时间】:2014-07-23 08:01:29
【问题描述】:

我正在使用 DocuSign REST API 为使用 /envelopes/{envelopeID}/views/recipient 调用的预定义文档模板创建嵌入式签名。我知道可以在创建信封时预先填充标签值,但是是否可以在签名完成后检索收件人在给定标签字段中实际提供的值以供在应用程序中使用?如果有,有没有人举个例子?

【问题讨论】:

  • 我不是要求推荐工具。我正在尝试弄清楚如何使用 DocuSign API 从签名文档中检索信息。
  • 似乎是一个合法的问题。Opp 想知道如何通过 DocuSign API 获取特定信息,而不是使用外部工具。我想你只是看错了

标签: docusignapi


【解决方案1】:

听起来您正在尝试使用可选查询 include_tabs 获取信封收件人状态

https://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf 第 133 页

示例请求

GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId
    }/recipients/?include_tabs=true

X-DocuSign-Authentication:
<DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><Integrato
rKey>{integrator_key}</IntegratorKey></DocuSignCredentials>
Accept: application/json
Content-Type: application/json

回应

响应返回收件人类型和当前路由顺序。收件人类型包括 收件人姓名、电子邮件、ID、收件人类型、路由顺序、身份验证状态(包括日期/时间 和认证结果)状态(包括状态变化的日期/时间),如果 收件人状态为拒绝且需要原因,收件人添加的拒绝原因。如果 可选查询 include_tabs 设置为 true,则 返回与收件人关联的选项卡。

以下示例显示响应 json 正文

示例响应

{
  "signers": [
    {
      "tabs": {
        "textTabs": [
          {
            "height": 11,
            "name": "Text",
            "value": "this is  a test",
            "width": 66,
            "required": "false",
            "locked": "false",
            "disableAutoSize": "false",
            "tabLabel": "TAB1",
            "documentId": "1",
            "recipientId": "ed0e8744-6243-4708-9186-0e3ccf4cb3a4",
            "pageNumber": "1",
            "xPosition": "93",
            "yPosition": "142",
            "tabId": "2c7b4d94-d958-44df-b5a7-2b530ce914ed"
          }

【讨论】:

  • 这正是我想要的。我相信 UI 和 API 之间这些字段的名称不一致会引起混淆。在 UI 中,它们到处都被称为“标签”,但在 API 中,它们似乎被称为“标签”
【解决方案2】:

是的,至少有几种方法可以从已签名(已完成)的文档中检索选项卡值。我相信贾斯汀的回答是一种方式。您还可以使用 Get Tab Information for a Recipient API 调用,这将返回标签信息(包括值):

网址:

  • /accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

方法:

  • 获取

来自 DocuSign API Docs 的示例:

    GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs

    X-DocuSign-Authentication: <DocuSignCredentials><Username>{name}</Username><Password>{password}</Password><IntegratorKey>{integrator_key}</IntegratorKey></DocuSignCredentials>
    Accept: application/json
    Content-Type: application/json

示例响应:

    {
      "approveTabs":[{
        <Tab information removed>
      }],
      "textTabs":[{
        <Tab information removed>
      }],
      "signHereTabs":[{
        ...
     }]
    }

【讨论】:

  • 如果您正在寻找来自特定收件人的信息,这也是一个很好的答案。不过,在我的具体情况下,我使用的是嵌入式签名,我从不设置收件人 ID。不过,这里为其他人提供了很好的信息。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多