delphiAx / Support API / Show Self
Back to Collection Items
var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
Name: WideString;
Active: WideString;
Alias: WideString;
Chat_only: WideString;
Created_at: WideString;
Custom_role_id: WideString;
Default_group_id: WideString;
Details: WideString;
v_Email: WideString;
External_id: WideString;
Iana_time_zone: WideString;
Id: WideString;
Last_login_at: WideString;
Locale: WideString;
Locale_id: WideString;
Moderator: WideString;
Notes: WideString;
Only_private_comments: WideString;
Organization_id: WideString;
Phone: WideString;
Dolore50: WideString;
Remote_photo_url: WideString;
Report_csv: WideString;
Restricted_agent: WideString;
Role: WideString;
Role_type: WideString;
v_Shared: WideString;
Shared_agent: WideString;
Shared_phone_number: WideString;
Signature: WideString;
Suspended: WideString;
Tags: WideString;
Ticket_restriction: WideString;
Time_zone: WideString;
Two_factor_auth_enabled: WideString;
Updated_at: WideString;
v_Url: WideString;
Deserunt_c4: Integer;
Verified: WideString;
Authenticity_token: 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/users/me',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)
// {
// "user": {
// "name": "<string>",
// "active": "<boolean>",
// "alias": "<string>",
// "chat_only": "<boolean>",
// "created_at": "<string>",
// "custom_role_id": "<integer>",
// "default_group_id": "<integer>",
// "details": "<string>",
// "email": "<string>",
// "external_id": "<string>",
// "iana_time_zone": "<string>",
// "id": "<integer>",
// "last_login_at": "<string>",
// "locale": "<string>",
// "locale_id": "<integer>",
// "moderator": "<boolean>",
// "notes": "<string>",
// "only_private_comments": "<boolean>",
// "organization_id": "<integer>",
// "phone": "<string>",
// "photo": {
// "dolore50": -51881550.25541992
// },
// "remote_photo_url": "<string>",
// "report_csv": "<boolean>",
// "restricted_agent": "<boolean>",
// "role": "<string>",
// "role_type": "<integer>",
// "shared": "<boolean>",
// "shared_agent": "<boolean>",
// "shared_phone_number": "<boolean>",
// "signature": "<string>",
// "suspended": "<boolean>",
// "tags": "<array>",
// "ticket_restriction": "<string>",
// "time_zone": "<string>",
// "two_factor_auth_enabled": "<boolean>",
// "updated_at": "<string>",
// "url": "<string>",
// "user_fields": {
// "deserunt_c4": -61141403
// },
// "verified": "<boolean>",
// "authenticity_token": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Name := jResp.StringOf('user.name');
Active := jResp.StringOf('user.active');
Alias := jResp.StringOf('user.alias');
Chat_only := jResp.StringOf('user.chat_only');
Created_at := jResp.StringOf('user.created_at');
Custom_role_id := jResp.StringOf('user.custom_role_id');
Default_group_id := jResp.StringOf('user.default_group_id');
Details := jResp.StringOf('user.details');
v_Email := jResp.StringOf('user.email');
External_id := jResp.StringOf('user.external_id');
Iana_time_zone := jResp.StringOf('user.iana_time_zone');
Id := jResp.StringOf('user.id');
Last_login_at := jResp.StringOf('user.last_login_at');
Locale := jResp.StringOf('user.locale');
Locale_id := jResp.StringOf('user.locale_id');
Moderator := jResp.StringOf('user.moderator');
Notes := jResp.StringOf('user.notes');
Only_private_comments := jResp.StringOf('user.only_private_comments');
Organization_id := jResp.StringOf('user.organization_id');
Phone := jResp.StringOf('user.phone');
Dolore50 := jResp.StringOf('user.photo.dolore50');
Remote_photo_url := jResp.StringOf('user.remote_photo_url');
Report_csv := jResp.StringOf('user.report_csv');
Restricted_agent := jResp.StringOf('user.restricted_agent');
Role := jResp.StringOf('user.role');
Role_type := jResp.StringOf('user.role_type');
v_Shared := jResp.StringOf('user.shared');
Shared_agent := jResp.StringOf('user.shared_agent');
Shared_phone_number := jResp.StringOf('user.shared_phone_number');
Signature := jResp.StringOf('user.signature');
Suspended := jResp.StringOf('user.suspended');
Tags := jResp.StringOf('user.tags');
Ticket_restriction := jResp.StringOf('user.ticket_restriction');
Time_zone := jResp.StringOf('user.time_zone');
Two_factor_auth_enabled := jResp.StringOf('user.two_factor_auth_enabled');
Updated_at := jResp.StringOf('user.updated_at');
v_Url := jResp.StringOf('user.url');
Deserunt_c4 := jResp.IntOf('user.user_fields.deserunt_c4');
Verified := jResp.StringOf('user.verified');
Authenticity_token := jResp.StringOf('user.authenticity_token');
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/me
Postman Collection Item JSON
{
"name": "Show Self",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/me",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"me"
]
},
"description": "#### Allowed For\n\n* Anonymous users\n\n#### Authenticity Token\n\nThe endpoint returns an `authenticity_token`. Zendesk API calls made by end users from a Zendesk help center must include this token in the `X-CSRF-Token` HTTP header. This helps prevent [cross-site request forgery (CSRF)](https://en.wikipedia.org/wiki/Cross-site_request_forgery) attacks.\n\nFor an example using an authenticity token, see the AJAX request in the [Upgrading from Templating API v1](https://developer.zendesk.com/documentation/help_center/help-center-templates/v1#jquery) documentation.\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/users/me",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
"me"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"user\": {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"dolore50\": -51881550.25541992\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"deserunt_c4\": -61141403\n },\n \"verified\": \"<boolean>\",\n \"authenticity_token\": \"<string>\"\n }\n}"
}
]
}
