PureBasic / Support API / Search Views
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"query","<string>")
CkJsonObject::ckUpdateString(queryParams,"access","<string>")
CkJsonObject::ckUpdateString(queryParams,"active","<boolean>")
CkJsonObject::ckUpdateString(queryParams,"group_id","<integer>")
CkJsonObject::ckUpdateString(queryParams,"sort_by","<string>")
CkJsonObject::ckUpdateString(queryParams,"sort_order","<string>")
CkJsonObject::ckUpdateString(queryParams,"include","<string>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/views/search",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(resp)
; 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
active.s
Amet_b2.s
Pariatur_d74.i
Eiusmodd7e.i
created_at.s
default.s
description.s
Sit_bd1.s
Voluptated.i
id.s
position.s
Officia_1c.s
title.s
updated_at.s
Do_99.i
Aliqua_ad.i
Dolore277.i
Labore0.s
Deserunt00.i
Velit_90.s
Dolor_58.s
Sed_41.s
count.s = CkJsonObject::ckStringOf(jResp,"count")
next_page.s = CkJsonObject::ckStringOf(jResp,"next_page")
previous_page.s = CkJsonObject::ckStringOf(jResp,"previous_page")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"views")
While i < count_i
CkJsonObject::setCkI(jResp, i)
active = CkJsonObject::ckStringOf(jResp,"views[i].active")
Amet_b2 = CkJsonObject::ckStringOf(jResp,"views[i].conditions.amet_b2")
Pariatur_d74 = CkJsonObject::ckBoolOf(jResp,"views[i].conditions.pariatur_d74")
Eiusmodd7e = CkJsonObject::ckIntOf(jResp,"views[i].conditions.eiusmodd7e")
created_at = CkJsonObject::ckStringOf(jResp,"views[i].created_at")
default = CkJsonObject::ckStringOf(jResp,"views[i].default")
description = CkJsonObject::ckStringOf(jResp,"views[i].description")
Sit_bd1 = CkJsonObject::ckStringOf(jResp,"views[i].execution.sit_bd1")
Voluptated = CkJsonObject::ckIntOf(jResp,"views[i].execution.voluptated")
id = CkJsonObject::ckStringOf(jResp,"views[i].id")
position = CkJsonObject::ckStringOf(jResp,"views[i].position")
Officia_1c = CkJsonObject::ckStringOf(jResp,"views[i].restriction.officia_1c")
title = CkJsonObject::ckStringOf(jResp,"views[i].title")
updated_at = CkJsonObject::ckStringOf(jResp,"views[i].updated_at")
Do_99 = CkJsonObject::ckIntOf(jResp,"views[i].conditions.do_99")
Aliqua_ad = CkJsonObject::ckBoolOf(jResp,"views[i].conditions.aliqua_ad")
Dolore277 = CkJsonObject::ckIntOf(jResp,"views[i].conditions.dolore277")
Labore0 = CkJsonObject::ckStringOf(jResp,"views[i].conditions.labore0")
Deserunt00 = CkJsonObject::ckIntOf(jResp,"views[i].execution.deserunt00")
Velit_90 = CkJsonObject::ckStringOf(jResp,"views[i].execution.velit_90")
Dolor_58 = CkJsonObject::ckStringOf(jResp,"views[i].restriction.dolor_58")
Sed_41 = CkJsonObject::ckStringOf(jResp,"views[i].restriction.sed_41")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -G -d "query=%3Cstring%3E"
-d "access=%3Cstring%3E"
-d "active=%3Cboolean%3E"
-d "group_id=%3Cinteger%3E"
-d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-d "include=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/views/search
Postman Collection Item JSON
{
"name": "Search Views",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/views/search?query=<string>&access=<string>&active=<boolean>&group_id=<integer>&sort_by=<string>&sort_order=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find all views with matching title"
},
{
"key": "access",
"value": "<string>",
"description": "Filter views by access. May be \"personal\", \"shared\", or \"account\""
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active views if true or inactive views if false"
},
{
"key": "group_id",
"value": "<integer>",
"description": "Filter views by group"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", and \"position\". If unspecified, the views are sorted by relevance"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "include",
"value": "<string>",
"description": "A sideload to include in the response. See [Sideloads](#sideloads-3)"
}
]
},
"description": "#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Allowed For\n\n* Agents\n\n#### Sideloads\n\nThe following sideloads are supported. For more information, see [Side-loading](/documentation/ticketing/using-the-zendesk-api/side_loading/).\n\n| Name | Will sideload\n| ---------------- | -------------\n| app_installation | The app installation that requires each view, if present\n| permissions | The permissions for each view\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/search?query=<string>&access=<string>&active=<boolean>&group_id=<integer>&sort_by=<string>&sort_order=<string>&include=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"views",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) Query string used to find all views with matching title"
},
{
"key": "access",
"value": "<string>",
"description": "Filter views by access. May be \"personal\", \"shared\", or \"account\""
},
{
"key": "active",
"value": "<boolean>",
"description": "Filter by active views if true or inactive views if false"
},
{
"key": "group_id",
"value": "<integer>",
"description": "Filter views by group"
},
{
"key": "sort_by",
"value": "<string>",
"description": "Possible values are \"alphabetical\", \"created_at\", \"updated_at\", and \"position\". If unspecified, the views are sorted by relevance"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of \"asc\" or \"desc\". Defaults to \"asc\" for alphabetical and position sort, \"desc\" for all others"
},
{
"key": "include",
"value": "<string>",
"description": "A sideload to include in the response. See [Sideloads](#sideloads-3)"
}
]
}
},
"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}"
}
]
}
