Chilkat Online Tools

delphiAx / Support API / Show Deleted User

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Id: WideString;
v_Url: WideString;
Name: WideString;
v_Email: WideString;
Created_at: WideString;
Updated_at: WideString;
Time_zone: WideString;
Phone: WideString;
Shared_phone_number: WideString;
Locale_id: WideString;
Locale: WideString;
Organization_id: WideString;
Role: WideString;
Active: WideString;

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/deleted_users/:deleted_user_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)

// {
//   "deleted_user": {
//     "id": "<integer>",
//     "url": "<string>",
//     "name": "<string>",
//     "email": "<null>",
//     "created_at": "<string>",
//     "updated_at": "<string>",
//     "time_zone": "<string>",
//     "phone": "<string>",
//     "shared_phone_number": "<string>",
//     "photo": {},
//     "locale_id": "<integer>",
//     "locale": "<string>",
//     "organization_id": "<null>",
//     "role": "<string>",
//     "active": "<boolean>"
//   }
// }

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

Id := jResp.StringOf('deleted_user.id');
v_Url := jResp.StringOf('deleted_user.url');
Name := jResp.StringOf('deleted_user.name');
v_Email := jResp.StringOf('deleted_user.email');
Created_at := jResp.StringOf('deleted_user.created_at');
Updated_at := jResp.StringOf('deleted_user.updated_at');
Time_zone := jResp.StringOf('deleted_user.time_zone');
Phone := jResp.StringOf('deleted_user.phone');
Shared_phone_number := jResp.StringOf('deleted_user.shared_phone_number');
Locale_id := jResp.StringOf('deleted_user.locale_id');
Locale := jResp.StringOf('deleted_user.locale');
Organization_id := jResp.StringOf('deleted_user.organization_id');
Role := jResp.StringOf('deleted_user.role');
Active := jResp.StringOf('deleted_user.active');

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Deleted User",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/deleted_users/:deleted_user_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "deleted_users",
        ":deleted_user_id"
      ],
      "variable": [
        {
          "key": "deleted_user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns users that have been deleted but not permanently yet. See [Permanently Delete User](#permanently-delete-user).\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/deleted_users/:deleted_user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "deleted_users",
            ":deleted_user_id"
          ],
          "variable": [
            {
              "key": "deleted_user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"deleted_user\": {\n    \"id\": \"<integer>\",\n    \"url\": \"<string>\",\n    \"name\": \"<string>\",\n    \"email\": \"<null>\",\n    \"created_at\": \"<string>\",\n    \"updated_at\": \"<string>\",\n    \"time_zone\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"shared_phone_number\": \"<string>\",\n    \"photo\": {},\n    \"locale_id\": \"<integer>\",\n    \"locale\": \"<string>\",\n    \"organization_id\": \"<null>\",\n    \"role\": \"<string>\",\n    \"active\": \"<boolean>\"\n  }\n}"
    }
  ]
}