java - Docusign 收件人状态

Question

是否可以通过 API 获取 DocuSign 文档的每个收件人的状态？获取收件人状态的 xml/java 是什么？我用不同人的电子邮件发送信封，但是当我使用此处描述的过程时 http://iodocs.docusign.com/APIWalkthrough/getEnvelopeRecipientStatus似乎没有地方可以指定要检查哪个收件人的状态。

这就是我正在寻找的示例。

文档 xxxxxxxxx 收件人 1 已发送 收件人 2 于 年/月/日签署 收件人 3 于年/月/日拒绝

Answer 1

对 DocuSign REST API“获取信封收件人状态”调用 (GET/accounts/{accountId}/envelopes/{envelopeId}/recipients) 的响应将包含信封所有收件人的收件人状态信息。 DocuSign REST API 指南 ( http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf ) 第 145-146 页显示了请求和响应示例(JSON 格式)。

以下是有 4 个收件人的信封的示例响应正文: 1) Jane 签署/填写了信封(路由顺序#1)。 2) John 签署/填写了信封(路由顺序#2)。 3) 吉米作为抄送收件人收到了一份信封副本(路由顺序#3)。 4) Abe 拒绝了信封(路由顺序#4)。

{
"signers": [
    {
        "signInEachLocation": "false",
        "name": "Abe Miller",
        "email": "emailAbe@outlook.com",
        "recipientId": "ea3362b6-cf00-4797-8cfb-56ca09b988a8",
        "requireIdLookup": "false",
        "userId": "5b97e1be-3cea-49fb-a1c3-b77890b0b154",
        "routingOrder": "4",
        "status": "declined",
        "declinedDateTime": "2013-09-23T19:28:40.7670000Z",
        "declinedReason": "I don't want to sign."
    },
    {
        "signInEachLocation": "false",
        "name": "Jane Smith",
        "email": "emailJane@outlook.com",
        "recipientId": "54fb0d38-7c60-4d37-976a-6c72ea2ce32d",
        "requireIdLookup": "false",
        "userId": "17f820b1-f2a0-455a-88c2-e356a9c6914b",
        "routingOrder": "1",
        "status": "completed",
        "signedDateTime": "2013-09-23T19:27:54.2330000Z",
        "deliveredDateTime": "2013-09-23T19:27:49.9900000Z"
    },
    {
        "signInEachLocation": "false",
        "name": "John Doe",
        "email": "emailJohn@outlook.com",
        "recipientId": "78ef67bf-8795-4026-a57e-63ec960eb5a4",
        "requireIdLookup": "false",
        "userId": "03c8a856-c0ae-41bf-943d-ac6e92db66a8",
        "routingOrder": "2",
        "status": "completed",
        "signedDateTime": "2013-09-23T19:28:11.6900000Z",
        "deliveredDateTime": "2013-09-23T19:28:06.4170000Z"
    }
],
"agents": [],
"editors": [],
"intermediaries": [],
"carbonCopies": [
    {
        "name": "Jimmy Adams",
        "email": "emailJimmy@outlook.com",
        "recipientId": "afc51052-85e9-4575-8c06-b0f87c1a5d8b",
        "requireIdLookup": "false",
        "userId": "7a64f726-8985-490b-9e94-04e54292f53c",
        "routingOrder": "3",
        "status": "completed",
        "deliveredDateTime": "2013-09-23T19:28:21.3600000Z"
    }
],
"certifiedDeliveries": [],
"inPersonSigners": [],
"recipientCount": "4"
}

通过迭代响应中每种类型的收件人(签名者、代理、编辑、中介、carbonCopies、certifiedDeliveries、inPersonSigners)，您可以访问每个收件人的状态信息。

(注意:如果您使用 DocuSign REST API，我建议您考虑使用 JSON 而不是 XML。虽然 DocuSign REST API 技术上支持无论是 JSON 还是 XML，可用于将 XML 与 REST API 结合使用的文档都极其有限 - 通过使用 JSON 而不是 XML，您可以节省时间并减少挫败感，因为 DocuSign 生成的大多数代码示例和文档都是 JSON 格式的。 )