Chilkat Online Tools

Foxpro / Support API / Show Item

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcContent
LOCAL lcLocale_id
LOCAL lcActive
LOCAL lcCreated_at
LOCAL lcDefault
LOCAL lcId
LOCAL lcOutdated
LOCAL lcUpdated_at
LOCAL lcUrl
LOCAL lcName
LOCAL lcDefault_locale_id
LOCAL lcCreated_at
LOCAL lcId
LOCAL lcOutdated
LOCAL lcPlaceholder
LOCAL lcUpdated_at
LOCAL lcV_Url
LOCAL i
LOCAL lnCount_i

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

loHttp.BasicAuth = 1
loHttp.Login = "login"
loHttp.Password = "password"

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/dynamic_content/items/:dynamic_content_item_id",loSbResponseBody)
IF (lnSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponseBody
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.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)

* {
*   "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

lcName = loJResp.StringOf("item.name")
lcDefault_locale_id = loJResp.StringOf("item.default_locale_id")
lcCreated_at = loJResp.StringOf("item.created_at")
lcId = loJResp.StringOf("item.id")
lcOutdated = loJResp.StringOf("item.outdated")
lcPlaceholder = loJResp.StringOf("item.placeholder")
lcUpdated_at = loJResp.StringOf("item.updated_at")
lcV_Url = loJResp.StringOf("item.url")
i = 0
lnCount_i = loJResp.SizeOfArray("item.variants")
DO WHILE i < lnCount_i
    loJResp.I = i
    lcContent = loJResp.StringOf("item.variants[i].content")
    lcLocale_id = loJResp.StringOf("item.variants[i].locale_id")
    lcActive = loJResp.StringOf("item.variants[i].active")
    lcCreated_at = loJResp.StringOf("item.variants[i].created_at")
    lcDefault = loJResp.StringOf("item.variants[i].default")
    lcId = loJResp.StringOf("item.variants[i].id")
    lcOutdated = loJResp.StringOf("item.variants[i].outdated")
    lcUpdated_at = loJResp.StringOf("item.variants[i].updated_at")
    lcUrl = loJResp.StringOf("item.variants[i].url")
    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/: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}"
    }
  ]
}