Chilkat Online Tools

Go / Support API / List Items

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("login")
    http.SetPassword("password")

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

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/dynamic_content/items",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

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

    // {
    //   "items": [
    //     {
    //       "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>"
    //     },
    //     {
    //       "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 name *string = new(string)
default_locale_    var id *string = new(string)
    var created_at *string = new(string)
    var id *string = new(string)
    var outdated *string = new(string)
    var placeholder *string = new(string)
    var updated_at *string = new(string)
    var url *string = new(string)
    var j int
    var count_j int
    var content *string = new(string)
locale_    var id *string = new(string)
    var active *string = new(string)
    var default *string = new(string)

    i := 0
    count_i := jResp.SizeOfArray("items")
    for i < count_i {
        jResp.SetI(i)
        name = jResp.StringOf("items[i].name")
        default_locale_id = jResp.StringOf("items[i].default_locale_id")
        created_at = jResp.StringOf("items[i].created_at")
        id = jResp.StringOf("items[i].id")
        outdated = jResp.StringOf("items[i].outdated")
        placeholder = jResp.StringOf("items[i].placeholder")
        updated_at = jResp.StringOf("items[i].updated_at")
        url = jResp.StringOf("items[i].url")
        j = 0
        count_j = jResp.SizeOfArray("items[i].variants")
        for j < count_j {
            jResp.SetJ(j)
            content = jResp.StringOf("items[i].variants[j].content")
            locale_id = jResp.StringOf("items[i].variants[j].locale_id")
            active = jResp.StringOf("items[i].variants[j].active")
            created_at = jResp.StringOf("items[i].variants[j].created_at")
            default = jResp.StringOf("items[i].variants[j].default")
            id = jResp.StringOf("items[i].variants[j].id")
            outdated = jResp.StringOf("items[i].variants[j].outdated")
            updated_at = jResp.StringOf("items[i].variants[j].updated_at")
            url = jResp.StringOf("items[i].variants[j].url")
            j = j + 1
        }

        i = i + 1
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Items",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/dynamic_content/items",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "dynamic_content",
        "items"
      ]
    },
    "description": "Returns a list of all dynamic content items for your account if accessed as an admin or agents who have permission to manage dynamic content.\n\n#### 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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "dynamic_content",
            "items"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"items\": [\n    {\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    {\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  ]\n}"
    }
  ]
}