DocuSign REST api取消组标签

时间:2017-07-27 17:57:40

标签: salesforce docusignapi

我需要取消组合在“草稿”状态下创建的信封中的标签,这样如果我在一个页面上移动一个SignHere标签位置,则所有其他SignHere都不会移动。我做了一个GET请求获取标签然后PUT更新标签,通信成功,但标签没有被取消组合。

遵循的步骤:

获取收件人的标签

GET restapi/v2/accounts/{accountId}/envelopes/envelopeId/recipients/1/tabs

响应返回:

{
  "anchorString": "SIGNHERE",
  "anchorUnits": "pixels",
  "anchorXOffset": "0",
  "anchorYoffset": "0",
  "DocumentId": "1",
  "Name": "SignHere",
  "optional": "false",
  "pageNumber": "2",
  "RecipientId": "1",
  "TabLabel": "Sign Here",
  "xPosition": "63",
  "yPosition": "260"
}
  • 迭代SignHereTabs,将anchorString更新为空字符串

  • 使用更新标签作为请求正文,并将recipientId和EnvelopeId作为参数使用PUT请求。

  

PUT / v2 / accounts / accountId / envelopes / envelopeId / recipients / recipientId / tabs

请求正文:

{
  "signHereTabs": [
    {
      "yPosition": "260",
      "xPosition": "63",
      "width": null,
      "TabLabel": "Sign Here",
      "tabid": "37dac2a5-c5fa-4726-b28a-3ec7af7e4189",
      "ScaleValue": "1.0",
      "required": null,
      "RecipientId": "1",
      "optional": "false",
      "Name": "SignHere",
      "fontSize": null,
      "font": null,
      "DocumentId": "1",
      "anchorYoffset": "0",
      "anchorXOffset": "0",
      "anchorUnits": "pixels",
      "anchorString": "",
      "anchorIgnoreIfNotPresent": null
    }
  ]
}

我收回成功响应System.HttpResponse [Status = OK,StatusCode = 200]

但是在打开的发件人视图中,我看到SignHere选项卡所有选项卡仅在第二页而不是所有页面上都是UN-Grouped。在GET请求中,我看到我得到了响应的页面号“2”,这是16页文档中第一次出现'SignHere'。我删除了PUT请求体中的pageNumber属性,这没有帮助。有没有办法将ungroup应用到所有页面?或者如何获取文档中所有页面的signhere选项卡响应?

1 个答案:

答案 0 :(得分:1)

您只是更新标签的单个实例。因此只有一个Tab被取消组合。相反,您应该更新所有Tab实例

第一步:检索所有锚点选项卡位置

使用listRecipientTabs api检索收件人的标签。指定查询字符串参数include_anchor_tab_locations=true以检索所有锚标签位置。

  

GET / v2 / accounts / {accId} / envelope / {envId} / recipients / {recipId} / tabs? include_anchor_tab_locations = true

第二步:将所有锚标签实例更新为取消组合

使用updateRecipientTabs api为所有标签实例设置anchorString=''。 PUT调用中可以排除其他选项卡属性。

  

PUT / v2 / accounts / {accountId} / envelope / {envelopeId} / recipients / {recipientId} / tabs

{
  "signHereTabs": [
    {
      "anchorString": "",
      "tabid": "37dac2a5-c5fa-4726-b28a-3ec7af7e4189"
    },
    {
      "anchorString": "",
      "tabid": "<Specify Tab Id here>"
    },
    {
      "anchorString": "",
      "tabid": "<Specify Tab Id here>"
    } 
  ]
}

有关使用C#sdk取消组合标签的信息,请参阅此answer