Chilkat Online Tools

delphiDll / Support API / Show Custom Ticket Status

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
Status_category: PWideChar;
Agent_label: PWideChar;
Active: PWideChar;
Created_at: PWideChar;
Default: PWideChar;
Description: PWideChar;
End_user_description: PWideChar;
End_user_label: PWideChar;
Id: PWideChar;
Raw_agent_label: PWideChar;
Raw_description: PWideChar;
Raw_end_user_description: PWideChar;
Raw_end_user_label: PWideChar;
Updated_at: PWideChar;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/custom_statuses/:custom_status_id',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

// {
//   "custom_status": {
//     "status_category": "open",
//     "agent_label": "<string>",
//     "active": "<boolean>",
//     "created_at": "<dateTime>",
//     "default": "<boolean>",
//     "description": "<string>",
//     "end_user_description": "<string>",
//     "end_user_label": "<string>",
//     "id": "<integer>",
//     "raw_agent_label": "<string>",
//     "raw_description": "<string>",
//     "raw_end_user_description": "<string>",
//     "raw_end_user_label": "<string>",
//     "updated_at": "<dateTime>"
//   }
// }

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

Status_category := CkJsonObject__stringOf(jResp,'custom_status.status_category');
Agent_label := CkJsonObject__stringOf(jResp,'custom_status.agent_label');
Active := CkJsonObject__stringOf(jResp,'custom_status.active');
Created_at := CkJsonObject__stringOf(jResp,'custom_status.created_at');
Default := CkJsonObject__stringOf(jResp,'custom_status.default');
Description := CkJsonObject__stringOf(jResp,'custom_status.description');
End_user_description := CkJsonObject__stringOf(jResp,'custom_status.end_user_description');
End_user_label := CkJsonObject__stringOf(jResp,'custom_status.end_user_label');
Id := CkJsonObject__stringOf(jResp,'custom_status.id');
Raw_agent_label := CkJsonObject__stringOf(jResp,'custom_status.raw_agent_label');
Raw_description := CkJsonObject__stringOf(jResp,'custom_status.raw_description');
Raw_end_user_description := CkJsonObject__stringOf(jResp,'custom_status.raw_end_user_description');
Raw_end_user_label := CkJsonObject__stringOf(jResp,'custom_status.raw_end_user_label');
Updated_at := CkJsonObject__stringOf(jResp,'custom_status.updated_at');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_statuses/:custom_status_id

Postman Collection Item JSON

{
  "name": "Show Custom Ticket Status",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_statuses",
        ":custom_status_id"
      ],
      "variable": [
        {
          "key": "custom_status_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns the custom ticket status object.\n\n#### Allowed For\n\n* End Users\n"
  },
  "response": [
    {
      "name": "Custom Status",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_statuses/:custom_status_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_statuses",
            ":custom_status_id"
          ],
          "variable": [
            {
              "key": "custom_status_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_status\": {\n    \"status_category\": \"open\",\n    \"agent_label\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"description\": \"<string>\",\n    \"end_user_description\": \"<string>\",\n    \"end_user_label\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"raw_agent_label\": \"<string>\",\n    \"raw_description\": \"<string>\",\n    \"raw_end_user_description\": \"<string>\",\n    \"raw_end_user_label\": \"<string>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}