Chilkat Online Tools

C# / Support API / List Requests

Back to Collection Items

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

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "login";
http.Password = "password";

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://example.zendesk.com/api/v2/requests",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    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

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

int i = 0;
int count_i = jResp.SizeOfArray("requests");
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");
    while (j < count_j) {
        jResp.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.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.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}"
    }
  ]
}