Получение всех вкладок из шаблона с использованием REST DocuSign API

Question

Мне было интересно, как лучше всего получить все вкладки из шаблона с помощью REST API.

В настоящее время я пытаюсь получить все получатели и все их вкладки, чтобы мы могли по умолчанию использовать некоторые из значений, а также поля блокировки, которые заполняли значения при создании конверта.

• Чтобы получить получателей, я использую/конверты/{templateId}/получателей.
• Чтобы получить вкладки, я бы прошел через всех получателей в шаблоне (-ах), а затем я использовал/envelopes/{templateId}/recipients/{recipientId}/tabs.

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

спасибо.

Answer 1

На самом деле есть простой способ получить все поля (вкладки) для шаблона через API REST. Просто сделайте следующее (один) вызов:

GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{{templateId}}/recipients?include_tabs=true&include_extended=true 

Успешный ответ будет содержать коллекцию реципиентов шаблона для каждого типа получателя (т.е. подписанты, агенты, carbonCopies и т.д.) - - и каждый объект-получатель в любой из этих коллекций будет включать информацию о вкладках получателя. Например, вот ответ на шаблон, который содержит два подписывающих лица: каждый владеет несколькими вкладками различных типов:

{ 
    "signers": [ 
     { 
      "tabs": { 
       "signHereTabs": [ 
        { 
         "name": "Sign Here", 
         "tabLabel": "Signature 1", 
         "scaleValue": 1, 
         "optional": "false", 
         "documentId": "1", 
         "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7", 
         "pageNumber": "1", 
         "xPosition": "74", 
         "yPosition": "96", 
         "tabId": "bb7df562-665c-4f8d-8395-56f0c2f6accf" 
        } 
       ], 
       "textTabs": [ 
        { 
         "height": 11, 
         "validationPattern": "", 
         "validationMessage": "", 
         "shared": "false", 
         "requireInitialOnSharedChange": "false", 
         "name": "Text", 
         "value": "", 
         "width": 42, 
         "required": "true", 
         "locked": "false", 
         "concealValueOnDocument": "false", 
         "disableAutoSize": "false", 
         "tabLabel": "address", 
         "bold": "false", 
         "italic": "false", 
         "underline": "false", 
         "documentId": "1", 
         "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7", 
         "pageNumber": "1", 
         "xPosition": "74", 
         "yPosition": "257", 
         "tabId": "451365aa-f066-45b9-aa58-4d7da60f3039" 
        } 
       ], 
       "radioGroupTabs": [ 
        { 
         "documentId": "1", 
         "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7", 
         "groupName": "Radio Group 1", 
         "radios": [ 
          { 
           "pageNumber": "1", 
           "xPosition": "185", 
           "yPosition": "165", 
           "value": "Radio 1", 
           "selected": "false", 
           "tabId": "25362e61-c421-466b-a13c-934bb3be0ac6", 
           "required": "True", 
           "locked": "False" 
          }, 
          { 
           "pageNumber": "1", 
           "xPosition": "214", 
           "yPosition": "165", 
           "value": "Radio 2", 
           "selected": "false", 
           "tabId": "350f3efa-f2ba-4aaf-bd78-4b45dc475ee4", 
           "required": "True", 
           "locked": "False" 
          } 
         ] 
        } 
       ], 
       "listTabs": [ 
        { 
         "listItems": [ 
          { 
           "text": "Married", 
           "value": "M", 
           "selected": "false" 
          }, 
          { 
           "text": "Single", 
           "value": "S", 
           "selected": "false" 
          }, 
          { 
           "text": "Divorced", 
           "value": "D", 
           "selected": "false" 
          }, 
          { 
           "text": "Widowed", 
           "value": "W", 
           "selected": "false" 
          } 
         ], 
         "value": "", 
         "width": 78, 
         "shared": "false", 
         "requireInitialOnSharedChange": "false", 
         "tabLabel": "MaritalStatus", 
         "bold": "false", 
         "italic": "false", 
         "underline": "false", 
         "documentId": "1", 
         "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7", 
         "pageNumber": "1", 
         "xPosition": "72", 
         "yPosition": "213", 
         "tabId": "b6e5b284-5c87-4a0c-9db5-e4d364ab1113" 
        } 
       ] 
      }, 
      "signInEachLocation": "false", 
      "name": "", 
      "email": "", 
      "recipientId": "f1b5d256-d85c-42d3-b081-913fb93e13a7", 
      "recipientIdGuid": "f1b5d256-d85c-42d3-b081-913fb93e13a7", 
      "requireIdLookup": "false", 
      "routingOrder": "1", 
      "roleName": "Signer1", 
      "status": "created", 
      "templateLocked": "false", 
      "templateRequired": "false" 
     }, 
     { 
      "tabs": { 
       "signHereTabs": [ 
        { 
         "name": "Sign Here", 
         "tabLabel": "Signature 8", 
         "scaleValue": 1, 
         "optional": "false", 
         "documentId": "1", 
         "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e", 
         "pageNumber": "1", 
         "xPosition": "354", 
         "yPosition": "88", 
         "tabId": "1e1829ef-005d-4277-b7af-8758cfdf186a" 
        } 
       ], 
       "fullNameTabs": [ 
        { 
         "name": "Full Name", 
         "tabLabel": "Full Name", 
         "bold": "false", 
         "italic": "false", 
         "underline": "false", 
         "documentId": "1", 
         "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e", 
         "pageNumber": "1", 
         "xPosition": "354", 
         "yPosition": "183", 
         "tabId": "c33c0f3c-2f77-4985-b5b7-d538220a2f86" 
        } 
       ], 
       "textTabs": [ 
        { 
         "height": 11, 
         "validationPattern": "", 
         "validationMessage": "", 
         "shared": "false", 
         "requireInitialOnSharedChange": "false", 
         "name": "Text", 
         "value": "", 
         "width": 42, 
         "required": "true", 
         "locked": "false", 
         "concealValueOnDocument": "false", 
         "disableAutoSize": "false", 
         "tabLabel": "Data Field 9", 
         "bold": "false", 
         "italic": "false", 
         "underline": "false", 
         "documentId": "1", 
         "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e", 
         "pageNumber": "1", 
         "xPosition": "354", 
         "yPosition": "156", 
         "tabId": "80e5a803-b1d4-4175-97b4-09c6125f3143" 
        } 
       ] 
      }, 
      "signInEachLocation": "false", 
      "name": "", 
      "email": "", 
      "recipientId": "79e8bc34-6a40-4cc5-90e1-e58d9707418e", 
      "recipientIdGuid": "79e8bc34-6a40-4cc5-90e1-e58d9707418e", 
      "requireIdLookup": "false", 
      "routingOrder": "2", 
      "roleName": "Signer2", 
      "status": "created", 
      "templateLocked": "false", 
      "templateRequired": "false" 
     } 
    ], 
    "agents": [], 
    "editors": [], 
    "intermediaries": [], 
    "carbonCopies": [], 
    "certifiedDeliveries": [], 
    "inPersonSigners": [], 
    "recipientCount": "2" 
}