Chilkat Online Tools

C++ / Support API / List SLA Policies

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login("login");
    http.put_Password("password");

    http.SetRequestHeader("Accept","application/json");

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/slas/policies",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    CkJsonObject jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\n";
        return;
    }

    // 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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const char *title = 0;
    const char *created_at = 0;
    const char *description = 0;
    const char *id = 0;
    const char *position = 0;
    const char *updated_at = 0;
    const char *url = 0;
    int j;
    int count_j;
    const char *field = 0;
    const char *operator = 0;
    const char *value = 0;
    const char *business_hours = 0;
    const char *metric = 0;
    const char *priority = 0;
    const char *target = 0;

    const char *count = jResp.stringOf("count");
    const char *next_page = jResp.stringOf("next_page");
    const char *previous_page = jResp.stringOf("previous_page");
    int i = 0;
    int count_i = jResp.SizeOfArray("sla_policies");
    while (i < count_i) {
        jResp.put_I(i);
        title = jResp.stringOf("sla_policies[i].title");
        created_at = jResp.stringOf("sla_policies[i].created_at");
        description = jResp.stringOf("sla_policies[i].description");
        id = jResp.stringOf("sla_policies[i].id");
        position = jResp.stringOf("sla_policies[i].position");
        updated_at = jResp.stringOf("sla_policies[i].updated_at");
        url = jResp.stringOf("sla_policies[i].url");
        j = 0;
        count_j = jResp.SizeOfArray("sla_policies[i].filter.all");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf("sla_policies[i].filter.all[j].field");
            operator = jResp.stringOf("sla_policies[i].filter.all[j].operator");
            value = jResp.stringOf("sla_policies[i].filter.all[j].value");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("sla_policies[i].filter.any");
        while (j < count_j) {
            jResp.put_J(j);
            field = jResp.stringOf("sla_policies[i].filter.any[j].field");
            operator = jResp.stringOf("sla_policies[i].filter.any[j].operator");
            value = jResp.stringOf("sla_policies[i].filter.any[j].value");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray("sla_policies[i].policy_metrics");
        while (j < count_j) {
            jResp.put_J(j);
            business_hours = jResp.stringOf("sla_policies[i].policy_metrics[j].business_hours");
            metric = jResp.stringOf("sla_policies[i].policy_metrics[j].metric");
            priority = jResp.stringOf("sla_policies[i].policy_metrics[j].priority");
            target = jResp.stringOf("sla_policies[i].policy_metrics[j].target");
            j = j + 1;
        }

        i = i + 1;
    }
    }

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