从signed_completed文档中获取选项卡值

时间:2015-03-06 18:50:30

标签: docusignapi

首先,DocuSign在文档中没有一致的标签名称。当您将PDF转换为DocuSign模板时,它们被称为"字段"您可以在其中输入值,例如文本框,单选按钮和复选框。

然后在DocuSign管理控制台中,DocuSign将它们列为标签或将其标记为标签。但是在API文档或调用中,DocuSign使用另一个关键字作为选项卡。

我的问题是如何从签名文档中获取所有选项卡值。有一个API调用来从草稿文档中获取选项卡值。它也适用于签名文档。但该API也基于收件人。

因此,如果文档有多个收件人,并且他们都可以更改一个选项卡。然后,一旦所有收件人签署了文档,我如何从最终文档中获取最终选项卡值。

关键是,无论有多少签名者,都应该只有一个最终文件。所以我不应该从每个收件人那里得到价值,并猜测谁的输入是最后一个。

1 个答案:

答案 0 :(得分:1)

是的,您可以进行单个API调用,以获取除草稿之外的给定完整信封中的所有选项卡值和信息。您需要向URI

发出 GET 请求
v2/accounts/:accountId/envelopes/:envelopeId/recipients

您需要包含可选的查询参数?include_tabs=true

例如,您的通话应如下所示:

GET https://demo.docusign.net/restapi/v2/accounts/...123456.../envelopes/...ABCDE.../recipients?include_tabs=true

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

包含2位收件人的已完成信封的示例回复:

{
  "signers": [
    {
      "tabs": {
        "signHereTabs": [
          {
            "name": "Signature",
            "tabLabel": "Signature 1",
            "scaleValue": 1,
            "optional": "false",
            "documentId": "1386280",
            "recipientId": "1822485",
            "pageNumber": "1",
            "xPosition": "88",
            "yPosition": "234",
            "tabId": "07e52952-304d-42d3-8ed2-347945e8a5bb"
          }
        ],
        "textTabs": [
          {
            "height": 22,
            "isPaymentAmount": "false",
            "validationPattern": "",
            "shared": "false",
            "requireInitialOnSharedChange": "false",
            "requireAll": "false",
            "name": "Text",
            "value": "recipient 1 text goes here",
            "width": 120,
            "required": "true",
            "locked": "false",
            "concealValueOnDocument": "false",
            "disableAutoSize": "false",
            "tabLabel": "DataField1",
            "font": "arial",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontColor": "black",
            "fontSize": "size9",
            "documentId": "1386280",
            "recipientId": "1822485",
            "pageNumber": "1",
            "xPosition": "160",
            "yPosition": "261",
            "tabId": "668c1395-ced9-4b17-8ee9-f495ecbf02cd"
          }
        ],
        "checkboxTabs": [
          {
            "name": "Checkbox",
            "tabLabel": "Checkbox 1",
            "selected": "true",
            "shared": "false",
            "requireInitialOnSharedChange": "false",
            "required": "true",
            "locked": "false",
            "documentId": "1386280",
            "recipientId": "1822485",
            "pageNumber": "1",
            "xPosition": "118",
            "yPosition": "298",
            "tabId": "c767ad9a-9ab9-464d-bf4b-4dbfd811fa98"
          }
        ]
      },
      "isBulkRecipient": "false",
      "name": "John Doe",
      "email": "john@test.com",
      "recipientId": "1822485",
      "recipientIdGuid": "5cb7641f-4009-4341-ab36-7d81074e3456",
      "requireIdLookup": "false",
      "userId": "346a8395-6a4a-4044-87a4-77586d038bf7",
      "routingOrder": "1",
      "status": "completed",
      "signedDateTime": "2015-03-23T19:39:39.6270000Z",
      "deliveredDateTime": "2015-03-23T19:39:14.7770000Z"
    },
    {
      "tabs": {
        "signHereTabs": [
          {
            "name": "Signature",
            "tabLabel": "Signature 2",
            "scaleValue": 1,
            "optional": "false",
            "documentId": "1386280",
            "recipientId": "1827039",
            "pageNumber": "1",
            "xPosition": "320",
            "yPosition": "234",
            "tabId": "dd733be4-6f07-4ab3-bc1f-6b46596e7faa"
          }
        ],
        "textTabs": [
          {
            "height": 22,
            "isPaymentAmount": "false",
            "validationPattern": "",
            "shared": "false",
            "requireInitialOnSharedChange": "false",
            "requireAll": "false",
            "name": "Text",
            "value": "Sally's text goes here",
            "width": 120,
            "required": "true",
            "locked": "false",
            "concealValueOnDocument": "false",
            "disableAutoSize": "false",
            "tabLabel": "DataField2",
            "font": "arial",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontColor": "black",
            "fontSize": "size9",
            "documentId": "1386280",
            "recipientId": "1827039",
            "pageNumber": "1",
            "xPosition": "445",
            "yPosition": "261",
            "tabId": "7e435666-255c-4a3c-8699-be71ab6f384b"
          }
        ],
        "listTabs": [
          {
            "listItems": [
              {
                "text": "foo",
                "value": "foo",
                "selected": "true"
              },
              {
                "text": "bar",
                "value": "bar",
                "selected": "false"
              }
            ],
            "value": "foo",
            "width": 100,
            "requireInitialOnSharedChange": "false",
            "required": "true",
            "locked": "false",
            "requireAll": "false",
            "tabLabel": "Drop Down 1",
            "font": "arial",
            "bold": "false",
            "italic": "false",
            "underline": "false",
            "fontColor": "black",
            "fontSize": "size9",
            "documentId": "1386280",
            "recipientId": "1827039",
            "pageNumber": "1",
            "xPosition": "320",
            "yPosition": "301",
            "tabId": "b845dde2-ba64-4905-8400-a7b795877ef2"
          }
        ]
      },
      "isBulkRecipient": "false",
      "name": "Sally Doe",
      "email": "sally@test.com",
      "recipientId": "1827039",
      "recipientIdGuid": "43617294-9b97-41c2-8b90-bac4f40a0b33",
      "requireIdLookup": "false",
      "userId": "346a8395-6a4a-4044-87a4-77586d038bf7",
      "routingOrder": "2",
      "status": "completed",
      "signedDateTime": "2015-03-23T19:40:43.6630000Z",
      "deliveredDateTime": "2015-03-23T19:40:20.4070000Z"
    }
  ],
  "agents": [],
  "editors": [],
  "intermediaries": [],
  "carbonCopies": [],
  "certifiedDeliveries": [],
  "inPersonSigners": [],
  "recipientCount": "2",
  "currentRoutingOrder": "1"
}

有关该调用的详细信息,请参阅REST API文档的THIS PAGE