Chilkat Online Tools

delphiDll / Sunshine Conversations API / Update Switchboard

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
json: HCkJsonObject;
sbRequestBody: HCkStringBuilder;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Id: PWideChar;
Enabled: Boolean;
DefaultSwitchboardIntegrationId: PWideChar;

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');

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "enabled": false,
//   "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
// }

json := CkJsonObject_Create();
CkJsonObject_UpdateBool(json,'enabled',False);
CkJsonObject_UpdateString(json,'defaultSwitchboardIntegrationId','5ef21b132f21af34f088530e');

CkHttp_SetRequestHeader(http,'Content-Type','application/json');

sbRequestBody := CkStringBuilder_Create();
CkJsonObject_EmitSb(json,sbRequestBody);

resp := CkHttp_PTextSb(http,'PATCH','https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId',sbRequestBody,'utf-8','application/json',False,False);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

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

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

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

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

// {
//   "switchboard": {
//     "id": "5ef21b132f21af34f088530d",
//     "enabled": true,
//     "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
//   }
// }

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

Id := CkJsonObject__stringOf(jResp,'switchboard.id');
Enabled := CkJsonObject_BoolOf(jResp,'switchboard.enabled');
DefaultSwitchboardIntegrationId := CkJsonObject__stringOf(jResp,'switchboard.defaultSwitchboardIntegrationId');

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

Curl Command

curl -X PATCH
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "enabled": false,
    "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
}'
https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId

Postman Collection Item JSON

{
  "name": "Update Switchboard",
  "_postman_id": "d495c4a8-de11-46e2-abb9-a859bb638b2e",
  "request": {
    "method": "PATCH",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"enabled\": false,\n    \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n}"
    },
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/switchboards/:switchboardId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "switchboards",
        ":switchboardId"
      ],
      "variable": [
        {
          "key": "switchboardId"
        }
      ]
    },
    "description": "Updates a switchboard record."
  },
  "response": [
    {
      "id": "8fadc082-59f3-4c73-975c-bb038c8e595d",
      "name": "Ok",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"enabled\": false,\n    \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"switchboard\": {\n  \"id\": \"5ef21b132f21af34f088530d\",\n  \"enabled\": true,\n  \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n }\n}"
    },
    {
      "id": "99204a68-10e3-470f-9508-e69ca7227660",
      "name": "Not Found",
      "originalRequest": {
        "method": "PATCH",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"enabled\": false,\n    \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}