Chilkat Online Tools

Swift3 / Support API / Show Support Address

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    http.basicAuth = true
    http.login = "login"
    http.password = "password"

    http.setRequestHeader("Accept", value: "application/json")

    let sbResponseBody = CkoStringBuilder()!
    success = http.quickGetSb("https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id", sbContent: sbResponseBody)
    if success == false {
        print("\(http.lastErrorText!)")
        return
    }

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = http.lastStatus.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(http.lastHeader!)")
        print("Failed.")
        return
    }

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

    // {
    //   "recipient_address": {
    //     "email": "<string>",
    //     "brand_id": "<integer>",
    //     "cname_status": "unknown",
    //     "created_at": "<dateTime>",
    //     "default": "<boolean>",
    //     "dns_results": "verified",
    //     "domain_verification_code": "<string>",
    //     "domain_verification_status": "failed",
    //     "forwarding_status": "unknown",
    //     "id": "<integer>",
    //     "name": "<string>",
    //     "spf_status": "unknown",
    //     "updated_at": "<dateTime>"
    //   }
    // }

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

    var v_Email: String? = jResp.string(of: "recipient_address.email")
    var Brand_id: String? = jResp.string(of: "recipient_address.brand_id")
    var Cname_status: String? = jResp.string(of: "recipient_address.cname_status")
    var Created_at: String? = jResp.string(of: "recipient_address.created_at")
    var Default: String? = jResp.string(of: "recipient_address.default")
    var Dns_results: String? = jResp.string(of: "recipient_address.dns_results")
    var Domain_verification_code: String? = jResp.string(of: "recipient_address.domain_verification_code")
    var Domain_verification_status: String? = jResp.string(of: "recipient_address.domain_verification_status")
    var Forwarding_status: String? = jResp.string(of: "recipient_address.forwarding_status")
    var Id: String? = jResp.string(of: "recipient_address.id")
    var Name: String? = jResp.string(of: "recipient_address.name")
    var Spf_status: String? = jResp.string(of: "recipient_address.spf_status")
    var Updated_at: String? = jResp.string(of: "recipient_address.updated_at")

}

Curl Command

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

Postman Collection Item JSON

{
  "name": "Show Support Address",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/recipient_addresses/:support_address_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "recipient_addresses",
        ":support_address_id"
      ],
      "variable": [
        {
          "key": "support_address_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/recipient_addresses/:support_address_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "recipient_addresses",
            ":support_address_id"
          ],
          "variable": [
            {
              "key": "support_address_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"recipient_address\": {\n    \"email\": \"<string>\",\n    \"brand_id\": \"<integer>\",\n    \"cname_status\": \"unknown\",\n    \"created_at\": \"<dateTime>\",\n    \"default\": \"<boolean>\",\n    \"dns_results\": \"verified\",\n    \"domain_verification_code\": \"<string>\",\n    \"domain_verification_status\": \"failed\",\n    \"forwarding_status\": \"unknown\",\n    \"id\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"spf_status\": \"unknown\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}"
    }
  ]
}