【问题标题】:Getting all tabs from a template using REST DocuSign API使用 REST DocuSign API 从模板中获取所有选项卡
【发布时间】:2013-11-28 02:29:35
【问题描述】:

我想知道使用 REST API 从模板中获取所有选项卡的最佳方法是什么。

我目前正在尝试做的是获取所有收件人及其所有选项卡,以便我们可以默认一些值以及在创建信封时锁定已填充值的字段。

  • 为了获取收件人,我使用 /envelopes/{templateId}/recipients。
  • 为了获得标签,我将遍历模板中的所有收件人,然后使用 /envelopes/{templateId}/recipients/{recipientId}/tabs。

我想知道这是否是最好的方法,因为我会尽可能多地调用 DocuSign,如果有更好的方法,我不想再打额外的电话。

谢谢。

【问题讨论】:

    标签: docusignapi


    【解决方案1】:

    实际上,有一种更简单的方法可以通过 REST API 获取模板的所有字段(选项卡)。只需进行以下(单个)调用:

    GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{templateId}}/recipients?include_tabs=true&include_extended=true
    

    成功的响应将包含每个收件人类型的模板收件人集合(即,signersagentscarbonCopies 等。 ) -- 并且任何这些集合中的每个收件人对象都将包含有关收件人选项卡的信息。例如,下面是包含两个签名者的模板的响应——每个签名者“拥有”多个不同类型的选项卡:

    {
        "signers": [
            {
                "tabs": {
                    "signHereTabs": [
                        {
                            "name": "Sign Here",
                            "tabLabel": "Signature 1",
                            "scaleValue": 1,
                            "optional": "false",
                            "documentId": "1",
                            "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7",
                            "pageNumber": "1",
                            "xPosition": "74",
                            "yPosition": "96",
                            "tabId": "bb7df562-665c-4f8d-8395-56f0c2f6accf"
                        }
                    ],
                    "textTabs": [
                        {
                            "height": 11,
                            "validationPattern": "",
                            "validationMessage": "",
                            "shared": "false",
                            "requireInitialOnSharedChange": "false",
                            "name": "Text",
                            "value": "",
                            "width": 42,
                            "required": "true",
                            "locked": "false",
                            "concealValueOnDocument": "false",
                            "disableAutoSize": "false",
                            "tabLabel": "address",
                            "bold": "false",
                            "italic": "false",
                            "underline": "false",
                            "documentId": "1",
                            "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7",
                            "pageNumber": "1",
                            "xPosition": "74",
                            "yPosition": "257",
                            "tabId": "451365aa-f066-45b9-aa58-4d7da60f3039"
                        }
                    ],
                    "radioGroupTabs": [
                        {
                            "documentId": "1",
                            "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7",
                            "groupName": "Radio Group 1",
                            "radios": [
                                {
                                    "pageNumber": "1",
                                    "xPosition": "185",
                                    "yPosition": "165",
                                    "value": "Radio 1",
                                    "selected": "false",
                                    "tabId": "25362e61-c421-466b-a13c-934bb3be0ac6",
                                    "required": "True",
                                    "locked": "False"
                                },
                                {
                                    "pageNumber": "1",
                                    "xPosition": "214",
                                    "yPosition": "165",
                                    "value": "Radio 2",
                                    "selected": "false",
                                    "tabId": "350f3efa-f2ba-4aaf-bd78-4b45dc475ee4",
                                    "required": "True",
                                    "locked": "False"
                                }
                            ]
                        }
                    ],
                    "listTabs": [
                        {
                            "listItems": [
                                {
                                    "text": "Married",
                                    "value": "M",
                                    "selected": "false"
                                },
                                {
                                    "text": "Single",
                                    "value": "S",
                                    "selected": "false"
                                },
                                {
                                    "text": "Divorced",
                                    "value": "D",
                                    "selected": "false"
                                },
                                {
                                    "text": "Widowed",
                                    "value": "W",
                                    "selected": "false"
                                }
                            ],
                            "value": "",
                            "width": 78,
                            "shared": "false",
                            "requireInitialOnSharedChange": "false",
                            "tabLabel": "MaritalStatus",
                            "bold": "false",
                            "italic": "false",
                            "underline": "false",
                            "documentId": "1",
                            "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7",
                            "pageNumber": "1",
                            "xPosition": "72",
                            "yPosition": "213",
                            "tabId": "b6e5b284-5c87-4a0c-9db5-e4d364ab1113"
                        }
                    ]
                },
                "signInEachLocation": "false",
                "name": "",
                "email": "",
                "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7",
                "recipientIdGuid": "f1b5d256-d85c-42d3-b081-913fb93e13a7",
                "requireIdLookup": "false",
                "routingOrder": "1",
                "roleName": "Signer1",
                "status": "created",
                "templateLocked": "false",
                "templateRequired": "false"
            },
            {
                "tabs": {
                    "signHereTabs": [
                        {
                            "name": "Sign Here",
                            "tabLabel": "Signature 8",
                            "scaleValue": 1,
                            "optional": "false",
                            "documentId": "1",
                            "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e",
                            "pageNumber": "1",
                            "xPosition": "354",
                            "yPosition": "88",
                            "tabId": "1e1829ef-005d-4277-b7af-8758cfdf186a"
                        }
                    ],
                    "fullNameTabs": [
                        {
                            "name": "Full Name",
                            "tabLabel": "Full Name",
                            "bold": "false",
                            "italic": "false",
                            "underline": "false",
                            "documentId": "1",
                            "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e",
                            "pageNumber": "1",
                            "xPosition": "354",
                            "yPosition": "183",
                            "tabId": "c33c0f3c-2f77-4985-b5b7-d538220a2f86"
                        }
                    ],
                    "textTabs": [
                        {
                            "height": 11,
                            "validationPattern": "",
                            "validationMessage": "",
                            "shared": "false",
                            "requireInitialOnSharedChange": "false",
                            "name": "Text",
                            "value": "",
                            "width": 42,
                            "required": "true",
                            "locked": "false",
                            "concealValueOnDocument": "false",
                            "disableAutoSize": "false",
                            "tabLabel": "Data Field 9",
                            "bold": "false",
                            "italic": "false",
                            "underline": "false",
                            "documentId": "1",
                            "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e",
                            "pageNumber": "1",
                            "xPosition": "354",
                            "yPosition": "156",
                            "tabId": "80e5a803-b1d4-4175-97b4-09c6125f3143"
                        }
                    ]
                },
                "signInEachLocation": "false",
                "name": "",
                "email": "",
                "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e",
                "recipientIdGuid": "79e8bc34-6a40-4cc5-90e1-e58d9707418e",
                "requireIdLookup": "false",
                "routingOrder": "2",
                "roleName": "Signer2",
                "status": "created",
                "templateLocked": "false",
                "templateRequired": "false"
            }
        ],
        "agents": [],
        "editors": [],
        "intermediaries": [],
        "carbonCopies": [],
        "certifiedDeliveries": [],
        "inPersonSigners": [],
        "recipientCount": "2"
    }
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2018-01-03
      • 2016-10-27
      • 1970-01-01
      • 1970-01-01
      • 2021-01-01
      • 2016-08-11
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多