Chilkat Online Tools

VB6 / Support API / Search Requests

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 ChilkatHttp
Dim success As Long

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

http.SetRequestHeader "Accept","application/json"

Dim sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/requests/search",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

Debug.Print "Response Body:"
Debug.Print jResp.Emit()

Dim respStatusCode As Long
respStatusCode = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

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

' {
'   "requests": [
'     {
'       "subject": "<string>",
'       "assignee_id": "<integer>",
'       "can_be_solved_by_me": "<boolean>",
'       "collaborator_ids": [
'         "<integer>",
'         "<integer>"
'       ],
'       "created_at": "<dateTime>",
'       "custom_fields": [
'         {
'           "id": "<integer>",
'           "value": "<string>"
'         },
'         {
'           "id": "<integer>",
'           "value": "<string>"
'         }
'       ],
'       "custom_status_id": "<integer>",
'       "description": "<string>",
'       "due_at": "<dateTime>",
'       "email_cc_ids": [
'         "<integer>",
'         "<integer>"
'       ],
'       "followup_source_id": "<integer>",
'       "group_id": "<integer>",
'       "id": "<integer>",
'       "is_public": "<boolean>",
'       "organization_id": "<integer>",
'       "priority": "<string>",
'       "recipient": "<string>",
'       "requester_id": "<integer>",
'       "solved": "<boolean>",
'       "status": "<string>",
'       "ticket_form_id": "<integer>",
'       "type": "<string>",
'       "updated_at": "<dateTime>",
'       "url": "<string>",
'       "via": {
'         "channel": "<string>",
'         "source": {
'           "sitde": -5925380.425592765,
'           "id80": false
'         }
'       }
'     },
'     {
'       "subject": "<string>",
'       "assignee_id": "<integer>",
'       "can_be_solved_by_me": "<boolean>",
'       "collaborator_ids": [
'         "<integer>",
'         "<integer>"
'       ],
'       "created_at": "<dateTime>",
'       "custom_fields": [
'         {
'           "id": "<integer>",
'           "value": "<string>"
'         },
'         {
'           "id": "<integer>",
'           "value": "<string>"
'         }
'       ],
'       "custom_status_id": "<integer>",
'       "description": "<string>",
'       "due_at": "<dateTime>",
'       "email_cc_ids": [
'         "<integer>",
'         "<integer>"
'       ],
'       "followup_source_id": "<integer>",
'       "group_id": "<integer>",
'       "id": "<integer>",
'       "is_public": "<boolean>",
'       "organization_id": "<integer>",
'       "priority": "<string>",
'       "recipient": "<string>",
'       "requester_id": "<integer>",
'       "solved": "<boolean>",
'       "status": "<string>",
'       "ticket_form_id": "<integer>",
'       "type": "<string>",
'       "updated_at": "<dateTime>",
'       "url": "<string>",
'       "via": {
'         "channel": "<string>",
'         "source": {
'           "esse2a": false,
'           "irure_8": true,
'           "in77": 99886237.33060426,
'           "nisi_0": "occaecat velit voluptate consequat"
'         }
'       }
'     }
'   ]
' }

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

Dim subject As String
Dim assignee_id As String
Dim can_be_solved_by_me As String
Dim created_at As String
Dim custom_status_id As String
Dim description As String
Dim due_at As String
Dim followup_source_id As String
Dim group_id As String
Dim id As String
Dim is_public As String
Dim organization_id As String
Dim priority As String
Dim recipient As String
Dim requester_id As String
Dim solved As String
Dim status As String
Dim ticket_form_id As String
Dim v_type As String
Dim updated_at As String
Dim url As String
Dim Channel As String
Dim Sitde As String
Dim Id80 As Long
Dim Esse2a As Long
Dim Irure_8 As Long
Dim In77 As String
Dim Nisi_0 As String
Dim j As Long
Dim count_j As Long
Dim strVal As String
Dim value As String

Dim i As Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("requests")
Do While i < count_i
    jResp.I = i
    subject = jResp.StringOf("requests[i].subject")
    assignee_id = jResp.StringOf("requests[i].assignee_id")
    can_be_solved_by_me = jResp.StringOf("requests[i].can_be_solved_by_me")
    created_at = jResp.StringOf("requests[i].created_at")
    custom_status_id = jResp.StringOf("requests[i].custom_status_id")
    description = jResp.StringOf("requests[i].description")
    due_at = jResp.StringOf("requests[i].due_at")
    followup_source_id = jResp.StringOf("requests[i].followup_source_id")
    group_id = jResp.StringOf("requests[i].group_id")
    id = jResp.StringOf("requests[i].id")
    is_public = jResp.StringOf("requests[i].is_public")
    organization_id = jResp.StringOf("requests[i].organization_id")
    priority = jResp.StringOf("requests[i].priority")
    recipient = jResp.StringOf("requests[i].recipient")
    requester_id = jResp.StringOf("requests[i].requester_id")
    solved = jResp.StringOf("requests[i].solved")
    status = jResp.StringOf("requests[i].status")
    ticket_form_id = jResp.StringOf("requests[i].ticket_form_id")
    v_type = jResp.StringOf("requests[i].type")
    updated_at = jResp.StringOf("requests[i].updated_at")
    url = jResp.StringOf("requests[i].url")
    Channel = jResp.StringOf("requests[i].via.channel")
    Sitde = jResp.StringOf("requests[i].via.source.sitde")
    Id80 = jResp.BoolOf("requests[i].via.source.id80")
    Esse2a = jResp.BoolOf("requests[i].via.source.esse2a")
    Irure_8 = jResp.BoolOf("requests[i].via.source.irure_8")
    In77 = jResp.StringOf("requests[i].via.source.in77")
    Nisi_0 = jResp.StringOf("requests[i].via.source.nisi_0")
    j = 0
    count_j = jResp.SizeOfArray("requests[i].collaborator_ids")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("requests[i].collaborator_ids[j]")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("requests[i].custom_fields")
    Do While j < count_j
        jResp.J = j
        id = jResp.StringOf("requests[i].custom_fields[j].id")
        value = jResp.StringOf("requests[i].custom_fields[j].value")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("requests[i].email_cc_ids")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("requests[i].email_cc_ids[j]")
        j = j + 1
    Loop
    i = i + 1
Loop

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/search

Postman Collection Item JSON

{
  "name": "Search Requests",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests/search",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests",
        "search"
      ],
      "variable": [
        {
          "key": "query",
          "value": "<string>",
          "description": "The syntax and matching logic for the string is detailed in the [Zendesk Support search reference](https://support.zendesk.com/hc/en-us/articles/203663226). See also [Query basics](/api-reference/ticketing/ticket-management/search/#query-basics) in the Tickets API doc."
        }
      ]
    },
    "description": "Examples:\n\n* `GET /api/v2/requests/search.json?query=printer`\n* `GET /api/v2/requests/search.json?query=printer&organization_id=1`\n* `GET /api/v2/requests/search.json?query=printer&cc_id=true`\n* `GET /api/v2/requests/search.json?query=printer&status=hold,open`\n\n#### Pagination\n\n* Offset pagination only\n\nSee [Using Offset Pagination](/api-reference/ticketing/introduction/#using-offset-pagination).\n\n#### Results limit\n\nThe Search Requests endpoint returns up to 1,000 results per query, with a maximum of 100 results per page. See [Pagination](/api-reference/ticketing/introduction/#pagination). If you request a page past the limit (`page=11` at 100 results per page), a 422 Insufficient Resource Error is returned.\n\n#### Allowed For\n\n* End Users\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/requests/search",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests",
            "search"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"requests\": [\n    {\n      \"subject\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"can_be_solved_by_me\": \"<boolean>\",\n      \"collaborator_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": [\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"followup_source_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester_id\": \"<integer>\",\n      \"solved\": \"<boolean>\",\n      \"status\": \"<string>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"sitde\": -5925380.425592765,\n          \"id80\": false\n        }\n      }\n    },\n    {\n      \"subject\": \"<string>\",\n      \"assignee_id\": \"<integer>\",\n      \"can_be_solved_by_me\": \"<boolean>\",\n      \"collaborator_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"created_at\": \"<dateTime>\",\n      \"custom_fields\": [\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"value\": \"<string>\"\n        }\n      ],\n      \"custom_status_id\": \"<integer>\",\n      \"description\": \"<string>\",\n      \"due_at\": \"<dateTime>\",\n      \"email_cc_ids\": [\n        \"<integer>\",\n        \"<integer>\"\n      ],\n      \"followup_source_id\": \"<integer>\",\n      \"group_id\": \"<integer>\",\n      \"id\": \"<integer>\",\n      \"is_public\": \"<boolean>\",\n      \"organization_id\": \"<integer>\",\n      \"priority\": \"<string>\",\n      \"recipient\": \"<string>\",\n      \"requester_id\": \"<integer>\",\n      \"solved\": \"<boolean>\",\n      \"status\": \"<string>\",\n      \"ticket_form_id\": \"<integer>\",\n      \"type\": \"<string>\",\n      \"updated_at\": \"<dateTime>\",\n      \"url\": \"<string>\",\n      \"via\": {\n        \"channel\": \"<string>\",\n        \"source\": {\n          \"esse2a\": false,\n          \"irure_8\": true,\n          \"in77\": 99886237.33060426,\n          \"nisi_0\": \"occaecat velit voluptate consequat\"\n        }\n      }\n    }\n  ]\n}"
    }
  ]
}