如何删除或弃用已完成的信封

时间:2013-12-18 16:35:30

标签: docusignapi

我有以下情况:

  • 发件人“S”通过API为Recipient1“R1”和Recipient2“R2”创建信封。
  • R1和R2签名,信封“E1”完成。
  • 系统中的某些条件发生变化,导致S向R1和R2发送新信封,当然包含更新的文档。
  • R1和R2签名,第二个信封“E2”完成。

在这种情况下,E2应该弃用甚至删除E1。问题在于R2需要检查他已经签署的所有文件,并且在完成文件夹中同时使用E1和E2会让人感到困惑。

据我所知,Voiding a Completed信封是不可能的。理想情况下,我想找到一种方法让S将E2移到R2帐户的回收站。

1 个答案:

答案 0 :(得分:1)

您应该可以使用“移动信封”操作来删除信封,如REST API指南(http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf)第174页中所述。根据指南对移动信封操作的说明:"This can be used to delete envelopes by using “recyclebin” as folderId."

更新(示例)

场景#1:

  • S1(发件人)将信封发送给1个收件人 - R1(收件人#1)。
  • S1和R1都是SAME DocuSign帐户中的成员。 (该 “API用户” - 即,用作“验证”用户的用户 对于所有API请求 - 也是同一Docusign的成员 帐户。如果在您的方案中“发件人”在所有API请求中充当“自动化”用户,则您不一定需要“API用户”的单独用户/成员资格。)
  • R1签署信封。 (信封现已完成。)

操作A:API请求将发件人的信封副本移动到其已删除文件夹。

PUT https://demo.docusign.net/restapi/v2/accounts/{{acctId}}/folders/recyclebin
X-DocuSign-Authentication: {"SendOnBehalfOf":"SenderS1_email@gmail.com","Username":"APIUser_email@outlook.com","Password":"APIUser_Password","IntegratorKey":"IntKey"}
{ 
 "envelopeIds": ["B547562E-5CFC-4989-913E-501CD88F1506"]
}

请注意,在请求的 X-DocuSign-Authentication 标题中:

  • “验证”用户的凭据(用户名密码) 对应于其中具有帐户范围API权限的用户 帐户。

  • SendOnBehalfOf 的值对应发件人的会员资格 同一个DocuSign帐户中的电子邮件地址,并指定 帐户要采取行动。

  • 如果发件人的凭据被用作“自动化” 用户在API请求中,那么您就不需要包含 X-DocuSign-Authentication 标题中的 SendOnBehalfOf 属性。

<强>结果: 当S1登录DocuSign Web控制台时,他发现Envelope现在位于他的“已删除”文件夹中。

操作B:API请求将收件人的信封副本移动到她的已删除文件夹。

PUT https://demo.docusign.net/restapi/v2/accounts/{{acctId}}/folders/recyclebin
X-DocuSign-Authentication: {"SendOnBehalfOf":"RecipientR1_email@gmail.com","Username":"APIUser_email@outlook.com","Password":"APIUser_Password","IntegratorKey":"IntKey"}
{ 
 "envelopeIds": ["B547562E-5CFC-4989-913E-501CD88F1506"]
}

请注意,在请求的 X-DocuSign-Authentication 标题中:

  • 再次验证“身份验证”用户的凭据(用户名密码) 对应于其中具有帐户范围API权限的用户 帐户。
  • SendOnBehalfOf 的值对应于同一DocuSign帐户中的收件人的会员电子邮件地址,并指定要操作的帐户。

<强>结果: 当R1登录DocuSign Web控制台时,她看到信封现在位于她的“已删除”文件夹中。

注意:上述“移动(删除)信封”操作中最关键的组件是每个API请求的“验证”用户(用户名 X-DocuSign-Authentication 标题中的密码必须是SAME DocuSign帐户的成员,因为正在对其帐户进行操作的用户(即,对应的成员资格) X-DocuSign-Authentication 标题中的 SendOnBehalfOf