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



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

是的,有一种方法可以获取文档表单字段的值,这记录在 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={真或假},include_extended={真或假}

格式

XML, JSON

HTTP 方法

GET

参数:

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


例如,如果您有一个完整的信封,信封上有一个 textTab(数据字段)表单字段,名为 DataField1 您使用附加到 URL 的可选 URL 参数进行上述调用?include_tabs=true,则在返回的其他数据中,您将对 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"
      }

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

最新更新