首页 文章

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

提问于
浏览 次
1

我有以下情况：

  • 发件人“ S”通过 API 为收件人 1“ R1”和收件人 2“ R2”创建信封。

  • R1 和 R2 签名，并且信封“ E1”完成。

  • 系统中的某些条件发生了变化，这导致 S 向 R1 和 R2 发送新的信封，其中当然包含更新的文档。

  • R1 和 R2 签名，第二个信封“ E2”完成。

在这种情况下，E2 应该弃用甚至删除 E1。问题在于，R2 需要检查他已经签署的所有文档，这很困惑，在 Completed 文件夹中同时包含 E1 和 E2。

据我所知，不可能完成信封。理想情况下，我想找到一种方法，使 S 将 E2 移动到 R2 帐户上的回收站。

docusignapi

1 回答

  • 1

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

    更新(示例)

    方案 1：

    • S1(发件人)将信封发送给 1 个收件人-R1(收件人#1)。

    • S1 和 R1 都是 SAME DocuSign 帐户内的成员。 (“ API 用户”(即 i.e.，即所有 API 请求的“身份验证”用户，也是同一 Docusign 帐户的成员.如果在您的情况下，“发件人”充当“在所有 API 请求中都对“用户”进行身份验证，那么对于“ API 用户” .)，您不一定需要单独的 user/membership

    • R1 在信封上签名。 (信封现在为 Complete.)

    操作 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标头中：

    • “正在验证”用户的凭据(Username，Password)对应于该帐户中具有 Account-wide-API-rights 的用户。

    • SendOnBehalfOf的值对应于同一 DocuSign 帐户中发件人的会员电子邮件地址，并指定要对其执行操作的帐户。

    • 如果在 API 请求中将发件人的凭据用作“身份验证”用户，则无需在X-DocuSign-Authentication标头中包括SendOnBehalfOf属性。

    **结果：**当 S1 登录到 DocuSign Web 控制台时，他看到信封现在位于他的“已删除”文件夹中。

    操作 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标头中：

    • “身份验证”用户的凭据(Username，Password)再次对应于该帐户中具有 Account-wide-API-rights 的用户。

    • SendOnBehalfOf的值对应于同一 DocuSign 帐户中收件人的会员电子邮件地址，并指定要对其执行操作的帐户。

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

    注意：如上所述，“移动(删除)信封”操作中最关键的部分是每个 API 请求的“身份验证”用户(*中的Username和Password * X-DocuSign-Authentication 标头)必须是 SAME DocuSign 帐户的成员，因为要对其帐户执行操作的用户(i.e.，与X-DocuSign-Authentication标头中的SendOnBehalfOf**相对应的成员资格)。

    回复于

相关问题