VB.NET / Support API / List Search Results
Back to Collection Items
' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.
Dim http As New Chilkat.Http
Dim success As Boolean
http.BasicAuth = True
http.Login = "login"
http.Password = "password"
Dim queryParams As New Chilkat.JsonObject
queryParams.UpdateString("query","<string>")
queryParams.UpdateString("sort_by","<string>")
queryParams.UpdateString("sort_order","<string>")
http.SetRequestHeader("Accept","application/json")
Dim resp As Chilkat.HttpResponse = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/search",queryParams)
If (http.LastMethodSuccess = False) Then
Debug.WriteLine(http.LastErrorText)
Exit Sub
End If
Dim sbResponseBody As New Chilkat.StringBuilder
resp.GetBodySb(sbResponseBody)
Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())
Dim respStatusCode As Integer = resp.StatusCode
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
Debug.WriteLine("Response Header:")
Debug.WriteLine(resp.Header)
Debug.WriteLine("Failed.")
Exit Sub
End If
' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)
' {
' "count": "<integer>",
' "facets": "<string>",
' "next_page": "<string>",
' "previous_page": "<string>",
' "results": [
' {
' "created_at": "<string>",
' "default": "<boolean>",
' "deleted": "<boolean>",
' "description": "<string>",
' "id": "<integer>",
' "name": "<string>",
' "result_type": "<string>",
' "updated_at": "<string>",
' "url": "<string>"
' },
' {
' "created_at": "<string>",
' "default": "<boolean>",
' "deleted": "<boolean>",
' "description": "<string>",
' "id": "<integer>",
' "name": "<string>",
' "result_type": "<string>",
' "updated_at": "<string>",
' "url": "<string>"
' }
' ]
' }
' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Dim created_at As String
Dim default As String
Dim deleted As String
Dim description As String
Dim id As String
Dim name As String
Dim result_type As String
Dim updated_at As String
Dim url As String
Dim count As String = jResp.StringOf("count")
Dim facets As String = jResp.StringOf("facets")
Dim next_page As String = jResp.StringOf("next_page")
Dim previous_page As String = jResp.StringOf("previous_page")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("results")
While i < count_i
jResp.I = i
created_at = jResp.StringOf("results[i].created_at")
default = jResp.StringOf("results[i].default")
deleted = jResp.StringOf("results[i].deleted")
description = jResp.StringOf("results[i].description")
id = jResp.StringOf("results[i].id")
name = jResp.StringOf("results[i].name")
result_type = jResp.StringOf("results[i].result_type")
updated_at = jResp.StringOf("results[i].updated_at")
url = jResp.StringOf("results[i].url")
i = i + 1
End While
Curl Command
curl -u login:password -G -d "query=%3Cstring%3E"
-d "sort_by=%3Cstring%3E"
-d "sort_order=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/search
Postman Collection Item JSON
{
"name": "List Search Results",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/search?query=<string>&sort_by=<string>&sort_order=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226)"
},
{
"key": "sort_by",
"value": "<string>",
"description": "One of `updated_at`, `created_at`, `priority`, `status`, or `ticket_type`. Defaults to sorting by relevance"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of `asc` or `desc`. Defaults to `desc`"
}
]
},
"description": "Use the ampersand character (&) to append the `sort_by` or `sort_order` parameters to the URL.\n\nFor examples, see [Searching with Zendesk API](/documentation/ticketing/using-the-zendesk-api/searching-with-the-zendesk-api).\n\n#### Pagination\n\n* Offset pagination only\n\nOffset pagination may result in duplicate results when paging. You can also use the \n[Export Search Results](/api-reference/ticketing/ticket-management/search/#export-search-results) endpoint, which \nuses cursor-based pagination and doesn't return duplicate results. See \n[Pagination](/api-reference/introduction/pagination/) for more information.\n\n#### Allowed For\n\n* Admins, Agents and Light Agents\n\n\n#### Errors JSON Format\n\nErrors are represented as JSON objects which have the following keys:\n\n| Name | Type | Comment\n| --------------------- | ---------------------| --------------------\n| error | string | The type of error. Examples: \"unavailable\", \"invalid\"\n| description | string |\n\n##### Example Error\n```js\n{\n \"error\": \"unavailable\",\n \"description\": \"Sorry, we could not complete your search query. Please try again in a moment.\"\n}\n```\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/search?query=<string>&sort_by=<string>&sort_order=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"search"
],
"query": [
{
"key": "query",
"value": "<string>",
"description": "(Required) The search query. See [Query basics](#query-basics) above. For details on the query syntax, see the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226)"
},
{
"key": "sort_by",
"value": "<string>",
"description": "One of `updated_at`, `created_at`, `priority`, `status`, or `ticket_type`. Defaults to sorting by relevance"
},
{
"key": "sort_order",
"value": "<string>",
"description": "One of `asc` or `desc`. Defaults to `desc`"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"count\": \"<integer>\",\n \"facets\": \"<string>\",\n \"next_page\": \"<string>\",\n \"previous_page\": \"<string>\",\n \"results\": [\n {\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"deleted\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"result_type\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"created_at\": \"<string>\",\n \"default\": \"<boolean>\",\n \"deleted\": \"<boolean>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"result_type\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\"\n }\n ]\n}"
}
]
}
