Получить роли шаблона (REST API)

Я заинтересован в получении ролей из шаблонов, чтобы правильно их заполнять и автоматически обновлять.

Можно ли как-то получить это с помощью REST API?

Есть запрос «Получить шаблон учетной записи по идентификатору - v2 / accounts /: accountId / templates /: templateId», но он, похоже, возвращает мало полезной информации о ролях или получателях.


person dgoncharenko    schedule 30.09.2013    source источник


Ответы (1)


Используя REST API, вы можете получить имена ролей получателей для шаблона, просто выполнив запрос «GET Envelope Recipients», в котором вы указываете идентификатор шаблона вместо идентификатора конверта . Например:

ПОЛУЧИТЕ https://demo.docusign.net/restapi/v2/accounts/ { accountId} / envelopes / {templateId} / recipients? include_tabs = false & include_extended = true

Ответ на этот запрос будет содержать массив объектов получателей для каждого типа получателя (то есть: подписывающих лиц, агентов, редакторов, посредников, carbonCopies ,certedDeliveries, inPersonSigners); каждый объект-получатель будет содержать свойство roleName. Вот пример ответа для шаблона, который содержит 3 получателя - 2 подписавших и одного получателя CC:

{
    "signers": [
        {
            "signInEachLocation": "false",
            "name": "",
            "email": "",
            "recipientId": "5741ec70-b056-44eb-b462-eceee88ddf77",
            "requireSignerCertificate": "false",
            "requireIdLookup": "false",
            "routingOrder": "1",
            "roleName": "Signer 1",
            "status": "created",
            "templateLocked": "false",
            "templateRequired": "false"
        },
        {
            "signInEachLocation": "false",
            "name": "",
            "email": "",
            "recipientId": "c64d4567-2efd-422d-9b0a-a5427aa2512d",
            "requireSignerCertificate": "false",
            "requireIdLookup": "false",
            "routingOrder": "2",
            "roleName": "Signer 2",
            "status": "created",
            "templateLocked": "false",
            "templateRequired": "false"
        }
    ],
    "agents": [],
    "editors": [],
    "intermediaries": [],
    "carbonCopies": [
        {
            "name": "Legal Team",
            "email": "[email protected]",
            "recipientId": "a63e3714-adc2-4e05-b2c5-b3c3bbf50aa2",
            "requireIdLookup": "false",
            "routingOrder": "3",
            "roleName": "Legal Team",
            "status": "created",
            "templateLocked": "true",
            "templateRequired": "true"
        }
    ],
    "certifiedDeliveries": [],
    "inPersonSigners": [],
    "recipientCount": "3"
}
person Kim Brandl    schedule 30.09.2013
comment
@KimBrandl есть ли способ получить данные получателя для списка шаблонов в API, или мне нужно вызывать каждый шаблон индивидуально? - person propagated; 30.06.2014
comment
С помощью REST API вы должны запрашивать данные получателя для каждого шаблона отдельно. Однако я считаю, что с помощью операции RequestTemplateList SOAP API вы можете запрашивать данные о нескольких шаблонах в одном запросе API. См. Информацию о работе RequestTemplateList, начиная с p213, в руководстве по SOAP API (). - person Kim Brandl; 01.07.2014
comment
Спасибо @KimBrandl, я просто смирюсь с индивидуальными просьбами об отдыхе :) - person propagated; 01.07.2014