Chilkat Online Tools

delphiDll / Support API / Show Many Organizations

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
created_at: PWideChar;
details: PWideChar;
external_id: PWideChar;
group_id: PWideChar;
id: PWideChar;
name: PWideChar;
notes: PWideChar;
Eiusmod_f: PWideChar;
shared_comments: PWideChar;
shared_tickets: PWideChar;
updated_at: PWideChar;
url: PWideChar;
Nulla2: PWideChar;
j: Integer;
count_j: Integer;
strVal: PWideChar;
count: PWideChar;
next_page: PWideChar;
previous_page: 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');

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'ids','<string>');
CkJsonObject_UpdateString(queryParams,'external_ids','<string>');

CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequestParams(http,'GET','https://example.zendesk.com/api/v2/organizations/show_many',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

sbResponseBody := CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttpResponse_getStatusCode(resp);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttpResponse__header(resp));
    Memo1.Lines.Add('Failed.');
    CkHttpResponse_Dispose(resp);
    Exit;
  end;
CkHttpResponse_Dispose(resp);

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "count": "<integer>",
//   "next_page": "<string>",
//   "organizations": [
//     {
//       "created_at": "<string>",
//       "details": "<string>",
//       "domain_names": [
//         "<string>",
//         "<string>"
//       ],
//       "external_id": "<string>",
//       "group_id": "<integer>",
//       "id": "<integer>",
//       "name": "<string>",
//       "notes": "<string>",
//       "organization_fields": {
//         "eiusmod_f": "<string>"
//       },
//       "shared_comments": "<boolean>",
//       "shared_tickets": "<boolean>",
//       "tags": [
//         "<string>",
//         "<string>"
//       ],
//       "updated_at": "<string>",
//       "url": "<string>"
//     },
//     {
//       "created_at": "<string>",
//       "details": "<string>",
//       "domain_names": [
//         "<string>",
//         "<string>"
//       ],
//       "external_id": "<string>",
//       "group_id": "<integer>",
//       "id": "<integer>",
//       "name": "<string>",
//       "notes": "<string>",
//       "organization_fields": {
//         "nulla2": "<string>"
//       },
//       "shared_comments": "<boolean>",
//       "shared_tickets": "<boolean>",
//       "tags": [
//         "<string>",
//         "<string>"
//       ],
//       "updated_at": "<string>",
//       "url": "<string>"
//     }
//   ],
//   "previous_page": "<string>"
// }

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

count := CkJsonObject__stringOf(jResp,'count');
next_page := CkJsonObject__stringOf(jResp,'next_page');
previous_page := CkJsonObject__stringOf(jResp,'previous_page');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'organizations');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    created_at := CkJsonObject__stringOf(jResp,'organizations[i].created_at');
    details := CkJsonObject__stringOf(jResp,'organizations[i].details');
    external_id := CkJsonObject__stringOf(jResp,'organizations[i].external_id');
    group_id := CkJsonObject__stringOf(jResp,'organizations[i].group_id');
    id := CkJsonObject__stringOf(jResp,'organizations[i].id');
    name := CkJsonObject__stringOf(jResp,'organizations[i].name');
    notes := CkJsonObject__stringOf(jResp,'organizations[i].notes');
    Eiusmod_f := CkJsonObject__stringOf(jResp,'organizations[i].organization_fields.eiusmod_f');
    shared_comments := CkJsonObject__stringOf(jResp,'organizations[i].shared_comments');
    shared_tickets := CkJsonObject__stringOf(jResp,'organizations[i].shared_tickets');
    updated_at := CkJsonObject__stringOf(jResp,'organizations[i].updated_at');
    url := CkJsonObject__stringOf(jResp,'organizations[i].url');
    Nulla2 := CkJsonObject__stringOf(jResp,'organizations[i].organization_fields.nulla2');
    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'organizations[i].domain_names');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'organizations[i].domain_names[j]');
        j := j + 1;
      end;

    j := 0;
    count_j := CkJsonObject_SizeOfArray(jResp,'organizations[i].tags');
    while j < count_j do
      begin
        CkJsonObject_putJ(jResp,j);
        strVal := CkJsonObject__stringOf(jResp,'organizations[i].tags[j]');
        j := j + 1;
      end;

    i := i + 1;
  end;

CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

Curl Command

curl  -u login:password -G -d "ids=%3Cstring%3E"
	-d "external_ids=%3Cstring%3E"
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/organizations/show_many

Postman Collection Item JSON

{
  "name": "Show Many Organizations",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/organizations/show_many?ids=<string>&external_ids=<string>",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "organizations",
        "show_many"
      ],
      "query": [
        {
          "key": "ids",
          "value": "<string>",
          "description": "A list of organization ids"
        },
        {
          "key": "external_ids",
          "value": "<string>",
          "description": "A list of external ids"
        }
      ]
    },
    "description": "Accepts a comma-separated list of up to 100 organization ids or external ids.\n\n#### 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/show_many?ids=<string>&external_ids=<string>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "organizations",
            "show_many"
          ],
          "query": [
            {
              "key": "ids",
              "value": "<string>",
              "description": "A list of organization ids"
            },
            {
              "key": "external_ids",
              "value": "<string>",
              "description": "A list of external ids"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"organizations\": [\n    {\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        \"eiusmod_f\": \"<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    {\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        \"nulla2\": \"<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  ],\n  \"previous_page\": \"<string>\"\n}"
    }
  ]
}