DocuSign:必填复选框

问题描述

我正尝试在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","recipientId":"1","anchorString":"[x]","anchorYOffset":"0","anchorUnits":"cms","tabGroupLabels":["CheckBox Group"]
                        },{
                            "tabLabel":"checkBox2","anchorYOffset":"1","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","anchorUnits":"cms"
        }
    ],"checkBoxTabs":[
        {
            "anchorString":"[x]","tabGroupLabels":[
                "CheckBox Group"
            ]
        }
    ],"tabGroups":[
        {
            "groupLabel":"CheckBox Group","groupRule":"SelectAtLeast","maximumAllowed":"1","minimumrequired":"1","tabScope":"document"
        }
    ]
}

我正在使用版本2.1,/ restapi / v2.1 / accounts / {accountId} / envelopes / {envelopeId} / documents / {documentId}

谢谢。

解决方法

复选框的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"
              }
            ]
          }
        }
      ]
    }
}