Chilkat Online Tools

phpAx / DocuSign REST API / Get Responsive HTML Preview for a document in an envelope.

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// 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"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('documentId','sample string 1');
$json->UpdateString('documentGuid','sample string 2');
$json->UpdateString('source','sample string 3');
$json->UpdateString('displayAnchors[0].startAnchor','sample string 1');
$json->UpdateString('displayAnchors[0].endAnchor','sample string 2');
$json->UpdateBool('displayAnchors[0].removeStartAnchor',1);
$json->UpdateBool('displayAnchors[0].removeEndAnchor',1);
$json->UpdateBool('displayAnchors[0].caseSensitive',1);
$json->UpdateString('displayAnchors[0].displaySettings.displayLabel','sample string 1');
$json->UpdateString('displayAnchors[0].displaySettings.display','sample string 2');
$json->UpdateInt('displayAnchors[0].displaySettings.displayPageNumber',3);
$json->UpdateInt('displayAnchors[0].displaySettings.displayOrder',4);
$json->UpdateString('displayAnchors[0].displaySettings.tableStyle','sample string 5');
$json->UpdateString('displayAnchors[0].displaySettings.cellStyle','sample string 6');
$json->UpdateString('displayAnchors[0].displaySettings.inlineOuterStyle','sample string 7');
$json->UpdateBool('displayAnchors[0].displaySettings.hideLabelWhenOpened',1);
$json->UpdateBool('displayAnchors[0].displaySettings.scrollToTopWhenOpened',1);
$json->UpdateString('displayAnchors[0].displaySettings.preLabel','sample string 10');
$json->UpdateString('displayAnchors[0].displaySettings.labelWhenOpened','sample string 11');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.containerStyle','sample string 1');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.outerLabelAndArrowStyle','sample string 2');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.labelStyle','sample string 3');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.arrowStyle','sample string 4');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.arrowClosed','sample string 5');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.arrowOpen','sample string 6');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.arrowLocation','sample string 7');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.arrowColor','sample string 8');
$json->UpdateString('displayAnchors[0].displaySettings.collapsibleSettings.arrowSize','sample string 9');
$json->UpdateBool('displayAnchors[0].displaySettings.collapsibleSettings.onlyArrowIsClickable',1);
$json->UpdateString('removeEmptyTags','sample string 4');
$json->UpdateString('headerLabel','sample string 5');
$json->UpdateString('displayAnchorPrefix','sample string 6');
$json->UpdateString('maxScreenWidth','sample string 7');
$json->UpdateString('displayPageNumber','sample string 8');
$json->UpdateString('displayOrder','sample string 9');
$json->UpdateString('showMobileOptimizedToggle','sample string 10');

// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->AuthToken = '{{accessToken}}';
$http->SetRequestHeader('Accept','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/responsive_html_preview','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

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}}/documents/{{documentId}}/responsive_html_preview

Postman Collection Item JSON

{
  "name": "Get Responsive HTML Preview for a document 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}}/documents/{{documentId}}/responsive_html_preview",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents",
        "{{documentId}}",
        "responsive_html_preview"
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "documentId",
          "value": "{{documentId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    }
  },
  "response": [
  ]
}