Swift / Support API / List Views - Compact
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
http.BasicAuth = true
http.Login = "login"
http.Password = "password"
http.SetRequestHeader("Accept", value: "application/json")
let sbResponseBody = CkoStringBuilder()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/views/compact", sbContent: sbResponseBody)
if success == false {
print("\(http.LastErrorText)")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = http.LastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.LastHeader)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "next_page": "<string>",
// "previous_page": "<string>",
// "views": [
// {
// "active": "<boolean>",
// "conditions": {
// "amet_b2": "minim et Ut aliquip",
// "pariatur_d74": true,
// "eiusmodd7e": 16274866
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "execution": {
// "sit_bd1": -70845421.92699432,
// "voluptated": -13477997
// },
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "officia_1c": -36345253.13616539
// },
// "title": "<string>",
// "updated_at": "<dateTime>"
// },
// {
// "active": "<boolean>",
// "conditions": {
// "do_99": 75108528,
// "aliqua_ad": true,
// "dolore277": 23927228,
// "labore0": "incididunt ut dolor"
// },
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "description": "<string>",
// "execution": {
// "deserunt00": 61902530,
// "velit_90": "consectetur in Excepteur"
// },
// "id": "<integer>",
// "position": "<integer>",
// "restriction": {
// "dolor_58": -88642742.97884612,
// "sed_41": "commodo ut"
// },
// "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
var active: String?
var Amet_b2: String?
var Pariatur_d74: Bool
var Eiusmodd7e: Int
var created_at: String?
var default: String?
var description: String?
var Sit_bd1: String?
var Voluptated: Int
var id: String?
var position: String?
var Officia_1c: String?
var title: String?
var updated_at: String?
var Do_99: Int
var Aliqua_ad: Bool
var Dolore277: Int
var Labore0: String?
var Deserunt00: Int
var Velit_90: String?
var Dolor_58: String?
var Sed_41: String?
var count: String? = jResp.StringOf("count")
var next_page: String? = jResp.StringOf("next_page")
var previous_page: String? = jResp.StringOf("previous_page")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("views").intValue
while i < count_i {
jResp.I = i
active = jResp.StringOf("views[i].active")
Amet_b2 = jResp.StringOf("views[i].conditions.amet_b2")
Pariatur_d74 = jResp.BoolOf("views[i].conditions.pariatur_d74")
Eiusmodd7e = jResp.IntOf("views[i].conditions.eiusmodd7e").intValue
created_at = jResp.StringOf("views[i].created_at")
default = jResp.StringOf("views[i].default")
description = jResp.StringOf("views[i].description")
Sit_bd1 = jResp.StringOf("views[i].execution.sit_bd1")
Voluptated = jResp.IntOf("views[i].execution.voluptated").intValue
id = jResp.StringOf("views[i].id")
position = jResp.StringOf("views[i].position")
Officia_1c = jResp.StringOf("views[i].restriction.officia_1c")
title = jResp.StringOf("views[i].title")
updated_at = jResp.StringOf("views[i].updated_at")
Do_99 = jResp.IntOf("views[i].conditions.do_99").intValue
Aliqua_ad = jResp.BoolOf("views[i].conditions.aliqua_ad")
Dolore277 = jResp.IntOf("views[i].conditions.dolore277").intValue
Labore0 = jResp.StringOf("views[i].conditions.labore0")
Deserunt00 = jResp.IntOf("views[i].execution.deserunt00").intValue
Velit_90 = jResp.StringOf("views[i].execution.velit_90")
Dolor_58 = jResp.StringOf("views[i].restriction.dolor_58")
Sed_41 = jResp.StringOf("views[i].restriction.sed_41")
i = i + 1
}
}
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/compact
Postman Collection Item JSON
{
"name": "List Views - Compact",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/compact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"compact"
]
},
"description": "A compacted list of shared and personal views available to the current user. This endpoint never returns more than 32 records and does not respect the \"per_page\" option.\n\n#### 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/compact",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"compact"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"views\": [\n {\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"amet_b2\": \"minim et Ut aliquip\",\n \"pariatur_d74\": true,\n \"eiusmodd7e\": 16274866\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"execution\": {\n \"sit_bd1\": -70845421.92699432,\n \"voluptated\": -13477997\n },\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"officia_1c\": -36345253.13616539\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"active\": \"<boolean>\",\n \"conditions\": {\n \"do_99\": 75108528,\n \"aliqua_ad\": true,\n \"dolore277\": 23927228,\n \"labore0\": \"incididunt ut dolor\"\n },\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"description\": \"<string>\",\n \"execution\": {\n \"deserunt00\": 61902530,\n \"velit_90\": \"consectetur in Excepteur\"\n },\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"restriction\": {\n \"dolor_58\": -88642742.97884612,\n \"sed_41\": \"commodo ut\"\n },\n \"title\": \"<string>\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}
