Chilkat Online Tools

C++ / Support API / List Requests

Back to Collection Items

#include <CkHttp.h>
#include <CkStringBuilder.h>
#include <CkJsonObject.h>

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

    CkHttp http;
    bool success;

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

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

    CkStringBuilder sbResponseBody;
    success = http.QuickGetSb("https://example.zendesk.com/api/v2/requests",sbResponseBody);
    if (success == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

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

    std::cout << "Response Body:" << "\r\n";
    std::cout << jResp.emit() << "\r\n";

    int respStatusCode = http.get_LastStatus();
    std::cout << "Response Status Code = " << respStatusCode << "\r\n";
    if (respStatusCode >= 400) {
        std::cout << "Response Header:" << "\r\n";
        std::cout << http.lastHeader() << "\r\n";
        std::cout << "Failed." << "\r\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 char *subject = 0;
    const char *assignee_id = 0;
    const char *can_be_solved_by_me = 0;
    const char *created_at = 0;
    const char *custom_status_id = 0;
    const char *description = 0;
    const char *due_at = 0;
    const char *followup_source_id = 0;
    const char *group_id = 0;
    const char *id = 0;
    const char *is_public = 0;
    const char *organization_id = 0;
    const char *priority = 0;
    const char *recipient = 0;
    const char *requester_id = 0;
    const char *solved = 0;
    const char *status = 0;
    const char *ticket_form_id = 0;
    const char *v_type = 0;
    const char *updated_at = 0;
    const char *url = 0;
    const char *Channel = 0;
    const char *Sitde = 0;
    bool Id80;
    bool Esse2a;
    bool Irure_8;
    const char *In77 = 0;
    const char *Nisi_0 = 0;
    int j;
    int count_j;
    const char *strVal = 0;
    const char *value = 0;

    int i = 0;
    int count_i = jResp.SizeOfArray("requests");
    while (i < count_i) {
        jResp.put_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");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf("requests[i].collaborator_ids[j]");
            j = j + 1;
        }

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

        j = 0;
        count_j = jResp.SizeOfArray("requests[i].email_cc_ids");
        while (j < count_j) {
            jResp.put_J(j);
            strVal = jResp.stringOf("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

Postman Collection Item JSON

{
  "name": "List Requests",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests"
      ],
      "variable": [
        {
          "key": "sort_by",
          "value": "<string>",
          "description": "Possible values are \"updated_at\", \"created_at\""
        },
        {
          "key": "sort_order",
          "value": "<string>",
          "description": "One of \"asc\", \"desc\". Defaults to \"asc\""
        }
      ]
    },
    "description": "#### 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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests"
          ]
        }
      },
      "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}"
    }
  ]
}