PureBasic / DocuSign Rooms API - v2 / Gets rooms available to the calling user.
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::ckUpdateInt(queryParams,"count",100)
CkJsonObject::ckUpdateInt(queryParams,"startPosition",0)
CkJsonObject::ckUpdateString(queryParams,"roomStatus","{{roomStatus}}")
CkJsonObject::ckUpdateString(queryParams,"officeId","{{officeId}}")
CkJsonObject::ckUpdateString(queryParams,"fieldDataChangedStartDate","{{fieldDataChangedStartDate}}")
CkJsonObject::ckUpdateString(queryParams,"fieldDataChangedEndDate","{{fieldDataChangedEndDate}}")
CkJsonObject::ckUpdateString(queryParams,"roomClosedStartDate","{{roomClosedStartDate}}")
CkJsonObject::ckUpdateString(queryParams,"roomClosedEndDate","{{roomClosedEndDate}}")
; 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",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=100"
-d "startPosition=0"
-d "roomStatus=%7B%7BroomStatus%7D%7D"
-d "officeId=%7B%7BofficeId%7D%7D"
-d "fieldDataChangedStartDate=%7B%7BfieldDataChangedStartDate%7D%7D"
-d "fieldDataChangedEndDate=%7B%7BfieldDataChangedEndDate%7D%7D"
-d "roomClosedStartDate=%7B%7BroomClosedStartDate%7D%7D"
-d "roomClosedEndDate=%7B%7BroomClosedEndDate%7D%7D"
-H "Accept: text/plain, application/json, text/json"
-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2/accounts/{{accountId}}/rooms
Postman Collection Item JSON
{
"name": "Gets rooms available to the calling user.",
"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?count=100&startPosition=0&roomStatus={{roomStatus}}&officeId={{officeId}}&fieldDataChangedStartDate={{fieldDataChangedStartDate}}&fieldDataChangedEndDate={{fieldDataChangedEndDate}}&roomClosedStartDate={{roomClosedStartDate}}&roomClosedEndDate={{roomClosedEndDate}}",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"accounts",
"{{accountId}}",
"rooms"
],
"query": [
{
"key": "count",
"value": "100"
},
{
"key": "startPosition",
"value": "0"
},
{
"key": "roomStatus",
"value": "{{roomStatus}}"
},
{
"key": "officeId",
"value": "{{officeId}}"
},
{
"key": "fieldDataChangedStartDate",
"value": "{{fieldDataChangedStartDate}}"
},
{
"key": "fieldDataChangedEndDate",
"value": "{{fieldDataChangedEndDate}}"
},
{
"key": "roomClosedStartDate",
"value": "{{roomClosedStartDate}}"
},
{
"key": "roomClosedEndDate",
"value": "{{roomClosedEndDate}}"
}
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
}
},
"response": [
]
}