docusignapi - 如何使用 Docusign RestAPI 检索文档的 XML 表单数据

Question

您好，如何使用 Docusign RestAPI 检索文档的 XML 表单数据。

Answer 1

是的，有一种方法可以获取文档表单字段的值，这在REST API 指南 (v2)中有记录，还有一个DocuSign API 演练已经演示了如何进行调用，尽管它不包括可选查询您必须添加的“include_tabs”参数。你要的电话是——

获取信封收件人状态

This returns the status for all recipients of a single envelope and identifies the current routing order. The current routing order is a number that matches up to the routingOrder for envelope recipients, which shows that the envelope has been sent to a recipient, but the recipient has not completed their actions.

网址：

/accounts/{accountId}/envelopes/{envelopeId}/recipients

可选查询项：include_tabs={true or false}, include_extended={true or false}

格式：

XML, JSON

HTTP方法：

GET

参数：

唯一需要的参数是信封 ID。如果可选查询 include_tabs 设置为 true，则返回与收件人关联的选项卡。如果可选查询 include_extended 设置为 true，则返回扩展属性。

---

例如，如果您有一个完整的信封，在被调用的信封上有一个 textTab（数据字段）表单字段，那么您在进行DataField1上述调用时将可选的 URL 参数?include_tabs=true附加到 URL 中，在返回的其他数据中，您将有类似的东西对于 textTab 和它的值：

"textTabs": [
      {
        "height": 11,
        "validationPattern": "",
        "validationMessage": "",
        "shared": "false",
        "requireInitialOnSharedChange": "false",
        "name": "Text",
        "value": "data goes here",
        "width": 108,
        "required": "true",
        "locked": "false",
        "concealValueOnDocument": "false",
        "disableAutoSize": "false",
        "tabLabel": "DataField1",
        "bold": "false",
        "italic": "false",
        "underline": "false",
        "documentId": "1",
        "recipientId": "6c8377fc-ff4e-45ba-b7f7-c7b9b168471c",
        "pageNumber": "1",
        "xPosition": "202",
        "yPosition": "71",
        "tabId": "936c9ab6-f8b3-42e0-8870-52a024788319"
      }

然后，您可以解析有关您需要的选项卡的任何信息，例如值、名称等。