PureBasic / Support API / List Items
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "login")
CkHttp::setCkPassword(http, "password")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/dynamic_content/items",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
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
name.s
default_locale_id.s
created_at.s
id.s
outdated.s
placeholder.s
updated_at.s
url.s
j.i
count_j.i
content.s
locale_id.s
active.s
default.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"items")
While i < count_i
CkJsonObject::setCkI(jResp, i)
name = CkJsonObject::ckStringOf(jResp,"items[i].name")
default_locale_id = CkJsonObject::ckStringOf(jResp,"items[i].default_locale_id")
created_at = CkJsonObject::ckStringOf(jResp,"items[i].created_at")
id = CkJsonObject::ckStringOf(jResp,"items[i].id")
outdated = CkJsonObject::ckStringOf(jResp,"items[i].outdated")
placeholder = CkJsonObject::ckStringOf(jResp,"items[i].placeholder")
updated_at = CkJsonObject::ckStringOf(jResp,"items[i].updated_at")
url = CkJsonObject::ckStringOf(jResp,"items[i].url")
j = 0
count_j = CkJsonObject::ckSizeOfArray(jResp,"items[i].variants")
While j < count_j
CkJsonObject::setCkJ(jResp, j)
content = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].content")
locale_id = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].locale_id")
active = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].active")
created_at = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].created_at")
default = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].default")
id = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].id")
outdated = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].outdated")
updated_at = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].updated_at")
url = CkJsonObject::ckStringOf(jResp,"items[i].variants[j].url")
j = j + 1
Wend
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
