Chilkat Online Tools

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/dynamic_content/items",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
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

Local $sName
Local $sDefault_locale_id
Local $sCreated_at
Local $sId
Local $sOutdated
Local $sPlaceholder
Local $sUpdated_at
Local $sUrl
Local $iJ
Local $iCount_j
Local $sContent
Local $sLocale_id
Local $sActive
Local $sDefault

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("items")
While $i < $iCount_i
    $oJResp.I = $i
    $sName = $oJResp.StringOf("items[i].name")
    $sDefault_locale_id = $oJResp.StringOf("items[i].default_locale_id")
    $sCreated_at = $oJResp.StringOf("items[i].created_at")
    $sId = $oJResp.StringOf("items[i].id")
    $sOutdated = $oJResp.StringOf("items[i].outdated")
    $sPlaceholder = $oJResp.StringOf("items[i].placeholder")
    $sUpdated_at = $oJResp.StringOf("items[i].updated_at")
    $sUrl = $oJResp.StringOf("items[i].url")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("items[i].variants")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sContent = $oJResp.StringOf("items[i].variants[j].content")
        $sLocale_id = $oJResp.StringOf("items[i].variants[j].locale_id")
        $sActive = $oJResp.StringOf("items[i].variants[j].active")
        $sCreated_at = $oJResp.StringOf("items[i].variants[j].created_at")
        $sDefault = $oJResp.StringOf("items[i].variants[j].default")
        $sId = $oJResp.StringOf("items[i].variants[j].id")
        $sOutdated = $oJResp.StringOf("items[i].variants[j].outdated")
        $sUpdated_at = $oJResp.StringOf("items[i].variants[j].updated_at")
        $sUrl = $oJResp.StringOf("items[i].variants[j].url")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

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}"
    }
  ]
}