Android / Support API / Check Host Mapping Validity
Back to Collection Items
// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;
import android.app.Activity;
import com.chilkatsoft.*;
import android.widget.TextView;
import android.os.Bundle;
public class SimpleActivity extends Activity {
private static final String TAG = "Chilkat";
// Called when the activity is first created.
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkHttp http = new CkHttp();
boolean success;
http.put_BasicAuth(true);
http.put_Login("login");
http.put_Password("password");
CkJsonObject queryParams = new CkJsonObject();
queryParams.UpdateString("host_mapping","<string>");
queryParams.UpdateString("subdomain","<string>");
http.SetRequestHeader("Accept","application/json");
CkHttpResponse resp = http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/brands/check_host_mapping",queryParams);
if (http.get_LastMethodSuccess() == false) {
Log.i(TAG, http.lastErrorText());
return;
}
CkStringBuilder sbResponseBody = new CkStringBuilder();
resp.GetBodySb(sbResponseBody);
CkJsonObject jResp = new CkJsonObject();
jResp.LoadSb(sbResponseBody);
jResp.put_EmitCompact(false);
Log.i(TAG, "Response Body:");
Log.i(TAG, jResp.emit());
int respStatusCode = resp.get_StatusCode();
Log.i(TAG, "Response Status Code = " + String.valueOf(respStatusCode));
if (respStatusCode >= 400) {
Log.i(TAG, "Response Header:");
Log.i(TAG, resp.header());
Log.i(TAG, "Failed.");
return;
}
// 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
String strVal;
String cname = jResp.stringOf("cname");
String is_valid = jResp.stringOf("is_valid");
String reason = jResp.stringOf("reason");
int i = 0;
int count_i = jResp.SizeOfArray("expected_cnames");
while (i < count_i) {
jResp.put_I(i);
strVal = jResp.stringOf("expected_cnames[i]");
i = i + 1;
}
}
static {
System.loadLibrary("chilkat");
// Note: If the incorrect library name is passed to System.loadLibrary,
// then you will see the following error message at application startup:
//"The application <your-application-name> has stopped unexpectedly. Please try again."
}
}
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}"
}
]
}