Chilkat Online Tools

delphiAx / Support API / List Routing Attribute Definitions

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
v_Type: WideString;
Conditions_allType: WideString;
ItemsType: WideString;
SubjectType: WideString;
Default: WideString;
TitleType: WideString;
TitleDefault: WideString;
MaxItems: Integer;
Conditions_anyType: WideString;
SubjectDefault: WideString;
Conditions_anyMaxItems: 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/routing/attributes/definitions',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)

// {
//   "definitions": {
//     "type": "object",
//     "properties": {
//       "conditions_all": {
//         "type": "array",
//         "items": {
//           "type": "object",
//           "properties": {
//             "subject": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "title": {
//               "type": "string",
//               "default": "<string>"
//             }
//           }
//         },
//         "maxItems": 2
//       },
//       "conditions_any": {
//         "type": "array",
//         "items": {
//           "type": "object",
//           "properties": {
//             "subject": {
//               "type": "string",
//               "default": "<string>"
//             },
//             "title": {
//               "type": "string",
//               "default": "<string>"
//             }
//           }
//         },
//         "maxItems": 2
//       }
//     }
//   }
// }

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

v_Type := jResp.StringOf('definitions.type');
Conditions_allType := jResp.StringOf('definitions.properties.conditions_all.type');
ItemsType := jResp.StringOf('definitions.properties.conditions_all.items.type');
SubjectType := jResp.StringOf('definitions.properties.conditions_all.items.properties.subject.type');
Default := jResp.StringOf('definitions.properties.conditions_all.items.properties.subject.default');
TitleType := jResp.StringOf('definitions.properties.conditions_all.items.properties.title.type');
TitleDefault := jResp.StringOf('definitions.properties.conditions_all.items.properties.title.default');
MaxItems := jResp.IntOf('definitions.properties.conditions_all.maxItems');
Conditions_anyType := jResp.StringOf('definitions.properties.conditions_any.type');
ItemsType := jResp.StringOf('definitions.properties.conditions_any.items.type');
SubjectType := jResp.StringOf('definitions.properties.conditions_any.items.properties.subject.type');
SubjectDefault := jResp.StringOf('definitions.properties.conditions_any.items.properties.subject.default');
TitleType := jResp.StringOf('definitions.properties.conditions_any.items.properties.title.type');
TitleDefault := jResp.StringOf('definitions.properties.conditions_any.items.properties.title.default');
Conditions_anyMaxItems := jResp.IntOf('definitions.properties.conditions_any.maxItems');

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Routing Attribute Definitions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/routing/attributes/definitions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "routing",
        "attributes",
        "definitions"
      ]
    },
    "description": "Returns the condition definitions that can be configured to apply attributes to a ticket.\n\n#### Allowed For\n\n* Admins\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/routing/attributes/definitions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "routing",
            "attributes",
            "definitions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"definitions\": {\n    \"type\": \"object\",\n    \"properties\": {\n      \"conditions_all\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      },\n      \"conditions_any\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"subject\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"<string>\"\n            }\n          }\n        },\n        \"maxItems\": 2\n      }\n    }\n  }\n}"
    }
  ]
}