2013-11-27 3 views
1

REST API를 사용하여 템플릿에서 모든 탭을 가져 오는 것이 가장 좋은 방법인지 궁금합니다.REST DocuSign API를 사용하여 템플릿에서 모든 탭 가져 오기

현재 수행하려는 작업은 모든 수신자와 모든 탭을 가져와 일부 값을 기본값으로 설정할 수 있으며 봉투를 만들 때 값이 채워진 필드를 잠글 수 있습니다.

  • 수신자를 얻으려면/envelopes/{templateId}/수신자를 사용하고 있습니다.
  • 탭을 얻으려면 서식 파일의 모든받는 사람을 통해 반복 한 다음 봉투/{templateId} /받는 사람/{recipientId}/탭을 사용합니다.

받는 사람이있는만큼 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" 
} 
관련 문제