delphiAx / Support API / Show Many Job Statuses
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
queryParams: TChilkatJsonObject;
resp: IChilkatHttpResponse;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
id: WideString;
message: WideString;
progress: WideString;
status: WideString;
total: WideString;
url: WideString;
j: Integer;
count_j: Integer;
index: WideString;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := TChilkatHttp.Create(Self);
http.BasicAuth := 1;
http.Login := 'login';
http.Password := 'password';
queryParams := TChilkatJsonObject.Create(Self);
queryParams.UpdateString('ids','<string>');
http.SetRequestHeader('Accept','application/json');
resp := http.QuickRequestParams('GET','https://example.zendesk.com/api/v2/job_statuses/show_many',queryParams.ControlInterface);
if (http.LastMethodSuccess = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
sbResponseBody := TChilkatStringBuilder.Create(Self);
resp.GetBodySb(sbResponseBody.ControlInterface);
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := resp.StatusCode;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(resp.Header);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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 do
begin
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 do
begin
jResp.J := j;
id := jResp.StringOf('job_statuses[i].results[j].id');
index := jResp.StringOf('job_statuses[i].results[j].index');
j := j + 1;
end;
i := i + 1;
end;
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}"
}
]
}