PureBasic / DocuSign Rooms API - v2 / Returns the roles for which the calling user, based on their role within the room, can assign to invitees.
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,"assigneeEmail","{{assigneeEmail}}")
CkJsonObject::ckUpdateString(queryParams,"filter","{{filter}}")
CkJsonObject::ckUpdateInt(queryParams,"startPosition",0)
CkJsonObject::ckUpdateInt(queryParams,"count",100)
; Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp::setCkAuthToken(http, "{{accessToken}}")
CkHttp::ckSetRequestHeader(http,"Accept","text/plain, application/json, text/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://domain.com/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles",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 "assigneeEmail=%7B%7BassigneeEmail%7D%7D"
-d "filter=%7B%7Bfilter%7D%7D"
-d "startPosition=0"
-d "count=100"
-H "Accept: text/plain, application/json, text/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles
Postman Collection Item JSON
{
"name": "Returns the roles for which the calling user, based on their role within the room, can assign to invitees.",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "text/plain, application/json, text/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"url": {
"raw": "{{baseUrl}}/v2/accounts/{{accountId}}/rooms/{{roomId}}/assignable_roles?assigneeEmail={{assigneeEmail}}&filter={{filter}}&startPosition=0&count=100",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"accounts",
"{{accountId}}",
"rooms",
"{{roomId}}",
"assignable_roles"
],
"query": [
{
"key": "assigneeEmail",
"value": "{{assigneeEmail}}"
},
{
"key": "filter",
"value": "{{filter}}"
},
{
"key": "startPosition",
"value": "0"
},
{
"key": "count",
"value": "100"
}
],
"variable": [
{
"key": "roomId",
"value": "{{roomId}}"
},
{
"key": "accountId",
"value": "{{accountId}}"
}
]
}
},
"response": [
]
}