Chilkat Online Tools

Perl / Support API / Show Organization

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$http->SetRequestHeader("Accept","application/json");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://example.zendesk.com/api/v2/organizations/:organization_id",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";

$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
    print "Response Header:" . "\r\n";
    print $http->lastHeader() . "\r\n";
    print "Failed." . "\r\n";
    exit;
}

# 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) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf("organization.domain_names[i]");
    $i = $i + 1;
}

$i = 0;
$count_i = $jResp->SizeOfArray("organization.tags");
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf("organization.tags[i]");
    $i = $i + 1;
}

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}"
    }
  ]
}