Chilkat Online Tools

unicodeCpp / Support API / Search Requests

Back to Collection Items

#include <CkHttpW.h>
#include <CkStringBuilderW.h>
#include <CkJsonObjectW.h>

void ChilkatSample(void)
    {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttpW http;
    bool success;

    http.put_BasicAuth(true);
    http.put_Login(L"login");
    http.put_Password(L"password");

    http.SetRequestHeader(L"Accept",L"application/json");

    CkStringBuilderW sbResponseBody;
    success = http.QuickGetSb(L"https://example.zendesk.com/api/v2/requests/search",sbResponseBody);
    if (success == false) {
        wprintf(L"%s\n",http.lastErrorText());
        return;
    }

    CkJsonObjectW jResp;
    jResp.LoadSb(sbResponseBody);
    jResp.put_EmitCompact(false);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",jResp.emit());

    int respStatusCode = http.get_LastStatus();
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",http.lastHeader());
        wprintf(L"Failed.\n");
        return;
    }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    const wchar_t *subject = 0;
    const wchar_t *assignee_id = 0;
    const wchar_t *can_be_solved_by_me = 0;
    const wchar_t *created_at = 0;
    const wchar_t *custom_status_id = 0;
    const wchar_t *description = 0;
    const wchar_t *due_at = 0;
    const wchar_t *followup_source_id = 0;
    const wchar_t *group_id = 0;
    const wchar_t *id = 0;
    const wchar_t *is_public = 0;
    const wchar_t *organization_id = 0;
    const wchar_t *priority = 0;
    const wchar_t *recipient = 0;
    const wchar_t *requester_id = 0;
    const wchar_t *solved = 0;
    const wchar_t *status = 0;
    const wchar_t *ticket_form_id = 0;
    const wchar_t *v_type = 0;
    const wchar_t *updated_at = 0;
    const wchar_t *url = 0;
    const wchar_t *Channel = 0;
    const wchar_t *Sitde = 0;
    bool Id80;
    bool Esse2a;
    bool Irure_8;
    const wchar_t *In77 = 0;
    const wchar_t *Nisi_0 = 0;
    int j;
    int count_j;
    const wchar_t *strVal = 0;
    const wchar_t *value = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray(L"requests");
    while (i < count_i) {
        jResp.put_I(i);
        subject = jResp.stringOf(L"requests[i].subject");
        assignee_id = jResp.stringOf(L"requests[i].assignee_id");
        can_be_solved_by_me = jResp.stringOf(L"requests[i].can_be_solved_by_me");
        created_at = jResp.stringOf(L"requests[i].created_at");
        custom_status_id = jResp.stringOf(L"requests[i].custom_status_id");
        description = jResp.stringOf(L"requests[i].description");
        due_at = jResp.stringOf(L"requests[i].due_at");
        followup_source_id = jResp.stringOf(L"requests[i].followup_source_id");
        group_id = jResp.stringOf(L"requests[i].group_id");
        id = jResp.stringOf(L"requests[i].id");
        is_public = jResp.stringOf(L"requests[i].is_public");
        organization_id = jResp.stringOf(L"requests[i].organization_id");
        priority = jResp.stringOf(L"requests[i].priority");
        recipient = jResp.stringOf(L"requests[i].recipient");
        requester_id = jResp.stringOf(L"requests[i].requester_id");
        solved = jResp.stringOf(L"requests[i].solved");
        status = jResp.stringOf(L"requests[i].status");
        ticket_form_id = jResp.stringOf(L"requests[i].ticket_form_id");
        v_type = jResp.stringOf(L"requests[i].type");
        updated_at = jResp.stringOf(L"requests[i].updated_at");
        url = jResp.stringOf(L"requests[i].url");
        Channel = jResp.stringOf(L"requests[i].via.channel");
        Sitde = jResp.stringOf(L"requests[i].via.source.sitde");
        Id80 = jResp.BoolOf(L"requests[i].via.source.id80");
        Esse2a = jResp.BoolOf(L"requests[i].via.source.esse2a");
        Irure_8 = jResp.BoolOf(L"requests[i].via.source.irure_8");
        In77 = jResp.stringOf(L"requests[i].via.source.in77");
        Nisi_0 = jResp.stringOf(L"requests[i].via.source.nisi_0");
        j = 0;
        count_j = jResp.SizeOfArray(L"requests[i].collaborator_ids");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"requests[i].collaborator_ids[j]");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"requests[i].custom_fields");
        while (j < count_j) {
            jResp.put_J(j);
            id = jResp.stringOf(L"requests[i].custom_fields[j].id");
            value = jResp.stringOf(L"requests[i].custom_fields[j].value");
            j = j + 1;
        }

        j = 0;
        count_j = jResp.SizeOfArray(L"requests[i].email_cc_ids");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf(L"requests[i].email_cc_ids[j]");
            j = j + 1;
        }

        i = i + 1;
    }
    }

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