DocuSign：必填复选框

Question

我正在尝试在 docusign 中创建一个信封，该复选框是强制性的。我试图通过使用选项卡组选项卡来应用它。以下是我的要求。我能够创建文档，但复选框仍然是可选的。我不确定可能请求有什么问题：请检查。谢谢。

{
    "documents":[
            {
                "documentBase64":"<pdffile>",
                "documentId":"1",
                "fileExtension":"pdf",
                "name":"Document_Name"
            }
        ],
    "emailSubject":"Some Email Subject",
    "recipients":{
        "signers":[
            {
                "email":"some.user@gmail.com",
                "name":"Some People",
                "recipientId":"4250",
                "routingOrder":"1",
                "tabs":{
                    "signHereTabs":[
                        {
                            "anchorString":"PLEASE SIGN HERE",
                            "anchorXOffset":"0",
                            "anchorYOffset":"1.5",
                            "anchorUnits":"cms"
                        }
                    ],
                    "checkboxTabs":[
                        {
                            "tabLabel":"checkbox1",
                            "selected":"false",
                            "required":"false",
                            "documentId":"1",
                            "recipientId":"1",
                            "anchorString":"[x]",
                            "anchorXOffset":"0",
                            "anchorYOffset":"0",
                            "anchorUnits":"cms",
                            "tabGroupLabels":["Checkbox Group"]
                        },
                        {
                            "tabLabel":"checkbox2",
                            "selected":"false",
                            "required":"false",
                            "documentId":"1",
                            "recipientId":"1",
                            "anchorString":"[x]",
                            "anchorXOffset":"0",
                            "anchorYOffset":"1",
                            "anchorUnits":"cms",
                            "tabGroupLabels":["Checkbox Group"]
                        }
                    ],
                    "tabGroups":[
                        {
                            "recipientId":"1",
                            "tabLabel":"Check Boxes",
                            "groupLabel":"Checkbox Group",
                            "groupRule":"SelectAtMost",
                            "maximumAllowed" :"1",
                            "minimumRequired":"0",
                            "validationMessage":"Please check a box",
                            "tabScope":"Document",
                            "locked":"false"
                        }
                    ]
                }
            }
        ]
    },
    "status":"sent"
}

更新：

我在我的请求中尝试了这个，但复选框仍然是可选的。

"tabs":{
    "signHereTabs":[
        {
            "anchorString":"PLEASE SIGN HERE",
            "anchorXOffset":"0",
            "anchorYOffset":"1.5",
            "anchorUnits":"cms"
        }
    ],
    "checkboxTabs":[
        {
            "anchorString":"[x]",
            "anchorXOffset":"0",
            "anchorYOffset":"0",
            "anchorUnits":"cms",
            "tabGroupLabels":[
                "Checkbox Group"
            ]
        }
    ],
    "tabGroups":[
        {
            "groupLabel":"Checkbox Group",
            "groupRule":"SelectAtLeast",
            "maximumAllowed":"1",
            "minimumRequired":"1",
            "validationMessage":"Please check a box",
            "tabScope":"document"
        }
    ]
}

我使用的是 2.1 版，/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

提前致谢。

Answer 1

复选框的 required 属性不适用。而是为一个或多个复选框创建一个 tabGroup。这样你就可以要求选中复选框，或者要求选中多个复选框之一，等等。

示例：需要一个复选框

{
    "emailSubject": "Please sign the attached document",
    "status": "sent",
    "documents": [
      {
        "documentBase64":"<pdffile>",
        "name": "Example document",
        "fileExtension": "pdf",
        "documentId": "1"
      }
    ],
    "recipients": {
      "signers": [
        {
          "email": "signer_email@example.com",
          "name": "Signer's name",
          "recipientId": "1",
          "clientUserId": "1000",
          "tabs": {
            "signHereTabs": [
              {
                "anchorString": "/sig1/",
                "anchorXOffset": "20",
                "anchorUnits": "pixels"
              }
            ],
            "checkboxTabs": [
              {
                "anchorString": "/sig1/",
                "anchorXOffset": "180",
                "anchorUnits": "pixels",
                "tabGroupLabels": [
                  "checkbox group"
                ]
              }
            ],
            "tabGroups": [
              {
                "groupLabel": "checkbox group",
                "groupRule": "SelectAtLeast",
                "minimumRequired": "1",
                "maximumAllowed": "1",
                "validationMessage": "Please check to indicate your agreement",
                "tabScope": "document",
                "pageNumber": "1",
                "documentId": "1"
              }
            ]
          }
        }
      ]
    }
}

Answer 2

在我的例子中，我有一个类似于 EULA 的复选框，上面写着类似 'Check this box to agree to the above' 的内容，然后是一个签名。

要求是他们不能 'finish' 文档，除非他们选中了复选框。

虽然所选答案有效，但它很复杂，需要您指定 document_id 和 page_number 才能有效。我使用 tab_scope = 'envelope' 尝试了许多其他组合，但它只是忽略了选项卡组。此外，tab_group 周围的标签和验证消息让 end-users 感到困惑。最后，我认为这只是“工作的错误工具”

相反，我使用了 'Approved' 选项卡，但为 'button_text' 提供了一个 space，然后设置高度和宽度。

他们将无法完成文档，除非他们单击批准 'button'，当以这种方式配置时，该批准将作为复选框呈现给用户。

我的信封定义最终看起来像这样：

{
"emailSubject": "Please sign the attached document",
"status": "sent",
"documents": [
  {
    "documentBase64":"<pdffile>",
    "name": "Example document",
    "fileExtension": "pdf",
    "documentId": "1"
  }
],
"recipients": {
  "signers": [
    {
      "email": "signer_email@example.com",
      "name": "Signer's name",
      "recipientId": "1",
      "clientUserId": "1000",
      "tabs": {
        "signHereTabs": [
          {
            "anchorString": "/sig1/",
            "anchorXOffset": "20",
            "anchorUnits": "pixels"
          }
        ],
        "approveTabs": [
          {
            "anchorString": "/app1/",
            "anchorXOffset": "0",
            "anchorUnits": "pixels",
            "buttonText": " ", #if you don't put a space, it defaults back to 'Approve' for button_text
            "width": 18,
            "height": 18
          }
        ]
      }
    }
  ]
}

}

DocuSign：必填复选框

DocuSign: Required checkbox

docusignapi

示例：需要一个复选框