Chilkat Online Tools

phpExt / Support API / List Job Statuses

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('login');
$http->put_Password('password');

$http->SetRequestHeader('Accept','application/json');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/job_statuses',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

$i = 0;
$count_i = $jResp->SizeOfArray('job_statuses');
while ($i < $count_i) {
    $jResp->put_I($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');
    while ($j < $count_j) {
        $jResp->put_J($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 -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/job_statuses

Postman Collection Item JSON

{
  "name": "List Job Statuses",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/job_statuses",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "job_statuses"
      ]
    },
    "description": "Shows the statuses for background jobs. Statuses are sorted first by completion date and then by creation date in descending order.\n\n#### Allowed For:\n\n* Agents\n\n#### Pagination\n\n* Cursor pagination\n\nSee [Pagination](/api-reference/introduction/pagination/#using-cursor-pagination).\n\nReturns a maximum of 100 records per page sorted by `completed_at desc, created_at desc`. Does not allow any other sort order.\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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "job_statuses"
          ]
        }
      },
      "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}"
    }
  ]
}