Chilkat Online Tools

unicodeC / Support API / Create OLA Policy

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *field;
    const wchar_t *operator;
    const wchar_t *value;
    const wchar_t *business_hours;
    const wchar_t *metric;
    const wchar_t *priority;
    const wchar_t *target;
    const wchar_t *Title;
    const wchar_t *Created_at;
    const wchar_t *Description;
    const wchar_t *Id;
    const wchar_t *Position;
    const wchar_t *Updated_at;
    const wchar_t *v_Url;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    CkHttpW_putBasicAuth(http,TRUE);
    CkHttpW_putLogin(http,L"login");
    CkHttpW_putPassword(http,L"password");

    CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");

    resp = CkHttpW_QuickRequest(http,L"POST",L"https://example.zendesk.com/api/v2/olas/policies");
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(resp);

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

    // {
    //   "ola_policy": {
    //     "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.

    Title = CkJsonObjectW_stringOf(jResp,L"ola_policy.title");
    Created_at = CkJsonObjectW_stringOf(jResp,L"ola_policy.created_at");
    Description = CkJsonObjectW_stringOf(jResp,L"ola_policy.description");
    Id = CkJsonObjectW_stringOf(jResp,L"ola_policy.id");
    Position = CkJsonObjectW_stringOf(jResp,L"ola_policy.position");
    Updated_at = CkJsonObjectW_stringOf(jResp,L"ola_policy.updated_at");
    v_Url = CkJsonObjectW_stringOf(jResp,L"ola_policy.url");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"ola_policy.filter.all");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        field = CkJsonObjectW_stringOf(jResp,L"ola_policy.filter.all[i].field");
        operator = CkJsonObjectW_stringOf(jResp,L"ola_policy.filter.all[i].operator");
        value = CkJsonObjectW_stringOf(jResp,L"ola_policy.filter.all[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"ola_policy.filter.any");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        field = CkJsonObjectW_stringOf(jResp,L"ola_policy.filter.any[i].field");
        operator = CkJsonObjectW_stringOf(jResp,L"ola_policy.filter.any[i].operator");
        value = CkJsonObjectW_stringOf(jResp,L"ola_policy.filter.any[i].value");
        i = i + 1;
    }

    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"ola_policy.policy_metrics");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        business_hours = CkJsonObjectW_stringOf(jResp,L"ola_policy.policy_metrics[i].business_hours");
        metric = CkJsonObjectW_stringOf(jResp,L"ola_policy.policy_metrics[i].metric");
        priority = CkJsonObjectW_stringOf(jResp,L"ola_policy.policy_metrics[i].priority");
        target = CkJsonObjectW_stringOf(jResp,L"ola_policy.policy_metrics[i].target");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

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

Postman Collection Item JSON

{
  "name": "Create OLA Policy",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/olas/policies",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "olas",
        "policies"
      ]
    },
    "description": "#### Allowed For\n\n* Admins\n"
  },
  "response": [
    {
      "name": "Created response",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/olas/policies",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "olas",
            "policies"
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"ola_policy\": {\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}"
    }
  ]
}