Chilkat HOME .NET Core C# Android™ AutoIt C C# C++ Chilkat2-Python CkPython Classic ASP DataFlex Delphi ActiveX Delphi DLL Go Java Lianja Mono C# Node.js Objective-C PHP ActiveX PHP Extension Perl PowerBuilder PowerShell PureBasic Ruby SQL Server Swift 2 Swift 3,4,5... Tcl Unicode C Unicode C++ VB.NET VBScript Visual Basic 6.0 Visual FoxPro Xojo Plugin
(Ruby) DocuSign List Folder ItemsSee more DocuSign ExamplesRetrieves a list of the envelopes in the specified folder. For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/folders/folders/listitems/
require 'chilkat' # This example assumes the Chilkat API to have been previously unlocked. # See Global Unlock Sample for sample code. http = Chilkat::CkHttp.new() # Implements the following HTTP request: # GET /restapi/v2.1/accounts/{accountId}/folders/{folderId} # Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header. jsonToken = Chilkat::CkJsonObject.new() # Load a previously obtained OAuth2 access token. success = jsonToken.LoadFile("qa_data/tokens/docusign.json") if (success == false) print jsonToken.lastErrorText() + "\n"; exit end http.put_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") sbResponseBody = Chilkat::CkStringBuilder.new() success = http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders/{$folderId}",sbResponseBody) if (success == false) print http.lastErrorText() + "\n"; exit end jResp = Chilkat::CkJsonObject.new() jResp.LoadSb(sbResponseBody) jResp.put_EmitCompact(false) print "Response Body:" + "\n"; print jResp.emit() + "\n"; respStatusCode = http.get_LastStatus() print "Response Status Code = " + respStatusCode.to_s() + "\n"; if (respStatusCode >= 400) print "Response Header:" + "\n"; print http.lastHeader() + "\n"; print "Failed." + "\n"; exit 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 resultSetSize = jResp.stringOf("resultSetSize") startPosition = jResp.stringOf("startPosition") endPosition = jResp.stringOf("endPosition") totalSetSize = jResp.stringOf("totalSetSize") previousUri = jResp.stringOf("previousUri") nextUri = jResp.stringOf("nextUri") i = 0 count_i = jResp.SizeOfArray("folderItems") while i < count_i jResp.put_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.put_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 i = i + 1 end |
© 2000-2024 Chilkat Software, Inc. All Rights Reserved.