delphiAx / Support API / Show Request
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
strVal: WideString;
id: WideString;
value: WideString;
Subject: WideString;
Assignee_id: WideString;
Can_be_solved_by_me: WideString;
Created_at: WideString;
Custom_status_id: WideString;
Description: WideString;
Due_at: WideString;
Followup_source_id: WideString;
Group_id: WideString;
Id: WideString;
Is_public: WideString;
Organization_id: WideString;
Priority: WideString;
Recipient: WideString;
Requester_id: WideString;
Solved: WideString;
Status: WideString;
Ticket_form_id: WideString;
v_Type: WideString;
Updated_at: WideString;
v_Url: WideString;
Channel: WideString;
Est__: Integer;
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';
http.SetRequestHeader('Accept','application/json');
sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://example.zendesk.com/api/v2/requests/:request_id',sbResponseBody.ControlInterface);
if (success = 0) then
begin
Memo1.Lines.Add(http.LastErrorText);
Exit;
end;
jResp := TChilkatJsonObject.Create(Self);
jResp.LoadSb(sbResponseBody.ControlInterface);
jResp.EmitCompact := 0;
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jResp.Emit());
respStatusCode := http.LastStatus;
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(http.LastHeader);
Memo1.Lines.Add('Failed.');
Exit;
end;
// 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
Subject := jResp.StringOf('request.subject');
Assignee_id := jResp.StringOf('request.assignee_id');
Can_be_solved_by_me := jResp.StringOf('request.can_be_solved_by_me');
Created_at := jResp.StringOf('request.created_at');
Custom_status_id := jResp.StringOf('request.custom_status_id');
Description := jResp.StringOf('request.description');
Due_at := jResp.StringOf('request.due_at');
Followup_source_id := jResp.StringOf('request.followup_source_id');
Group_id := jResp.StringOf('request.group_id');
Id := jResp.StringOf('request.id');
Is_public := jResp.StringOf('request.is_public');
Organization_id := jResp.StringOf('request.organization_id');
Priority := jResp.StringOf('request.priority');
Recipient := jResp.StringOf('request.recipient');
Requester_id := jResp.StringOf('request.requester_id');
Solved := jResp.StringOf('request.solved');
Status := jResp.StringOf('request.status');
Ticket_form_id := jResp.StringOf('request.ticket_form_id');
v_Type := jResp.StringOf('request.type');
Updated_at := jResp.StringOf('request.updated_at');
v_Url := jResp.StringOf('request.url');
Channel := jResp.StringOf('request.via.channel');
Est__ := jResp.BoolOf('request.via.source.est__');
i := 0;
count_i := jResp.SizeOfArray('request.collaborator_ids');
while i < count_i do
begin
jResp.I := i;
strVal := jResp.StringOf('request.collaborator_ids[i]');
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('request.custom_fields');
while i < count_i do
begin
jResp.I := i;
id := jResp.StringOf('request.custom_fields[i].id');
value := jResp.StringOf('request.custom_fields[i].value');
i := i + 1;
end;
i := 0;
count_i := jResp.SizeOfArray('request.email_cc_ids');
while i < count_i do
begin
jResp.I := i;
strVal := jResp.StringOf('request.email_cc_ids[i]');
i := i + 1;
end;
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}"
}
]
}
