Chilkat Online Tools

Swift / Support API / Show OLA Policy

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

    http.BasicAuth = true
    http.Login = "login"
    http.Password = "password"

    http.SetRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/olas/policies/:ola_policy_id", sbContent: sbResponseBody)
    if success == false {
        print("\(http.LastErrorText)")
        return
    }

    let jResp = CkoJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.EmitCompact = false

    print("Response Body:")
    print("\(jResp.Emit())")

    var respStatusCode: Int = http.LastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.LastHeader)")
        print("Failed.")
        return
    }

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

    var field: String?
    var operator: String?
    var value: String?
    var business_hours: String?
    var metric: String?
    var priority: String?
    var target: String?

    var Title: String? = jResp.StringOf("ola_policy.title")
    var Created_at: String? = jResp.StringOf("ola_policy.created_at")
    var Description: String? = jResp.StringOf("ola_policy.description")
    var Id: String? = jResp.StringOf("ola_policy.id")
    var Position: String? = jResp.StringOf("ola_policy.position")
    var Updated_at: String? = jResp.StringOf("ola_policy.updated_at")
    var v_Url: String? = jResp.StringOf("ola_policy.url")
    var i: Int = 0
    var count_i: Int = jResp.SizeOfArray("ola_policy.filter.all").intValue
    while i < count_i {
        jResp.I = i
        field = jResp.StringOf("ola_policy.filter.all[i].field")
        operator = jResp.StringOf("ola_policy.filter.all[i].operator")
        value = jResp.StringOf("ola_policy.filter.all[i].value")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("ola_policy.filter.any").intValue
    while i < count_i {
        jResp.I = i
        field = jResp.StringOf("ola_policy.filter.any[i].field")
        operator = jResp.StringOf("ola_policy.filter.any[i].operator")
        value = jResp.StringOf("ola_policy.filter.any[i].value")
        i = i + 1
    }

    i = 0
    count_i = jResp.SizeOfArray("ola_policy.policy_metrics").intValue
    while i < count_i {
        jResp.I = i
        business_hours = jResp.StringOf("ola_policy.policy_metrics[i].business_hours")
        metric = jResp.StringOf("ola_policy.policy_metrics[i].metric")
        priority = jResp.StringOf("ola_policy.policy_metrics[i].priority")
        target = jResp.StringOf("ola_policy.policy_metrics[i].target")
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show OLA Policy",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/olas/policies/:ola_policy_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "olas",
        "policies",
        ":ola_policy_id"
      ],
      "variable": [
        {
          "key": "ola_policy_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/olas/policies/:ola_policy_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "olas",
            "policies",
            ":ola_policy_id"
          ],
          "variable": [
            {
              "key": "ola_policy_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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}"
    }
  ]
}