Chilkat Online Tools

Foxpro / DocuSign Rooms API - v2 / Returns all room templates that the active user has access to

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateString("officeId","{{officeId}}")
loQueryParams.UpdateString("onlyAssignable","false")
loQueryParams.UpdateString("onlyEnabled","true")
loQueryParams.UpdateInt("count",100)
loQueryParams.UpdateInt("startPosition",0)

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

loResp = loHttp.QuickRequestParams("GET","https://domain.com/v2/accounts/{{accountId}}/room_templates",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loQueryParams
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loQueryParams

Curl Command

curl -G -d "officeId=%7B%7BofficeId%7D%7D"
	-d "onlyAssignable=false"
	-d "onlyEnabled=true"
	-d "count=100"
	-d "startPosition=0"
	-H "Accept: text/plain, application/json, text/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2/accounts/{{accountId}}/room_templates

Postman Collection Item JSON

{
  "name": "Returns all room templates that the active user has access to",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "text/plain, application/json, text/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2/accounts/{{accountId}}/room_templates?officeId={{officeId}}&onlyAssignable=false&onlyEnabled=true&count=100&startPosition=0",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2",
        "accounts",
        "{{accountId}}",
        "room_templates"
      ],
      "query": [
        {
          "key": "officeId",
          "value": "{{officeId}}"
        },
        {
          "key": "onlyAssignable",
          "value": "false"
        },
        {
          "key": "onlyEnabled",
          "value": "true"
        },
        {
          "key": "count",
          "value": "100"
        },
        {
          "key": "startPosition",
          "value": "0"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    }
  },
  "response": [
  ]
}