Chilkat Online Tools

delphiDll / Support API / List SLA Policies

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
title: PWideChar;
created_at: PWideChar;
description: PWideChar;
id: PWideChar;
position: PWideChar;
updated_at: PWideChar;
url: PWideChar;
j: Integer;
count_j: Integer;
field: PWideChar;
operator: PWideChar;
value: PWideChar;
business_hours: PWideChar;
metric: PWideChar;
priority: PWideChar;
target: PWideChar;
count: PWideChar;
next_page: PWideChar;
previous_page: 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,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/slas/policies',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)

// {
//   "count": "<integer>",
//   "next_page": "<string>",
//   "previous_page": "<string>",
//   "sla_policies": [
//     {
//       "title": "<string>",
//       "filter": {
//         "all": [
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           }
//         ],
//         "any": [
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           }
//         ]
//       },
//       "created_at": "<dateTime>",
//       "description": "<string>",
//       "id": "<integer>",
//       "policy_metrics": [
//         {
//           "business_hours": "<boolean>",
//           "metric": "<string>",
//           "priority": "<string>",
//           "target": "<integer>"
//         },
//         {
//           "business_hours": "<boolean>",
//           "metric": "<string>",
//           "priority": "<string>",
//           "target": "<integer>"
//         }
//       ],
//       "position": "<integer>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     },
//     {
//       "title": "<string>",
//       "filter": {
//         "all": [
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           }
//         ],
//         "any": [
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           },
//           {
//             "field": "<string>",
//             "operator": "<string>",
//             "value": "<string>"
//           }
//         ]
//       },
//       "created_at": "<dateTime>",
//       "description": "<string>",
//       "id": "<integer>",
//       "policy_metrics": [
//         {
//           "business_hours": "<boolean>",
//           "metric": "<string>",
//           "priority": "<string>",
//           "target": "<integer>"
//         },
//         {
//           "business_hours": "<boolean>",
//           "metric": "<string>",
//           "priority": "<string>",
//           "target": "<integer>"
//         }
//       ],
//       "position": "<integer>",
//       "updated_at": "<dateTime>",
//       "url": "<string>"
//     }
//   ]
// }

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

count := CkJsonObject__stringOf(jResp,'count');
next_page := CkJsonObject__stringOf(jResp,'next_page');
previous_page := CkJsonObject__stringOf(jResp,'previous_page');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'sla_policies');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    title := CkJsonObject__stringOf(jResp,'sla_policies[i].title');
    created_at := CkJsonObject__stringOf(jResp,'sla_policies[i].created_at');
    description := CkJsonObject__stringOf(jResp,'sla_policies[i].description');
    id := CkJsonObject__stringOf(jResp,'sla_policies[i].id');
    position := CkJsonObject__stringOf(jResp,'sla_policies[i].position');
    updated_at := CkJsonObject__stringOf(jResp,'sla_policies[i].updated_at');
    url := CkJsonObject__stringOf(jResp,'sla_policies[i].url');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'sla_policies[i].filter.all');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        field := CkJsonObject__stringOf(jResp,'sla_policies[i].filter.all[j].field');
        operator := CkJsonObject__stringOf(jResp,'sla_policies[i].filter.all[j].operator');
        value := CkJsonObject__stringOf(jResp,'sla_policies[i].filter.all[j].value');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'sla_policies[i].filter.any');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        field := CkJsonObject__stringOf(jResp,'sla_policies[i].filter.any[j].field');
        operator := CkJsonObject__stringOf(jResp,'sla_policies[i].filter.any[j].operator');
        value := CkJsonObject__stringOf(jResp,'sla_policies[i].filter.any[j].value');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'sla_policies[i].policy_metrics');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        business_hours := CkJsonObject__stringOf(jResp,'sla_policies[i].policy_metrics[j].business_hours');
        metric := CkJsonObject__stringOf(jResp,'sla_policies[i].policy_metrics[j].metric');
        priority := CkJsonObject__stringOf(jResp,'sla_policies[i].policy_metrics[j].priority');
        target := CkJsonObject__stringOf(jResp,'sla_policies[i].policy_metrics[j].target');
        j := j + 1;
      end;

    i := i + 1;
  end;

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

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/slas/policies

Postman Collection Item JSON

{
  "name": "List SLA Policies",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/slas/policies",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "slas",
        "policies"
      ]
    },
    "description": "#### Availability\n\n* Accounts on the Support Professional or Suite Growth plan or above\n\n#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/slas/policies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "slas",
            "policies"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\",\n  \"sla_policies\": [\n    {\n      \"title\": \"<string>\",\n      \"filter\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"created_at\": \"<dateTime>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"policy_metrics\": [\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        },\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        }\n      ],\n      \"position\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"title\": \"<string>\",\n      \"filter\": {\n        \"all\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ],\n        \"any\": [\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          },\n          {\n            \"field\": \"<string>\",\n            \"operator\": \"<string>\",\n            \"value\": \"<string>\"\n          }\n        ]\n      },\n      \"created_at\": \"<dateTime>\",\n      \"description\": \"<string>\",\n      \"id\": \"<integer>\",\n      \"policy_metrics\": [\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        },\n        {\n          \"business_hours\": \"<boolean>\",\n          \"metric\": \"<string>\",\n          \"priority\": \"<string>\",\n          \"target\": \"<integer>\"\n        }\n      ],\n      \"position\": \"<integer>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}