Chilkat Online Tools

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

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,"officeId","{{officeId}}")
    CkJsonObject::ckUpdateString(queryParams,"onlyAssignable","false")
    CkJsonObject::ckUpdateString(queryParams,"onlyEnabled","true")
    CkJsonObject::ckUpdateInt(queryParams,"count",100)
    CkJsonObject::ckUpdateInt(queryParams,"startPosition",0)

    ; 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}}/room_templates",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 "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": [
  ]
}