Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcName
LOCAL lcDefault_locale_id
LOCAL lcCreated_at
LOCAL lcId
LOCAL lcOutdated
LOCAL lcPlaceholder
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL j
LOCAL lnCount_j
LOCAL lcContent
LOCAL lcLocale_id
LOCAL lcActive
LOCAL lcDefault
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = CreateObject('Chilkat_9_5_0.Http')
loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"
loHttp.SetRequestHeader("Accept","application/json")
loSbResponseBody = CreateObject('Chilkat_9_5_0.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/dynamic_content/items",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
loJResp = CreateObject('Chilkat_9_5_0.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
* 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
i = 0
lnCount_i = loJResp.SizeOfArray("items")
DO WHILE i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("items[i].name")
lcDefault_locale_id = loJResp.StringOf("items[i].default_locale_id")
lcCreated_at = loJResp.StringOf("items[i].created_at")
lcId = loJResp.StringOf("items[i].id")
lcOutdated = loJResp.StringOf("items[i].outdated")
lcPlaceholder = loJResp.StringOf("items[i].placeholder")
lcUpdated_at = loJResp.StringOf("items[i].updated_at")
lcUrl = loJResp.StringOf("items[i].url")
j = 0
lnCount_j = loJResp.SizeOfArray("items[i].variants")
DO WHILE j < lnCount_j
loJResp.J = j
lcContent = loJResp.StringOf("items[i].variants[j].content")
lcLocale_id = loJResp.StringOf("items[i].variants[j].locale_id")
lcActive = loJResp.StringOf("items[i].variants[j].active")
lcCreated_at = loJResp.StringOf("items[i].variants[j].created_at")
lcDefault = loJResp.StringOf("items[i].variants[j].default")
lcId = loJResp.StringOf("items[i].variants[j].id")
lcOutdated = loJResp.StringOf("items[i].variants[j].outdated")
lcUpdated_at = loJResp.StringOf("items[i].variants[j].updated_at")
lcUrl = loJResp.StringOf("items[i].variants[j].url")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
