Chilkat Online Tools

delphiAx / Support API / Show Organization

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jResp: TChilkatJsonObject;
respStatusCode: Integer;
strVal: WideString;
Created_at: WideString;
Details: WideString;
External_id: WideString;
Group_id: WideString;
Id: WideString;
Name: WideString;
Notes: WideString;
Fugiat5_0: WideString;
Exercitation_039: WideString;
Laboris_60: WideString;
Shared_comments: WideString;
Shared_tickets: WideString;
Updated_at: WideString;
v_Url: WideString;
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 := 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/organizations/:organization_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)

// {
//   "organization": {
//     "created_at": "<string>",
//     "details": "<string>",
//     "domain_names": [
//       "<string>",
//       "<string>"
//     ],
//     "external_id": "<string>",
//     "group_id": "<integer>",
//     "id": "<integer>",
//     "name": "<string>",
//     "notes": "<string>",
//     "organization_fields": {
//       "fugiat5_0": "<string>",
//       "exercitation_039": "<string>",
//       "laboris_60": "<string>"
//     },
//     "shared_comments": "<boolean>",
//     "shared_tickets": "<boolean>",
//     "tags": [
//       "<string>",
//       "<string>"
//     ],
//     "updated_at": "<string>",
//     "url": "<string>"
//   }
// }

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

Created_at := jResp.StringOf('organization.created_at');
Details := jResp.StringOf('organization.details');
External_id := jResp.StringOf('organization.external_id');
Group_id := jResp.StringOf('organization.group_id');
Id := jResp.StringOf('organization.id');
Name := jResp.StringOf('organization.name');
Notes := jResp.StringOf('organization.notes');
Fugiat5_0 := jResp.StringOf('organization.organization_fields.fugiat5_0');
Exercitation_039 := jResp.StringOf('organization.organization_fields.exercitation_039');
Laboris_60 := jResp.StringOf('organization.organization_fields.laboris_60');
Shared_comments := jResp.StringOf('organization.shared_comments');
Shared_tickets := jResp.StringOf('organization.shared_tickets');
Updated_at := jResp.StringOf('organization.updated_at');
v_Url := jResp.StringOf('organization.url');
i := 0;
count_i := jResp.SizeOfArray('organization.domain_names');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('organization.domain_names[i]');
    i := i + 1;
  end;

i := 0;
count_i := jResp.SizeOfArray('organization.tags');
while i < count_i do
  begin
    jResp.I := i;
    strVal := jResp.StringOf('organization.tags[i]');
    i := i + 1;
  end;

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Organization",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/:organization_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        ":organization_id"
      ],
      "variable": [
        {
          "key": "organization_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### Allowed For\n\n* Admins\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/organizations/:organization_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            ":organization_id"
          ],
          "variable": [
            {
              "key": "organization_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"organization\": {\n    \"created_at\": \"<string>\",\n    \"details\": \"<string>\",\n    \"domain_names\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"external_id\": \"<string>\",\n    \"group_id\": \"<integer>\",\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"organization_fields\": {\n      \"fugiat5_0\": \"<string>\",\n      \"exercitation_039\": \"<string>\",\n      \"laboris_60\": \"<string>\"\n    },\n    \"shared_comments\": \"<boolean>\",\n    \"shared_tickets\": \"<boolean>\",\n    \"tags\": [\n      \"<string>\",\n      \"<string>\"\n    ],\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}