Chilkat Online Tools

delphiDll / Support API / Show User Field

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
name: PWideChar;
value: PWideChar;
id: PWideChar;
position: PWideChar;
raw_name: PWideChar;
url: PWideChar;
Key: PWideChar;
v_Type: PWideChar;
Title: PWideChar;
Active: PWideChar;
Created_at: PWideChar;
Description: PWideChar;
Id: PWideChar;
Position: PWideChar;
Raw_description: PWideChar;
Raw_title: PWideChar;
Regexp_for_validation: PWideChar;
Relationship_target_type: PWideChar;
System: PWideChar;
Tag: PWideChar;
Updated_at: PWideChar;
v_Url: PWideChar;
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 := 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/user_fields/:user_field_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)

// {
//   "user_field": {
//     "key": "<string>",
//     "type": "<string>",
//     "title": "<string>",
//     "active": "<boolean>",
//     "created_at": "<dateTime>",
//     "custom_field_options": [
//       {
//         "name": "<string>",
//         "value": "<string>",
//         "id": "<integer>",
//         "position": "<integer>",
//         "raw_name": "<string>",
//         "url": "<string>"
//       },
//       {
//         "name": "<string>",
//         "value": "<string>",
//         "id": "<integer>",
//         "position": "<integer>",
//         "raw_name": "<string>",
//         "url": "<string>"
//       }
//     ],
//     "description": "<string>",
//     "id": "<integer>",
//     "position": "<integer>",
//     "raw_description": "<string>",
//     "raw_title": "<string>",
//     "regexp_for_validation": "<string>",
//     "relationship_filter": {},
//     "relationship_target_type": "<string>",
//     "system": "<boolean>",
//     "tag": "<string>",
//     "updated_at": "<dateTime>",
//     "url": "<string>"
//   }
// }

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

Key := CkJsonObject__stringOf(jResp,'user_field.key');
v_Type := CkJsonObject__stringOf(jResp,'user_field.type');
Title := CkJsonObject__stringOf(jResp,'user_field.title');
Active := CkJsonObject__stringOf(jResp,'user_field.active');
Created_at := CkJsonObject__stringOf(jResp,'user_field.created_at');
Description := CkJsonObject__stringOf(jResp,'user_field.description');
Id := CkJsonObject__stringOf(jResp,'user_field.id');
Position := CkJsonObject__stringOf(jResp,'user_field.position');
Raw_description := CkJsonObject__stringOf(jResp,'user_field.raw_description');
Raw_title := CkJsonObject__stringOf(jResp,'user_field.raw_title');
Regexp_for_validation := CkJsonObject__stringOf(jResp,'user_field.regexp_for_validation');
Relationship_target_type := CkJsonObject__stringOf(jResp,'user_field.relationship_target_type');
System := CkJsonObject__stringOf(jResp,'user_field.system');
Tag := CkJsonObject__stringOf(jResp,'user_field.tag');
Updated_at := CkJsonObject__stringOf(jResp,'user_field.updated_at');
v_Url := CkJsonObject__stringOf(jResp,'user_field.url');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'user_field.custom_field_options');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    name := CkJsonObject__stringOf(jResp,'user_field.custom_field_options[i].name');
    value := CkJsonObject__stringOf(jResp,'user_field.custom_field_options[i].value');
    id := CkJsonObject__stringOf(jResp,'user_field.custom_field_options[i].id');
    position := CkJsonObject__stringOf(jResp,'user_field.custom_field_options[i].position');
    raw_name := CkJsonObject__stringOf(jResp,'user_field.custom_field_options[i].raw_name');
    url := CkJsonObject__stringOf(jResp,'user_field.custom_field_options[i].url');
    i := i + 1;
  end;

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/user_fields/:user_field_id

Postman Collection Item JSON

{
  "name": "Show User Field",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/user_fields/:user_field_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "user_fields",
        ":user_field_id"
      ],
      "variable": [
        {
          "key": "user_field_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/user_fields/:user_field_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "user_fields",
            ":user_field_id"
          ],
          "variable": [
            {
              "key": "user_field_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user_field\": {\n    \"key\": \"<string>\",\n    \"type\": \"<string>\",\n    \"title\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"created_at\": \"<dateTime>\",\n    \"custom_field_options\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      },\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\",\n        \"id\": \"<integer>\",\n        \"position\": \"<integer>\",\n        \"raw_name\": \"<string>\",\n        \"url\": \"<string>\"\n      }\n    ],\n    \"description\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"position\": \"<integer>\",\n    \"raw_description\": \"<string>\",\n    \"raw_title\": \"<string>\",\n    \"regexp_for_validation\": \"<string>\",\n    \"relationship_filter\": {},\n    \"relationship_target_type\": \"<string>\",\n    \"system\": \"<boolean>\",\n    \"tag\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}