Chilkat Online Tools

delphiDll / Sunshine Conversations API / List Switchboards

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
id: PWideChar;
enabled: Boolean;
defaultSwitchboardIntegrationId: PWideChar;
i: Integer;
count_i: Integer;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'username');
CkHttp_putPassword(http,'password');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "switchboards": [
//     {
//       "id": "5ef21b132f21af34f088530d",
//       "enabled": true,
//       "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
//     },
//     {
//       "id": "5ef21b132f21af34f088530d",
//       "enabled": false,
//       "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'switchboards');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    id := CkJsonObject__stringOf(jResp,'switchboards[i].id');
    enabled := CkJsonObject_BoolOf(jResp,'switchboards[i].enabled');
    defaultSwitchboardIntegrationId := CkJsonObject__stringOf(jResp,'switchboards[i].defaultSwitchboardIntegrationId');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/

Postman Collection Item JSON

{
  "name": "List Switchboards",
  "_postman_id": "fb83e8cc-bc12-40d6-bebc-9904b141967b",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": "{{url}}/v2/apps/{{appId}}/switchboards",
    "description": "Lists all switchboards belonging to the app.\n"
  },
  "response": [
    {
      "id": "2d07e434-7c51-4692-baa3-ce3bf447bdf9",
      "name": "Not Found",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "53fe8d49-44d9-47b3-b664-b4022e371f56",
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"switchboards\": [\n  {\n   \"id\": \"5ef21b132f21af34f088530d\",\n   \"enabled\": true,\n   \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n  },\n  {\n   \"id\": \"5ef21b132f21af34f088530d\",\n   \"enabled\": false,\n   \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n  }\n ]\n}"
    }
  ]
}