Docusign收件人状态

时间:2013-09-23 17:15:44

标签: java xml api docusignapi

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

这是我正在寻找的一个例子。

文件xxxxxxxxx 收件人1已发送 收件人2签名mm / dd / yyyy 收件人3下降mm / dd / yyy

1 个答案:

答案 0 :(得分:2)

对DocuSign REST API“获取信封收件人状态”呼叫(GET / accounts / {accountId} / envelope / {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)Jimmy收到了信封的副本,作为Carbon Copy收件人(路由订单#3)。 4)安倍拒绝了信封(路由顺序#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。 )