Chilkat Online Tools

Go / Support API / Check Host Mapping Validity

Back to Collection Items

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

    http := chilkat.NewHttp()
    var success bool

    http.SetBasicAuth(true)
    http.SetLogin("login")
    http.SetPassword("password")

    queryParams := chilkat.NewJsonObject()
    queryParams.UpdateString("host_mapping","<string>")
    queryParams.UpdateString("subdomain","<string>")

    http.SetRequestHeader("Accept","application/json")

    resp := http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/brands/check_host_mapping",queryParams)
    if http.LastMethodSuccess() == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        queryParams.DisposeJsonObject()
        return
    }

    sbResponseBody := chilkat.NewStringBuilder()
    resp.GetBodySb(sbResponseBody)

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := resp.StatusCode()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(resp.Header())
        fmt.Println("Failed.")
        resp.DisposeHttpResponse()
        http.DisposeHttp()
        queryParams.DisposeJsonObject()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        return
    }

    resp.DisposeHttpResponse()

    // 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

    var strVal *string = new(string)

    cname := jResp.StringOf("cname")
    is_valid := jResp.StringOf("is_valid")
    reason := jResp.StringOf("reason")
    i := 0
    count_i := jResp.SizeOfArray("expected_cnames")
    for i < count_i {
        jResp.SetI(i)
        strVal = jResp.StringOf("expected_cnames[i]")
        i = i + 1
    }


    http.DisposeHttp()
    queryParams.DisposeJsonObject()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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