Chilkat Tools

delphiDll / Support API / Search Requests

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
subject: PWideChar;
assignee_id: PWideChar;
can_be_solved_by_me: PWideChar;
created_at: PWideChar;
custom_status_id: PWideChar;
description: PWideChar;
due_at: PWideChar;
followup_source_id: PWideChar;
group_id: PWideChar;
id: PWideChar;
is_public: PWideChar;
organization_id: PWideChar;
priority: PWideChar;
recipient: PWideChar;
requester_id: PWideChar;
solved: PWideChar;
status: PWideChar;
ticket_form_id: PWideChar;
v_type: PWideChar;
updated_at: PWideChar;
url: PWideChar;
Channel: PWideChar;
Sitde: PWideChar;
Id80: Boolean;
Esse2a: Boolean;
Irure_8: Boolean;
In77: PWideChar;
Nisi_0: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
value: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/requests/search',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'requests');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    subject := CkJsonObject__stringOf(jResp,'requests[i].subject');
    assignee_id := CkJsonObject__stringOf(jResp,'requests[i].assignee_id');
    can_be_solved_by_me := CkJsonObject__stringOf(jResp,'requests[i].can_be_solved_by_me');
    created_at := CkJsonObject__stringOf(jResp,'requests[i].created_at');
    custom_status_id := CkJsonObject__stringOf(jResp,'requests[i].custom_status_id');
    description := CkJsonObject__stringOf(jResp,'requests[i].description');
    due_at := CkJsonObject__stringOf(jResp,'requests[i].due_at');
    followup_source_id := CkJsonObject__stringOf(jResp,'requests[i].followup_source_id');
    group_id := CkJsonObject__stringOf(jResp,'requests[i].group_id');
    id := CkJsonObject__stringOf(jResp,'requests[i].id');
    is_public := CkJsonObject__stringOf(jResp,'requests[i].is_public');
    organization_id := CkJsonObject__stringOf(jResp,'requests[i].organization_id');
    priority := CkJsonObject__stringOf(jResp,'requests[i].priority');
    recipient := CkJsonObject__stringOf(jResp,'requests[i].recipient');
    requester_id := CkJsonObject__stringOf(jResp,'requests[i].requester_id');
    solved := CkJsonObject__stringOf(jResp,'requests[i].solved');
    status := CkJsonObject__stringOf(jResp,'requests[i].status');
    ticket_form_id := CkJsonObject__stringOf(jResp,'requests[i].ticket_form_id');
    v_type := CkJsonObject__stringOf(jResp,'requests[i].type');
    updated_at := CkJsonObject__stringOf(jResp,'requests[i].updated_at');
    url := CkJsonObject__stringOf(jResp,'requests[i].url');
    Channel := CkJsonObject__stringOf(jResp,'requests[i].via.channel');
    Sitde := CkJsonObject__stringOf(jResp,'requests[i].via.source.sitde');
    Id80 := CkJsonObject_BoolOf(jResp,'requests[i].via.source.id80');
    Esse2a := CkJsonObject_BoolOf(jResp,'requests[i].via.source.esse2a');
    Irure_8 := CkJsonObject_BoolOf(jResp,'requests[i].via.source.irure_8');
    In77 := CkJsonObject__stringOf(jResp,'requests[i].via.source.in77');
    Nisi_0 := CkJsonObject__stringOf(jResp,'requests[i].via.source.nisi_0');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'requests[i].collaborator_ids');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'requests[i].collaborator_ids[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'requests[i].custom_fields');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        id := CkJsonObject__stringOf(jResp,'requests[i].custom_fields[j].id');
        value := CkJsonObject__stringOf(jResp,'requests[i].custom_fields[j].value');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'requests[i].email_cc_ids');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'requests[i].email_cc_ids[j]');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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

Chilkat Online Tools

delphiDll / Support API / Search Requests

Curl Command

Postman Collection Item JSON