Chilkat Online Tools

Swift3 / Support API / Show Item

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/dynamic_content/items/:dynamic_content_item_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)

    // {
    //   "item": {
    //     "name": "<string>",
    //     "default_locale_id": "<integer>",
    //     "variants": [
    //       {
    //         "content": "<string>",
    //         "locale_id": "<integer>",
    //         "active": "<boolean>",
    //         "created_at": "<dateTime>",
    //         "default": "<boolean>",
    //         "id": "<integer>",
    //         "outdated": "<boolean>",
    //         "updated_at": "<dateTime>",
    //         "url": "<string>"
    //       },
    //       {
    //         "content": "<string>",
    //         "locale_id": "<integer>",
    //         "active": "<boolean>",
    //         "created_at": "<dateTime>",
    //         "default": "<boolean>",
    //         "id": "<integer>",
    //         "outdated": "<boolean>",
    //         "updated_at": "<dateTime>",
    //         "url": "<string>"
    //       }
    //     ],
    //     "created_at": "<dateTime>",
    //     "id": "<integer>",
    //     "outdated": "<boolean>",
    //     "placeholder": "<string>",
    //     "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 content: String?
    var locale_id: String?
    var active: String?
    var created_at: String?
    var default: String?
    var id: String?
    var outdated: String?
    var updated_at: String?
    var url: String?

    var Name: String? = jResp.string(of: "item.name")
    var Default_locale_id: String? = jResp.string(of: "item.default_locale_id")
    var Created_at: String? = jResp.string(of: "item.created_at")
    var Id: String? = jResp.string(of: "item.id")
    var Outdated: String? = jResp.string(of: "item.outdated")
    var Placeholder: String? = jResp.string(of: "item.placeholder")
    var Updated_at: String? = jResp.string(of: "item.updated_at")
    var v_Url: String? = jResp.string(of: "item.url")
    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "item.variants").intValue
    while i < count_i {
        jResp.i = i
        content = jResp.string(of: "item.variants[i].content")
        locale_id = jResp.string(of: "item.variants[i].locale_id")
        active = jResp.string(of: "item.variants[i].active")
        created_at = jResp.string(of: "item.variants[i].created_at")
        default = jResp.string(of: "item.variants[i].default")
        id = jResp.string(of: "item.variants[i].id")
        outdated = jResp.string(of: "item.variants[i].outdated")
        updated_at = jResp.string(of: "item.variants[i].updated_at")
        url = jResp.string(of: "item.variants[i].url")
        i = i + 1
    }


}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Item",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items/:dynamic_content_item_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items",
        ":dynamic_content_item_id"
      ],
      "variable": [
        {
          "key": "dynamic_content_item_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins, Agents\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/dynamic_content/items/:dynamic_content_item_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items",
            ":dynamic_content_item_id"
          ],
          "variable": [
            {
              "key": "dynamic_content_item_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"item\": {\n    \"name\": \"<string>\",\n    \"default_locale_id\": \"<integer>\",\n    \"variants\": [\n      {\n        \"content\": \"<string>\",\n        \"locale_id\": \"<integer>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"id\": \"<integer>\",\n        \"outdated\": \"<boolean>\",\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"content\": \"<string>\",\n        \"locale_id\": \"<integer>\",\n        \"active\": \"<boolean>\",\n        \"created_at\": \"<dateTime>\",\n        \"default\": \"<boolean>\",\n        \"id\": \"<integer>\",\n        \"outdated\": \"<boolean>\",\n        \"updated_at\": \"<dateTime>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"created_at\": \"<dateTime>\",\n    \"id\": \"<integer>\",\n    \"outdated\": \"<boolean>\",\n    \"placeholder\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}