DataFlex
DataFlex
DocuSign List Folder Items
See more DocuSign Examples
Retrieves a list of the envelopes in the specified folder.Chilkat DataFlex Downloads
Use ChilkatAx-win32.pkg
Procedure Test
Boolean iSuccess
Handle hoHttp
Handle hoJsonToken
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sOwnerName
String sEnvelopeId
String sEnvelopeUri
String sStatus
String sSenderName
String sSenderEmail
String sCreatedDateTime
String sSentDateTime
String sCompletedDateTime
String sSubject
String sTemplateId
String sName
String sShared
String sPassword
String sDescription
String sLastModified
Integer iPageCount
String sUri
String sIs21CFRPart11
String sIsSignatureProviderEnvelope
Integer j
Integer iCount_j
String sFieldId
String sShow
String sRequired
String sValue
String sConfigurationType
String sErrorDetailsErrorCode
String sErrorDetailsMessage
String sResultSetSize
String sStartPosition
String sEndPosition
String sTotalSetSize
String sPreviousUri
String sNextUri
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}/folders/{folderId}
// 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 folderId here:
Get ComSetUrlVar Of hoHttp "accountId" "7f3f65ed-5e87-418d-94c1-92499ddc8252" To iSuccess
Get ComSetUrlVar Of hoHttp "folderId" "94644782-31b7-4f82-a2c1-26d8a9306f8c" 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}/folders/{$folderId}" 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 ComLastResponseHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "resultSetSize": "sample string 1",
// "startPosition": "sample string 2",
// "endPosition": "sample string 3",
// "totalSetSize": "sample string 4",
// "previousUri": "sample string 5",
// "nextUri": "sample string 6",
// "folderItems": [
// {
// "ownerName": "sample string 1",
// "envelopeId": "sample string 2",
// "envelopeUri": "sample string 3",
// "status": "sample string 4",
// "senderName": "sample string 5",
// "senderEmail": "sample string 6",
// "createdDateTime": "sample string 7",
// "sentDateTime": "sample string 8",
// "completedDateTime": "sample string 9",
// "subject": "sample string 10",
// "templateId": "sample string 11",
// "name": "sample string 12",
// "shared": "sample string 13",
// "password": "sample string 14",
// "description": "sample string 15",
// "lastModified": "sample string 16",
// "pageCount": 17,
// "uri": "sample string 18",
// "is21CFRPart11": "sample string 19",
// "isSignatureProviderEnvelope": "sample string 20",
// "customFields": [
// {
// "fieldId": "sample string 1",
// "name": "sample string 2",
// "show": "sample string 3",
// "required": "sample string 4",
// "value": "sample string 5",
// "configurationType": "sample string 6",
// "errorDetails": {
// "errorCode": "sample string 1",
// "message": "sample string 2"
// }
// }
// ]
// }
// ]
// }
// 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 "resultSetSize" To sResultSetSize
Get ComStringOf Of hoJResp "startPosition" To sStartPosition
Get ComStringOf Of hoJResp "endPosition" To sEndPosition
Get ComStringOf Of hoJResp "totalSetSize" To sTotalSetSize
Get ComStringOf Of hoJResp "previousUri" To sPreviousUri
Get ComStringOf Of hoJResp "nextUri" To sNextUri
Move 0 To i
Get ComSizeOfArray Of hoJResp "folderItems" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "folderItems[i].ownerName" To sOwnerName
Get ComStringOf Of hoJResp "folderItems[i].envelopeId" To sEnvelopeId
Get ComStringOf Of hoJResp "folderItems[i].envelopeUri" To sEnvelopeUri
Get ComStringOf Of hoJResp "folderItems[i].status" To sStatus
Get ComStringOf Of hoJResp "folderItems[i].senderName" To sSenderName
Get ComStringOf Of hoJResp "folderItems[i].senderEmail" To sSenderEmail
Get ComStringOf Of hoJResp "folderItems[i].createdDateTime" To sCreatedDateTime
Get ComStringOf Of hoJResp "folderItems[i].sentDateTime" To sSentDateTime
Get ComStringOf Of hoJResp "folderItems[i].completedDateTime" To sCompletedDateTime
Get ComStringOf Of hoJResp "folderItems[i].subject" To sSubject
Get ComStringOf Of hoJResp "folderItems[i].templateId" To sTemplateId
Get ComStringOf Of hoJResp "folderItems[i].name" To sName
Get ComStringOf Of hoJResp "folderItems[i].shared" To sShared
Get ComStringOf Of hoJResp "folderItems[i].password" To sPassword
Get ComStringOf Of hoJResp "folderItems[i].description" To sDescription
Get ComStringOf Of hoJResp "folderItems[i].lastModified" To sLastModified
Get ComIntOf Of hoJResp "folderItems[i].pageCount" To iPageCount
Get ComStringOf Of hoJResp "folderItems[i].uri" To sUri
Get ComStringOf Of hoJResp "folderItems[i].is21CFRPart11" To sIs21CFRPart11
Get ComStringOf Of hoJResp "folderItems[i].isSignatureProviderEnvelope" To sIsSignatureProviderEnvelope
Move 0 To j
Get ComSizeOfArray Of hoJResp "folderItems[i].customFields" To iCount_j
While (j < iCount_j)
Set ComJ Of hoJResp To j
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].fieldId" To sFieldId
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].name" To sName
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].show" To sShow
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].required" To sRequired
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].value" To sValue
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].configurationType" To sConfigurationType
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].errorDetails.errorCode" To sErrorDetailsErrorCode
Get ComStringOf Of hoJResp "folderItems[i].customFields[j].errorDetails.message" To sErrorDetailsMessage
Move (j + 1) To j
Loop
Move (i + 1) To i
Loop
End_Procedure