Chilkat Online Tools

Xojo / DocuSign Rooms API - v2 / Gets rooms available to the calling user.

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateInt("count",100)
success = queryParams.UpdateInt("startPosition",0)
success = queryParams.UpdateString("roomStatus","{{roomStatus}}")
success = queryParams.UpdateString("officeId","{{officeId}}")
success = queryParams.UpdateString("fieldDataChangedStartDate","{{fieldDataChangedStartDate}}")
success = queryParams.UpdateString("fieldDataChangedEndDate","{{fieldDataChangedEndDate}}")
success = queryParams.UpdateString("roomClosedStartDate","{{roomClosedStartDate}}")
success = queryParams.UpdateString("roomClosedEndDate","{{roomClosedEndDate}}")

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = "{{accessToken}}"
http.SetRequestHeader "Accept","text/plain, application/json, text/json"

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2/accounts/{{accountId}}/rooms",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

System.DebugLog(Str(resp.StatusCode))
System.DebugLog(resp.BodyStr)

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": [
  ]
}