Chilkat Online Tools

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

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    var queryParams = new chilkat.JsonObject();
    queryParams.UpdateInt("count",100);
    queryParams.UpdateInt("startPosition",0);
    queryParams.UpdateString("roomStatus","{{roomStatus}}");
    queryParams.UpdateString("officeId","{{officeId}}");
    queryParams.UpdateString("fieldDataChangedStartDate","{{fieldDataChangedStartDate}}");
    queryParams.UpdateString("fieldDataChangedEndDate","{{fieldDataChangedEndDate}}");
    queryParams.UpdateString("roomClosedStartDate","{{roomClosedStartDate}}");
    queryParams.UpdateString("roomClosedEndDate","{{roomClosedEndDate}}");

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

    // resp: HttpResponse
    var resp = http.QuickRequestParams("GET","https://domain.com/v2/accounts/{{accountId}}/rooms",queryParams);
    if (http.LastMethodSuccess == false) {
        console.log(http.LastErrorText);
        return;
    }

    console.log(resp.StatusCode);
    console.log(resp.BodyStr);


}

chilkatExample();

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