phpAx / Support API / Show Many Job Statuses
Back to Collection Items
<?php
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new COM("Chilkat_9_5_0.Http");
$http->BasicAuth = 1;
$http->Login = 'login';
$http->Password = 'password';
$queryParams = new COM("Chilkat_9_5_0.JsonObject");
$queryParams->UpdateString('ids','<string>');
$http->SetRequestHeader('Accept','application/json');
// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequestParams('GET','https://example.zendesk.com/api/v2/job_statuses/show_many',$queryParams);
if ($http->LastMethodSuccess == 0) {
print $http->LastErrorText . "\n";
exit;
}
$sbResponseBody = new COM("Chilkat_9_5_0.StringBuilder");
$resp->GetBodySb($sbResponseBody);
$jResp = new COM("Chilkat_9_5_0.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $resp->Header . "\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->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->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 -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}"
}
]
}