Chilkat Online Tools

lianja / Support API / Show View

Back to Collection Items

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

loHttp = createobject("CkHttp")

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

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

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://example.zendesk.com/api/v2/views/:view_id",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "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
    return
endif

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

// {
//   "columns": [
//     {
//       "Duis8": -59589120,
//       "ullamco_0": "Ut nostrud qui elit dolor"
//     },
//     {
//       "officia_13e": -39842370,
//       "ipsum_7": "sunt",
//       "in_a8": true
//     }
//   ],
//   "groups": [
//     {
//       "laborum_a27": false
//     },
//     {
//       "ea85c": 69952708.53230786,
//       "occaecat_04": 58869893,
//       "qui82a": "L"
//     }
//   ],
//   "rows": [
//     {
//       "velit21": -89119970
//     },
//     {
//       "ex_f": 92255473.59295204,
//       "Excepteur_92": "sunt",
//       "cillum4": 24641748
//     }
//   ],
//   "view": {
//     "active": "<boolean>",
//     "conditions": {
//       "laborum_8": 404871.0763479173,
//       "consequata": -40432952
//     },
//     "created_at": "<dateTime>",
//     "default": "<boolean>",
//     "description": "<string>",
//     "execution": {
//       "deserunt6": false,
//       "eu7df": "veniam",
//       "utd70": -40480339.58192083,
//       "aute_03": true,
//       "culpa_5b2": -78225658
//     },
//     "id": "<integer>",
//     "position": "<integer>",
//     "restriction": {
//       "exercitatione1": "in",
//       "magna_b_3": -90768253.5149942
//     },
//     "title": "<string>",
//     "updated_at": "<dateTime>"
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

lcActive = loJResp.StringOf("view.active")
lcLaborum_8 = loJResp.StringOf("view.conditions.laborum_8")
lnConsequata = loJResp.IntOf("view.conditions.consequata")
lcCreated_at = loJResp.StringOf("view.created_at")
lcDefault = loJResp.StringOf("view.default")
lcDescription = loJResp.StringOf("view.description")
llDeserunt6 = loJResp.BoolOf("view.execution.deserunt6")
lcEu7df = loJResp.StringOf("view.execution.eu7df")
lcUtd70 = loJResp.StringOf("view.execution.utd70")
llAute_03 = loJResp.BoolOf("view.execution.aute_03")
lnCulpa_5b2 = loJResp.IntOf("view.execution.culpa_5b2")
lcId = loJResp.StringOf("view.id")
lcPosition = loJResp.StringOf("view.position")
lcExercitatione1 = loJResp.StringOf("view.restriction.exercitatione1")
lcMagna_b_3 = loJResp.StringOf("view.restriction.magna_b_3")
lcTitle = loJResp.StringOf("view.title")
lcUpdated_at = loJResp.StringOf("view.updated_at")
i = 0
lnCount_i = loJResp.SizeOfArray("columns")
do while i < lnCount_i
    loJResp.I = i
    lnDuis8 = loJResp.IntOf("columns[i].Duis8")
    lcUllamco_0 = loJResp.StringOf("columns[i].ullamco_0")
    lnOfficia_13e = loJResp.IntOf("columns[i].officia_13e")
    lcIpsum_7 = loJResp.StringOf("columns[i].ipsum_7")
    llIn_a8 = loJResp.BoolOf("columns[i].in_a8")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("groups")
do while i < lnCount_i
    loJResp.I = i
    llLaborum_a27 = loJResp.BoolOf("groups[i].laborum_a27")
    lcEa85c = loJResp.StringOf("groups[i].ea85c")
    lnOccaecat_04 = loJResp.IntOf("groups[i].occaecat_04")
    lcQui82a = loJResp.StringOf("groups[i].qui82a")
    i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("rows")
do while i < lnCount_i
    loJResp.I = i
    lnVelit21 = loJResp.IntOf("rows[i].velit21")
    lcEx_f = loJResp.StringOf("rows[i].ex_f")
    lcExcepteur_92 = loJResp.StringOf("rows[i].Excepteur_92")
    lnCillum4 = loJResp.IntOf("rows[i].cillum4")
    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/views/:view_id

Postman Collection Item JSON

{
  "name": "Show View",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/views/:view_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "views",
        ":view_id"
      ],
      "variable": [
        {
          "key": "view_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* 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/views/:view_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "views",
            ":view_id"
          ],
          "variable": [
            {
              "key": "view_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"columns\": [\n    {\n      \"Duis8\": -59589120,\n      \"ullamco_0\": \"Ut nostrud qui elit dolor\"\n    },\n    {\n      \"officia_13e\": -39842370,\n      \"ipsum_7\": \"sunt\",\n      \"in_a8\": true\n    }\n  ],\n  \"groups\": [\n    {\n      \"laborum_a27\": false\n    },\n    {\n      \"ea85c\": 69952708.53230786,\n      \"occaecat_04\": 58869893,\n      \"qui82a\": \"L\"\n    }\n  ],\n  \"rows\": [\n    {\n      \"velit21\": -89119970\n    },\n    {\n      \"ex_f\": 92255473.59295204,\n      \"Excepteur_92\": \"sunt\",\n      \"cillum4\": 24641748\n    }\n  ],\n  \"view\": {\n    \"active\": \"<boolean>\",\n    \"conditions\": {\n      \"laborum_8\": 404871.0763479173,\n      \"consequata\": -40432952\n    },\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"execution\": {\n      \"deserunt6\": false,\n      \"eu7df\": \"veniam\",\n      \"utd70\": -40480339.58192083,\n      \"aute_03\": true,\n      \"culpa_5b2\": -78225658\n    },\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"restriction\": {\n      \"exercitatione1\": \"in\",\n      \"magna_b_3\": -90768253.5149942\n    },\n    \"title\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}