Ответ на API DocuSign REST "Получить конверт Статус получателя" вызова (GET/accounts/{accountId}/envelopes/{envelopeId}/recipients) будет содержать информацию о статусе получателя для всех получателей конверта. В страницах 145-146 руководства по API-интерфейсу DocuSign REST (http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf) показан пример запроса и ответа (в формате JSON).
Вот образец тела ответа для конверта, который имеет 4 получателя: 1) Джейн подписала/завершила конверт (порядок маршрутизации № 1). 2) Джон подписал/завершил конверт (порядок маршрутизации № 2). 3) Джимми получил копию конверта в качестве получателя Carbon Copy (порядок маршрутизации №3). 4) Абэ отклонил конверт (порядок маршрутизации №4).
{
"signers": [
{
"signInEachLocation": "false",
"name": "Abe Miller",
"email": "[email protected]",
"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": "[email protected]",
"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": "[email protected]",
"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": "[email protected]",
"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), вы можете получить доступ к информации о состоянии каждого отдельного получателя.
(Примечание: если вы используете API DocuSign REST, я бы рекомендовал вам рассмотреть возможность использования JSON вместо XML Хотя DocuSign REST API технически поддерживает как JSON и XML, доступную документацию для. использование XML с REST API крайне ограничено - вы сэкономите свое время и разочарование, используя JSON вместо XML, поскольку большинство образцов кода и документации DocuSign производит в JSON.)