unicodeC / Support API / Check Host Mapping Validity
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *strVal;
const wchar_t *cname;
const wchar_t *is_valid;
const wchar_t *reason;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"password");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"host_mapping",L"<string>");
CkJsonObjectW_UpdateString(queryParams,L"subdomain",L"<string>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/brands/check_host_mapping",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
cname = CkJsonObjectW_stringOf(jResp,L"cname");
is_valid = CkJsonObjectW_stringOf(jResp,L"is_valid");
reason = CkJsonObjectW_stringOf(jResp,L"reason");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"expected_cnames");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"expected_cnames[i]");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -u login:password -G -d "host_mapping=%3Cstring%3E"
-d "subdomain=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/brands/check_host_mapping
Postman Collection Item JSON
{
"name": "Check Host Mapping Validity",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/brands/check_host_mapping?host_mapping=<string>&subdomain=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands",
"check_host_mapping"
],
"query": [
{
"key": "host_mapping",
"value": "<string>",
"description": "(Required) The hostmapping to a brand, if any (only admins view this key)"
},
{
"key": "subdomain",
"value": "<string>",
"description": "(Required) Subdomain for a given Zendesk account address"
}
]
},
"description": "Returns a JSON object determining whether a host mapping is valid for a given subdomain.\n\n#### Allowed for\n\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/check_host_mapping?host_mapping=<string>&subdomain=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"brands",
"check_host_mapping"
],
"query": [
{
"key": "host_mapping",
"value": "<string>",
"description": "(Required) The hostmapping to a brand, if any (only admins view this key)"
},
{
"key": "subdomain",
"value": "<string>",
"description": "(Required) Subdomain for a given Zendesk account address"
}
]
}
},
"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}"
}
]
}