Chilkat Online Tools

Objective-C / Support API / Show Request

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

http.BasicAuth = YES;
http.Login = @"login";
http.Password = @"password";

[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://example.zendesk.com/api/v2/requests/:request_id" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "request": {
//     "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": {
//         "est__": false
//       }
//     }
//   }
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

NSString *strVal = 0;
NSString *id = 0;
NSString *value = 0;

NSString *Subject = [jResp StringOf: @"request.subject"];
NSString *Assignee_id = [jResp StringOf: @"request.assignee_id"];
NSString *Can_be_solved_by_me = [jResp StringOf: @"request.can_be_solved_by_me"];
NSString *Created_at = [jResp StringOf: @"request.created_at"];
NSString *Custom_status_id = [jResp StringOf: @"request.custom_status_id"];
NSString *Description = [jResp StringOf: @"request.description"];
NSString *Due_at = [jResp StringOf: @"request.due_at"];
NSString *Followup_source_id = [jResp StringOf: @"request.followup_source_id"];
NSString *Group_id = [jResp StringOf: @"request.group_id"];
NSString *Id = [jResp StringOf: @"request.id"];
NSString *Is_public = [jResp StringOf: @"request.is_public"];
NSString *Organization_id = [jResp StringOf: @"request.organization_id"];
NSString *Priority = [jResp StringOf: @"request.priority"];
NSString *Recipient = [jResp StringOf: @"request.recipient"];
NSString *Requester_id = [jResp StringOf: @"request.requester_id"];
NSString *Solved = [jResp StringOf: @"request.solved"];
NSString *Status = [jResp StringOf: @"request.status"];
NSString *Ticket_form_id = [jResp StringOf: @"request.ticket_form_id"];
NSString *v_Type = [jResp StringOf: @"request.type"];
NSString *Updated_at = [jResp StringOf: @"request.updated_at"];
NSString *v_Url = [jResp StringOf: @"request.url"];
NSString *Channel = [jResp StringOf: @"request.via.channel"];
BOOL Est__ = [jResp BoolOf: @"request.via.source.est__"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"request.collaborator_ids"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"request.collaborator_ids[i]"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"request.custom_fields"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"request.custom_fields[i].id"];
    value = [jResp StringOf: @"request.custom_fields[i].value"];
    i = i + 1;
}

i = 0;
count_i = [[jResp SizeOfArray: @"request.email_cc_ids"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    strVal = [jResp StringOf: @"request.email_cc_ids[i]"];
    i = i + 1;
}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/requests/:request_id

Postman Collection Item JSON

{
  "name": "Show Request",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/requests/:request_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "requests",
        ":request_id"
      ],
      "variable": [
        {
          "key": "request_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Sideloads\n\nThe following sideloads are supported:\n\n| Name             | Will sideload\n| ---------------- | -------------\n| users            | The email ccs for a request by side-loading users\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/:request_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "requests",
            ":request_id"
          ],
          "variable": [
            {
              "key": "request_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"request\": {\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        \"est__\": false\n      }\n    }\n  }\n}"
    }
  ]
}