Chilkat Online Tools

autoit / 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.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"

$oHttp.SetRequestHeader "Accept","application/json"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/requests/search",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $subject
Local $sAssignee_id
Local $sCan_be_solved_by_me
Local $sCreated_at
Local $sCustom_status_id
Local $sDescription
Local $sDue_at
Local $sFollowup_source_id
Local $sGroup_id
Local $sId
Local $sIs_public
Local $sOrganization_id
Local $sPriority
Local $sRecipient
Local $sRequester_id
Local $solved
Local $status
Local $sTicket_form_id
Local $sV_type
Local $sUpdated_at
Local $sUrl
Local $sChannel
Local $sSitde
Local $bId80
Local $bEsse2a
Local $bIrure_8
Local $sIn77
Local $sNisi_0
Local $iJ
Local $iCount_j
Local $strVal
Local $sValue

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("requests")
While $i < $iCount_i
    $oJResp.I = $i
    $subject = $oJResp.StringOf("requests[i].subject")
    $sAssignee_id = $oJResp.StringOf("requests[i].assignee_id")
    $sCan_be_solved_by_me = $oJResp.StringOf("requests[i].can_be_solved_by_me")
    $sCreated_at = $oJResp.StringOf("requests[i].created_at")
    $sCustom_status_id = $oJResp.StringOf("requests[i].custom_status_id")
    $sDescription = $oJResp.StringOf("requests[i].description")
    $sDue_at = $oJResp.StringOf("requests[i].due_at")
    $sFollowup_source_id = $oJResp.StringOf("requests[i].followup_source_id")
    $sGroup_id = $oJResp.StringOf("requests[i].group_id")
    $sId = $oJResp.StringOf("requests[i].id")
    $sIs_public = $oJResp.StringOf("requests[i].is_public")
    $sOrganization_id = $oJResp.StringOf("requests[i].organization_id")
    $sPriority = $oJResp.StringOf("requests[i].priority")
    $sRecipient = $oJResp.StringOf("requests[i].recipient")
    $sRequester_id = $oJResp.StringOf("requests[i].requester_id")
    $solved = $oJResp.StringOf("requests[i].solved")
    $status = $oJResp.StringOf("requests[i].status")
    $sTicket_form_id = $oJResp.StringOf("requests[i].ticket_form_id")
    $sV_type = $oJResp.StringOf("requests[i].type")
    $sUpdated_at = $oJResp.StringOf("requests[i].updated_at")
    $sUrl = $oJResp.StringOf("requests[i].url")
    $sChannel = $oJResp.StringOf("requests[i].via.channel")
    $sSitde = $oJResp.StringOf("requests[i].via.source.sitde")
    $bId80 = $oJResp.BoolOf("requests[i].via.source.id80")
    $bEsse2a = $oJResp.BoolOf("requests[i].via.source.esse2a")
    $bIrure_8 = $oJResp.BoolOf("requests[i].via.source.irure_8")
    $sIn77 = $oJResp.StringOf("requests[i].via.source.in77")
    $sNisi_0 = $oJResp.StringOf("requests[i].via.source.nisi_0")
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("requests[i].collaborator_ids")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $strVal = $oJResp.StringOf("requests[i].collaborator_ids[j]")
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("requests[i].custom_fields")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $sId = $oJResp.StringOf("requests[i].custom_fields[j].id")
        $sValue = $oJResp.StringOf("requests[i].custom_fields[j].value")
        $iJ = $iJ + 1
    Wend
    $iJ = 0
    $iCount_j = $oJResp.SizeOfArray("requests[i].email_cc_ids")
    While $iJ < $iCount_j
        $oJResp.J = $iJ
        $strVal = $oJResp.StringOf("requests[i].email_cc_ids[j]")
        $iJ = $iJ + 1
    Wend
    $i = $i + 1
Wend

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}"
    }
  ]
}