DataFlex / DocuSign REST API / Get Responsive HTML Preview for a document in an envelope.
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vJson
Handle hoJson
Variant vResp
Handle hoResp
String sTemp1
Integer iTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// 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"
// }
Get Create (RefClass(cComChilkatJsonObject)) To hoJson
If (Not(IsComObjectCreated(hoJson))) Begin
Send CreateComObject of hoJson
End
Get ComUpdateString Of hoJson "documentId" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "documentGuid" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "source" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].startAnchor" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].endAnchor" "sample string 2" To iSuccess
Get ComUpdateBool Of hoJson "displayAnchors[0].removeStartAnchor" True To iSuccess
Get ComUpdateBool Of hoJson "displayAnchors[0].removeEndAnchor" True To iSuccess
Get ComUpdateBool Of hoJson "displayAnchors[0].caseSensitive" True To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.displayLabel" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.display" "sample string 2" To iSuccess
Get ComUpdateInt Of hoJson "displayAnchors[0].displaySettings.displayPageNumber" 3 To iSuccess
Get ComUpdateInt Of hoJson "displayAnchors[0].displaySettings.displayOrder" 4 To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.tableStyle" "sample string 5" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.cellStyle" "sample string 6" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.inlineOuterStyle" "sample string 7" To iSuccess
Get ComUpdateBool Of hoJson "displayAnchors[0].displaySettings.hideLabelWhenOpened" True To iSuccess
Get ComUpdateBool Of hoJson "displayAnchors[0].displaySettings.scrollToTopWhenOpened" True To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.preLabel" "sample string 10" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.labelWhenOpened" "sample string 11" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.containerStyle" "sample string 1" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.outerLabelAndArrowStyle" "sample string 2" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.labelStyle" "sample string 3" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.arrowStyle" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.arrowClosed" "sample string 5" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.arrowOpen" "sample string 6" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.arrowLocation" "sample string 7" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.arrowColor" "sample string 8" To iSuccess
Get ComUpdateString Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.arrowSize" "sample string 9" To iSuccess
Get ComUpdateBool Of hoJson "displayAnchors[0].displaySettings.collapsibleSettings.onlyArrowIsClickable" True To iSuccess
Get ComUpdateString Of hoJson "removeEmptyTags" "sample string 4" To iSuccess
Get ComUpdateString Of hoJson "headerLabel" "sample string 5" To iSuccess
Get ComUpdateString Of hoJson "displayAnchorPrefix" "sample string 6" To iSuccess
Get ComUpdateString Of hoJson "maxScreenWidth" "sample string 7" To iSuccess
Get ComUpdateString Of hoJson "displayPageNumber" "sample string 8" To iSuccess
Get ComUpdateString Of hoJson "displayOrder" "sample string 9" To iSuccess
Get ComUpdateString Of hoJson "showMobileOptimizedToggle" "sample string 10" To iSuccess
// Adds the "Authorization: Bearer {{accessToken}}" header.
Set ComAuthToken Of hoHttp To "{{accessToken}}"
Send ComSetRequestHeader To hoHttp "Accept" "application/json"
Get pvComObject of hoJson to vJson
Get ComPostJson3 Of hoHttp "https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents/{{documentId}}/responsive_html_preview" "application/json" vJson To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStatusCode Of hoResp To iTemp1
Showln iTemp1
Get ComBodyStr Of hoResp To sTemp1
Showln sTemp1
Send Destroy of hoResp
End_Procedure
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": [
]
}
