2013-09-30 134 views
0

我有兴趣从模板中获取角色以正确填充角色并自动保持最新状态。获取模板角色(REST API)

是否有可能通过REST API获取?

还有“通过ID - v2/accounts /:accountId/templates /:templateId获取帐户模板”请求,但它似乎没有返回有关角色或收件人的有用信息。

回答

1

使用REST API,你可以通过简单地执行“GET信封收件人”的要求,在这里您代替信封标识的指定模板ID得到一个模板接受者角色名称。例如:?

GET https://demo.docusign.net/restapi/v2/accounts/ {帐户ID} /信封/ {templateId} /收件人include_tabs =假& include_extended =真

对此请求的响应将包含收件人的阵列为每个收件人类型的对象(即:签名者,代理人,编辑,中介机构,碳信用卡,认证的供应商,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" 
} 
+0

这是意想不到的,谢谢你。 – dgoncharenko

+0

@KimBrandl有什么方法可以获取API中模板列表的收件人数据,还是需要单独调用每个模板? – propagated

+1

使用REST API,您必须分别为每个模板请求收件人数据。不过,我相信通过SOAP API的“RequestTemplateList”操作,您可以在单个API请求中请求有关多个模板的数据。请参阅SOAP API指南(p213)上的“RequestTemplateList”操作信息(https://10226ec94e53f4ca538f-0035e62ac0d194a46695a3b225d72cc8.ssl.cf2.rackcdn.com/soap-api-guide.pdf)。 –