Chilkat Tools

TCL / DocuSign REST API / Get Responsive HTML Preview for all documents in an envelope.

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set http [new_CkHttp]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "documentId": "sample string 1",
#   "documentGuid": "sample string 2",
#   "source": "sample string 3",
#   "displayAnchors": [
#     {
#       "startAnchor": "sample string 1",
#       "endAnchor": "sample string 2",
#       "removeStartAnchor": true,
#       "removeEndAnchor": true,
#       "caseSensitive": true,
#       "displaySettings": {
#         "displayLabel": "sample string 1",
#         "display": "sample string 2",
#         "displayPageNumber": 3,
#         "displayOrder": 4,
#         "tableStyle": "sample string 5",
#         "cellStyle": "sample string 6",
#         "inlineOuterStyle": "sample string 7",
#         "hideLabelWhenOpened": true,
#         "scrollToTopWhenOpened": true,
#         "preLabel": "sample string 10",
#         "labelWhenOpened": "sample string 11",
#         "collapsibleSettings": {
#           "containerStyle": "sample string 1",
#           "outerLabelAndArrowStyle": "sample string 2",
#           "labelStyle": "sample string 3",
#           "arrowStyle": "sample string 4",
#           "arrowClosed": "sample string 5",
#           "arrowOpen": "sample string 6",
#           "arrowLocation": "sample string 7",
#           "arrowColor": "sample string 8",
#           "arrowSize": "sample string 9",
#           "onlyArrowIsClickable": true
#         }
#       }
#     }
#   ],
#   "removeEmptyTags": "sample string 4",
#   "headerLabel": "sample string 5",
#   "displayAnchorPrefix": "sample string 6",
#   "maxScreenWidth": "sample string 7",
#   "displayPageNumber": "sample string 8",
#   "displayOrder": "sample string 9",
#   "showMobileOptimizedToggle": "sample string 10"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "documentId" "sample string 1"
CkJsonObject_UpdateString $json "documentGuid" "sample string 2"
CkJsonObject_UpdateString $json "source" "sample string 3"
CkJsonObject_UpdateString $json "displayAnchors[0].startAnchor" "sample string 1"
CkJsonObject_UpdateString $json "displayAnchors[0].endAnchor" "sample string 2"
CkJsonObject_UpdateBool $json "displayAnchors[0].removeStartAnchor" 1
CkJsonObject_UpdateBool $json "displayAnchors[0].removeEndAnchor" 1
CkJsonObject_UpdateBool $json "displayAnchors[0].caseSensitive" 1
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.displayLabel" "sample string 1"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.display" "sample string 2"
CkJsonObject_UpdateInt $json "displayAnchors[0].displaySettings.displayPageNumber" 3
CkJsonObject_UpdateInt $json "displayAnchors[0].displaySettings.displayOrder" 4
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.tableStyle" "sample string 5"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.cellStyle" "sample string 6"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.inlineOuterStyle" "sample string 7"
CkJsonObject_UpdateBool $json "displayAnchors[0].displaySettings.hideLabelWhenOpened" 1
CkJsonObject_UpdateBool $json "displayAnchors[0].displaySettings.scrollToTopWhenOpened" 1
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.preLabel" "sample string 10"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.labelWhenOpened" "sample string 11"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.containerStyle" "sample string 1"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.outerLabelAndArrowStyle" "sample string 2"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.labelStyle" "sample string 3"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.arrowStyle" "sample string 4"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.arrowClosed" "sample string 5"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.arrowOpen" "sample string 6"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.arrowLocation" "sample string 7"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.arrowColor" "sample string 8"
CkJsonObject_UpdateString $json "displayAnchors[0].displaySettings.collapsibleSettings.arrowSize" "sample string 9"
CkJsonObject_UpdateBool $json "displayAnchors[0].displaySettings.collapsibleSettings.onlyArrowIsClickable" 1
CkJsonObject_UpdateString $json "removeEmptyTags" "sample string 4"
CkJsonObject_UpdateString $json "headerLabel" "sample string 5"
CkJsonObject_UpdateString $json "displayAnchorPrefix" "sample string 6"
CkJsonObject_UpdateString $json "maxScreenWidth" "sample string 7"
CkJsonObject_UpdateString $json "displayPageNumber" "sample string 8"
CkJsonObject_UpdateString $json "displayOrder" "sample string 9"
CkJsonObject_UpdateString $json "showMobileOptimizedToggle" "sample string 10"

# Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_put_AuthToken $http "{{accessToken}}"
CkHttp_SetRequestHeader $http "Accept" "application/json"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/responsive_html_preview" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
	-d '{
  "documentId": "sample string 1",
  "documentGuid": "sample string 2",
  "source": "sample string 3",
  "displayAnchors": [
    {
      "startAnchor": "sample string 1",
      "endAnchor": "sample string 2",
      "removeStartAnchor": true,
      "removeEndAnchor": true,
      "caseSensitive": true,
      "displaySettings": {
        "displayLabel": "sample string 1",
        "display": "sample string 2",
        "displayPageNumber": 3,
        "displayOrder": 4,
        "tableStyle": "sample string 5",
        "cellStyle": "sample string 6",
        "inlineOuterStyle": "sample string 7",
        "hideLabelWhenOpened": true,
        "scrollToTopWhenOpened": true,
        "preLabel": "sample string 10",
        "labelWhenOpened": "sample string 11",
        "collapsibleSettings": {
          "containerStyle": "sample string 1",
          "outerLabelAndArrowStyle": "sample string 2",
          "labelStyle": "sample string 3",
          "arrowStyle": "sample string 4",
          "arrowClosed": "sample string 5",
          "arrowOpen": "sample string 6",
          "arrowLocation": "sample string 7",
          "arrowColor": "sample string 8",
          "arrowSize": "sample string 9",
          "onlyArrowIsClickable": true
        }
      }
    }
  ],
  "removeEmptyTags": "sample string 4",
  "headerLabel": "sample string 5",
  "displayAnchorPrefix": "sample string 6",
  "maxScreenWidth": "sample string 7",
  "displayPageNumber": "sample string 8",
  "displayOrder": "sample string 9",
  "showMobileOptimizedToggle": "sample string 10"
}'
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/responsive_html_preview

Postman Collection Item JSON

{
  "name": "Get Responsive HTML Preview for all documents in an envelope.",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n  \"documentId\": \"sample string 1\",\n  \"documentGuid\": \"sample string 2\",\n  \"source\": \"sample string 3\",\n  \"displayAnchors\": [\n    {\n      \"startAnchor\": \"sample string 1\",\n      \"endAnchor\": \"sample string 2\",\n      \"removeStartAnchor\": true,\n      \"removeEndAnchor\": true,\n      \"caseSensitive\": true,\n      \"displaySettings\": {\n        \"displayLabel\": \"sample string 1\",\n        \"display\": \"sample string 2\",\n        \"displayPageNumber\": 3,\n        \"displayOrder\": 4,\n        \"tableStyle\": \"sample string 5\",\n        \"cellStyle\": \"sample string 6\",\n        \"inlineOuterStyle\": \"sample string 7\",\n        \"hideLabelWhenOpened\": true,\n        \"scrollToTopWhenOpened\": true,\n        \"preLabel\": \"sample string 10\",\n        \"labelWhenOpened\": \"sample string 11\",\n        \"collapsibleSettings\": {\n          \"containerStyle\": \"sample string 1\",\n          \"outerLabelAndArrowStyle\": \"sample string 2\",\n          \"labelStyle\": \"sample string 3\",\n          \"arrowStyle\": \"sample string 4\",\n          \"arrowClosed\": \"sample string 5\",\n          \"arrowOpen\": \"sample string 6\",\n          \"arrowLocation\": \"sample string 7\",\n          \"arrowColor\": \"sample string 8\",\n          \"arrowSize\": \"sample string 9\",\n          \"onlyArrowIsClickable\": true\n        }\n      }\n    }\n  ],\n  \"removeEmptyTags\": \"sample string 4\",\n  \"headerLabel\": \"sample string 5\",\n  \"displayAnchorPrefix\": \"sample string 6\",\n  \"maxScreenWidth\": \"sample string 7\",\n  \"displayPageNumber\": \"sample string 8\",\n  \"displayOrder\": \"sample string 9\",\n  \"showMobileOptimizedToggle\": \"sample string 10\"\n}"
    },
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/responsive_html_preview",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "responsive_html_preview"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    }
  },
  "response": [
  ]
}

Chilkat Online Tools

TCL / DocuSign REST API / Get Responsive HTML Preview for all documents in an envelope.

Curl Command

Postman Collection Item JSON