Chilkat Online Tools

Objective-C / Support API / Show Many Job Statuses

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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";

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"ids" value: @"<string>"];

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

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://example.zendesk.com/api/v2/job_statuses/show_many" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];

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

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

int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",resp.Header);
    NSLog(@"%@",@"Failed.");

    return;
}

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

// {
//   "job_statuses": [
//     {
//       "id": "<string>",
//       "message": "<string>",
//       "progress": "<integer>",
//       "results": [
//         {
//           "id": "<integer>",
//           "index": "<integer>"
//         },
//         {
//           "id": "<integer>",
//           "index": "<integer>"
//         }
//       ],
//       "status": "<string>",
//       "total": "<integer>",
//       "url": "<string>"
//     },
//     {
//       "id": "<string>",
//       "message": "<string>",
//       "progress": "<integer>",
//       "results": [
//         {
//           "id": "<integer>",
//           "index": "<integer>"
//         },
//         {
//           "id": "<integer>",
//           "index": "<integer>"
//         }
//       ],
//       "status": "<string>",
//       "total": "<integer>",
//       "url": "<string>"
//     }
//   ]
// }

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

NSString *id = 0;
NSString *message = 0;
NSString *progress = 0;
NSString *status = 0;
NSString *total = 0;
NSString *url = 0;
int j;
int count_j;
NSString *index = 0;

int i = 0;
int count_i = [[jResp SizeOfArray: @"job_statuses"] intValue];
while (i < count_i) {
    jResp.I = [NSNumber numberWithInt: i];
    id = [jResp StringOf: @"job_statuses[i].id"];
    message = [jResp StringOf: @"job_statuses[i].message"];
    progress = [jResp StringOf: @"job_statuses[i].progress"];
    status = [jResp StringOf: @"job_statuses[i].status"];
    total = [jResp StringOf: @"job_statuses[i].total"];
    url = [jResp StringOf: @"job_statuses[i].url"];
    j = 0;
    count_j = [[jResp SizeOfArray: @"job_statuses[i].results"] intValue];
    while (j < count_j) {
        jResp.J = [NSNumber numberWithInt: j];
        id = [jResp StringOf: @"job_statuses[i].results[j].id"];
        index = [jResp StringOf: @"job_statuses[i].results[j].index"];
        j = j + 1;
    }

    i = i + 1;
}

Curl Command

curl  -u login:password -G -d "ids=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/job_statuses/show_many

Postman Collection Item JSON

{
  "name": "Show Many Job Statuses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/job_statuses/show_many?ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "job_statuses",
        "show_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "(Required) Comma-separated list of job status ids."
        }
      ]
    },
    "description": "Accepts a comma-separated list of job status ids.\n\n#### Allowed For:\n\n* Agents\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/job_statuses/show_many?ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "job_statuses",
            "show_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "(Required) Comma-separated list of job status ids."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"job_statuses\": [\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"message\": \"<string>\",\n      \"progress\": \"<integer>\",\n      \"results\": [\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        },\n        {\n          \"id\": \"<integer>\",\n          \"index\": \"<integer>\"\n        }\n      ],\n      \"status\": \"<string>\",\n      \"total\": \"<integer>\",\n      \"url\": \"<string>\"\n    }\n  ]\n}"
    }
  ]
}