Chilkat Online Tools

phpExt / Support API / Check Host Mapping Validity for an Existing Brand

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

$http->put_BasicAuth(true);
$http->put_Login('login');
$http->put_Password('password');

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

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://example.zendesk.com/api/v2/brands/:brand_id/check_host_mapping',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

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

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

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

// {
//   "cname": "<string>",
//   "expected_cnames": [
//     "<string>",
//     "<string>"
//   ],
//   "is_valid": "<boolean>",
//   "reason": "<string>"
// }

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

$cname = $jResp->stringOf('cname');
$is_valid = $jResp->stringOf('is_valid');
$reason = $jResp->stringOf('reason');
$i = 0;
$count_i = $jResp->SizeOfArray('expected_cnames');
while ($i < $count_i) {
    $jResp->put_I($i);
    $strVal = $jResp->stringOf('expected_cnames[i]');
    $i = $i + 1;
}


?>

Curl Command

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

Postman Collection Item JSON

{
  "name": "Check Host Mapping Validity for an Existing Brand",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/brands/:brand_id/check_host_mapping",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "brands",
        ":brand_id",
        "check_host_mapping"
      ],
      "variable": [
        {
          "key": "brand_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns a JSON object determining whether a host mapping is valid for the given brand.\n\n#### Allowed for\n- Admins"
  },
  "response": [
    {
      "name": "Successful response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/brands/:brand_id/check_host_mapping",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "brands",
            ":brand_id",
            "check_host_mapping"
          ],
          "variable": [
            {
              "key": "brand_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"cname\": \"<string>\",\n  \"expected_cnames\": [\n    \"<string>\",\n    \"<string>\"\n  ],\n  \"is_valid\": \"<boolean>\",\n  \"reason\": \"<string>\"\n}"
    }
  ]
}