VB.NET

DocuSign List Folder Items

See more DocuSign Examples

Retrieves a list of the envelopes in the specified folder. VB.NET

Dim success As Boolean = False

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

Dim http As New Chilkat.Http

' Implements the following HTTP request:
' GET /restapi/v2.1/accounts/{accountId}/folders/{folderId}

' Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
Dim jsonToken As New Chilkat.JsonObject
' Load a previously obtained OAuth2 access token.
success = jsonToken.LoadFile("qa_data/tokens/docusign.json")
If (success = False) Then
    Debug.WriteLine(jsonToken.LastErrorText)
    Exit Sub
End If


http.AuthToken = jsonToken.StringOf("access_token")

' Use your account ID and a valid folderId here:
http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252")
http.SetUrlVar("folderId","94644782-31b7-4f82-a2c1-26d8a9306f8c")

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders/{$folderId}",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastResponseHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim ownerName As String
Dim envelopeId As String
Dim envelopeUri As String
Dim status As String
Dim senderName As String
Dim senderEmail As String
Dim createdDateTime As String
Dim sentDateTime As String
Dim completedDateTime As String
Dim subject As String
Dim templateId As String
Dim name As String
Dim shared As String
Dim password As String
Dim description As String
Dim lastModified As String
Dim pageCount As Integer
Dim uri As String
Dim is21CFRPart11 As String
Dim isSignatureProviderEnvelope As String
Dim j As Integer
Dim count_j As Integer
Dim fieldId As String
Dim show As String
Dim required As String
Dim value As String
Dim configurationType As String
Dim errorDetailsErrorCode As String
Dim errorDetailsMessage As String

Dim resultSetSize As String = jResp.StringOf("resultSetSize")
Dim startPosition As String = jResp.StringOf("startPosition")
Dim endPosition As String = jResp.StringOf("endPosition")
Dim totalSetSize As String = jResp.StringOf("totalSetSize")
Dim previousUri As String = jResp.StringOf("previousUri")
Dim nextUri As String = jResp.StringOf("nextUri")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("folderItems")
While i < count_i
    jResp.I = i
    ownerName = jResp.StringOf("folderItems[i].ownerName")
    envelopeId = jResp.StringOf("folderItems[i].envelopeId")
    envelopeUri = jResp.StringOf("folderItems[i].envelopeUri")
    status = jResp.StringOf("folderItems[i].status")
    senderName = jResp.StringOf("folderItems[i].senderName")
    senderEmail = jResp.StringOf("folderItems[i].senderEmail")
    createdDateTime = jResp.StringOf("folderItems[i].createdDateTime")
    sentDateTime = jResp.StringOf("folderItems[i].sentDateTime")
    completedDateTime = jResp.StringOf("folderItems[i].completedDateTime")
    subject = jResp.StringOf("folderItems[i].subject")
    templateId = jResp.StringOf("folderItems[i].templateId")
    name = jResp.StringOf("folderItems[i].name")
    shared = jResp.StringOf("folderItems[i].shared")
    password = jResp.StringOf("folderItems[i].password")
    description = jResp.StringOf("folderItems[i].description")
    lastModified = jResp.StringOf("folderItems[i].lastModified")
    pageCount = jResp.IntOf("folderItems[i].pageCount")
    uri = jResp.StringOf("folderItems[i].uri")
    is21CFRPart11 = jResp.StringOf("folderItems[i].is21CFRPart11")
    isSignatureProviderEnvelope = jResp.StringOf("folderItems[i].isSignatureProviderEnvelope")
    j = 0
    count_j = jResp.SizeOfArray("folderItems[i].customFields")
    While j < count_j
        jResp.J = j
        fieldId = jResp.StringOf("folderItems[i].customFields[j].fieldId")
        name = jResp.StringOf("folderItems[i].customFields[j].name")
        show = jResp.StringOf("folderItems[i].customFields[j].show")
        required = jResp.StringOf("folderItems[i].customFields[j].required")
        value = jResp.StringOf("folderItems[i].customFields[j].value")
        configurationType = jResp.StringOf("folderItems[i].customFields[j].configurationType")
        errorDetailsErrorCode = jResp.StringOf("folderItems[i].customFields[j].errorDetails.errorCode")
        errorDetailsMessage = jResp.StringOf("folderItems[i].customFields[j].errorDetails.message")
        j = j + 1
    End While
    i = i + 1
End While