DataFlex
DataFlex
DocuSign List Envelope Documents
See more DocuSign Examples
Retrieve a list of all documents within a specific envelope.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Handle hoJsonToken
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sDocumentId
String sDocumentIdGuid
String sName
String sV_type
String sUri
String sOrder
String sDisplay
String sIncludeInDownload
String sSignerMustAcknowledge
String sTemplateRequired
String sAuthoritativeCopy
Integer j
Integer iCount_j
String sPageId
String sSequence
String sHeight
String sWidth
String sDpi
String sIsDefault
String sEnvelopeId
Integer i
Integer iCount_i
String sTemp1
Move False To iSuccess
// 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
// Implements the following HTTP request:
// GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents
// Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
Get Create (RefClass(cComChilkatJsonObject)) To hoJsonToken
If (Not(IsComObjectCreated(hoJsonToken))) Begin
Send CreateComObject of hoJsonToken
End
// Load a previously obtained OAuth2 access token.
Get ComLoadFile Of hoJsonToken "qa_data/tokens/docusign.json" To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoJsonToken To sTemp1
Showln sTemp1
Procedure_Return
End
Get ComStringOf Of hoJsonToken "access_token" To sTemp1
Set ComAuthToken Of hoHttp To sTemp1
// Use your account ID and a valid envelopeId here:
Get ComSetUrlVar Of hoHttp "accountId" "7f3f65ed-5e87-418d-94c1-92499ddc8252" To iSuccess
Get ComSetUrlVar Of hoHttp "envelopeId" "90d7e40a-b4bd-4ccd-bf38-c80e37954a13" To iSuccess
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/envelopes/{$envelopeId}/documents" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "envelopeId": "90d7e40a-b4bd-4ccd-bf38-c80e37954a13",
// "envelopeDocuments": [
// {
// "documentId": "1",
// "documentIdGuid": "ca1d3cc6-9bc3-48d6-a5d8-a85d9acdcde1",
// "name": "helloWorld.pdf",
// "type": "content",
// "uri": "/envelopes/90d7e40a-b4bd-4ccd-bf38-c80e37954a13/documents/1",
// "order": "1",
// "pages": [
// {
// "pageId": "fbf93a36-6b60-484d-94bd-ee3c08c0a546",
// "sequence": "1",
// "height": "842",
// "width": "595",
// "dpi": "72"
// }
// ],
// "availableDocumentTypes": [
// {
// "type": "electronic",
// "isDefault": "true"
// }
// ],
// "display": "inline",
// "includeInDownload": "true",
// "signerMustAcknowledge": "no_interaction",
// "templateRequired": "false",
// "authoritativeCopy": "false"
// },
// {
// "documentId": "certificate",
// "documentIdGuid": "7479a5de-8d91-44a2-bc33-b76a9ba0f6e2",
// "name": "Summary",
// "type": "summary",
// "uri": "/envelopes/90d7e40a-b4bd-4ccd-bf38-c80e37954a13/documents/certificate",
// "order": "999",
// "availableDocumentTypes": [
// {
// "type": "electronic",
// "isDefault": "true"
// }
// ],
// "display": "inline",
// "includeInDownload": "true",
// "signerMustAcknowledge": "no_interaction",
// "templateRequired": "false",
// "authoritativeCopy": "false"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
Get ComStringOf Of hoJResp "envelopeId" To sEnvelopeId
Move 0 To i
Get ComSizeOfArray Of hoJResp "envelopeDocuments" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "envelopeDocuments[i].documentId" To sDocumentId
Get ComStringOf Of hoJResp "envelopeDocuments[i].documentIdGuid" To sDocumentIdGuid
Get ComStringOf Of hoJResp "envelopeDocuments[i].name" To sName
Get ComStringOf Of hoJResp "envelopeDocuments[i].type" To sV_type
Get ComStringOf Of hoJResp "envelopeDocuments[i].uri" To sUri
Get ComStringOf Of hoJResp "envelopeDocuments[i].order" To sOrder
Get ComStringOf Of hoJResp "envelopeDocuments[i].display" To sDisplay
Get ComStringOf Of hoJResp "envelopeDocuments[i].includeInDownload" To sIncludeInDownload
Get ComStringOf Of hoJResp "envelopeDocuments[i].signerMustAcknowledge" To sSignerMustAcknowledge
Get ComStringOf Of hoJResp "envelopeDocuments[i].templateRequired" To sTemplateRequired
Get ComStringOf Of hoJResp "envelopeDocuments[i].authoritativeCopy" To sAuthoritativeCopy
Move 0 To j
Get ComSizeOfArray Of hoJResp "envelopeDocuments[i].pages" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "envelopeDocuments[i].pages[j].pageId" To sPageId
Get ComStringOf Of hoJResp "envelopeDocuments[i].pages[j].sequence" To sSequence
Get ComStringOf Of hoJResp "envelopeDocuments[i].pages[j].height" To sHeight
Get ComStringOf Of hoJResp "envelopeDocuments[i].pages[j].width" To sWidth
Get ComStringOf Of hoJResp "envelopeDocuments[i].pages[j].dpi" To sDpi
Move (j + 1) To j
Loop
Move 0 To j
Get ComSizeOfArray Of hoJResp "envelopeDocuments[i].availableDocumentTypes" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "envelopeDocuments[i].availableDocumentTypes[j].type" To sV_type
Get ComStringOf Of hoJResp "envelopeDocuments[i].availableDocumentTypes[j].isDefault" To sIsDefault
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure