2013-11-27 79 views
1

我在想什麼最好的方法是使用REST API從模板中獲取所有選項卡。使用REST DocuSign API獲取模板中的所有選項卡

我目前正在嘗試做的是獲取所有收件人及其所有選項卡,以便我們可以在創建信封時默認某些值以及鎖定填充值的字段。

  • 要獲取我使用/ envelopes/{templateId}/recipients的收件人。
  • 要獲取標籤,我將循環瀏覽模板中的所有收件人,然後使用/ envelopes/{templateId}/recipients/{recipientId}/tabs。

我想知道這是否是最好的方法,因爲我會盡可能多地打電話給DocuSign,因爲有收件人,如果有更好的方法做這個,不想打額外的電話。

謝謝。

回答

3

實際上,通過REST API獲取模板的所有字段(選項卡)有一個更簡單的方法。只要進行以下(單)電話:

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" 
} 
相關問題