PureBasic / DocuSign REST API / Gets information about groups associated with the account.
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,"count","{{count}}")
CkJsonObject::ckUpdateString(queryParams,"group_type","{{group_type}}")
CkJsonObject::ckUpdateString(queryParams,"include_usercount","{{include_usercount}}")
CkJsonObject::ckUpdateString(queryParams,"search_text","{{search_text}}")
CkJsonObject::ckUpdateString(queryParams,"start_position","{{start_position}}")
; 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}}/groups",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 "count=%7B%7Bcount%7D%7D"
-d "group_type=%7B%7Bgroup_type%7D%7D"
-d "include_usercount=%7B%7Binclude_usercount%7D%7D"
-d "search_text=%7B%7Bsearch_text%7D%7D"
-d "start_position=%7B%7Bstart_position%7D%7D"
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/groups
Postman Collection Item JSON
{
"name": "Gets information about groups associated with the account.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups?count={{count}}&group_type={{group_type}}&include_usercount={{include_usercount}}&search_text={{search_text}}&start_position={{start_position}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"groups"
],
"query": [
{
"key": "count",
"value": "{{count}}"
},
{
"key": "group_type",
"value": "{{group_type}}"
},
{
"key": "include_usercount",
"value": "{{include_usercount}}"
},
{
"key": "search_text",
"value": "{{search_text}}"
},
{
"key": "start_position",
"value": "{{start_position}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
},
"description": "Retrieves information about groups associated with the account."
},
"response": [
]
}