PureBasic / DocuSign REST API / Gets a list of envelopes in folders matching the specified criteria.
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"all","{{all}}")
CkJsonObject::ckUpdateString(queryParams,"count","{{count}}")
CkJsonObject::ckUpdateString(queryParams,"from_date","{{from_date}}")
CkJsonObject::ckUpdateString(queryParams,"include_recipients","{{include_recipients}}")
CkJsonObject::ckUpdateString(queryParams,"order","{{order}}")
CkJsonObject::ckUpdateString(queryParams,"order_by","{{order_by}}")
CkJsonObject::ckUpdateString(queryParams,"start_position","{{start_position}}")
CkJsonObject::ckUpdateString(queryParams,"to_date","{{to_date}}")
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndProcedure
Curl Command
curl -G -d "all=%7B%7Ball%7D%7D"
-d "count=%7B%7Bcount%7D%7D"
-d "from_date=%7B%7Bfrom_date%7D%7D"
-d "include_recipients=%7B%7Binclude_recipients%7D%7D"
-d "order=%7B%7Border%7D%7D"
-d "order_by=%7B%7Border_by%7D%7D"
-d "start_position=%7B%7Bstart_position%7D%7D"
-d "to_date=%7B%7Bto_date%7D%7D"
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}
Postman Collection Item JSON
{
"name": "Gets a list of envelopes in folders matching the specified criteria.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}?all={{all}}&count={{count}}&from_date={{from_date}}&include_recipients={{include_recipients}}&order={{order}}&order_by={{order_by}}&start_position={{start_position}}&to_date={{to_date}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"search_folders",
"{{searchFolderId}}"
],
"query": [
{
"key": "all",
"value": "{{all}}"
},
{
"key": "count",
"value": "{{count}}"
},
{
"key": "from_date",
"value": "{{from_date}}"
},
{
"key": "include_recipients",
"value": "{{include_recipients}}"
},
{
"key": "order",
"value": "{{order}}"
},
{
"key": "order_by",
"value": "{{order_by}}"
},
{
"key": "start_position",
"value": "{{start_position}}"
},
{
"key": "to_date",
"value": "{{to_date}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
},
{
"key": "searchFolderId",
"value": "{{searchFolderId}}"
}
]
},
"description": "Retrieves a list of envelopes that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients."
},
"response": [
]
}