Chilkat Online Tools

PureBasic / Support API / Show Support Address

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    CkHttp::setCkBasicAuth(http, 1)
    CkHttp::setCkLogin(http, "login")
    CkHttp::setCkPassword(http, "password")

    CkHttp::ckSetRequestHeader(http,"Accept","application/json")

    sbResponseBody.i = CkStringBuilder::ckCreate()
    If sbResponseBody.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id",sbResponseBody)
    If success = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        ProcedureReturn
    EndIf

    jResp.i = CkJsonObject::ckCreate()
    If jResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(jResp,sbResponseBody)
    CkJsonObject::setCkEmitCompact(jResp, 0)

    Debug "Response Body:"
    Debug CkJsonObject::ckEmit(jResp)

    respStatusCode.i = CkHttp::ckLastStatus(http)
    Debug "Response Status Code = " + Str(respStatusCode)
    If respStatusCode >= 400
        Debug "Response Header:"
        Debug CkHttp::ckLastHeader(http)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponseBody)
        CkJsonObject::ckDispose(jResp)
        ProcedureReturn
    EndIf

    ; 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

    v_Email.s = CkJsonObject::ckStringOf(jResp,"recipient_address.email")
    Brand_id.s = CkJsonObject::ckStringOf(jResp,"recipient_address.brand_id")
    Cname_status.s = CkJsonObject::ckStringOf(jResp,"recipient_address.cname_status")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"recipient_address.created_at")
    Default.s = CkJsonObject::ckStringOf(jResp,"recipient_address.default")
    Dns_results.s = CkJsonObject::ckStringOf(jResp,"recipient_address.dns_results")
    Domain_verification_code.s = CkJsonObject::ckStringOf(jResp,"recipient_address.domain_verification_code")
    Domain_verification_status.s = CkJsonObject::ckStringOf(jResp,"recipient_address.domain_verification_status")
    Forwarding_status.s = CkJsonObject::ckStringOf(jResp,"recipient_address.forwarding_status")
    Id.s = CkJsonObject::ckStringOf(jResp,"recipient_address.id")
    Name.s = CkJsonObject::ckStringOf(jResp,"recipient_address.name")
    Spf_status.s = CkJsonObject::ckStringOf(jResp,"recipient_address.spf_status")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"recipient_address.updated_at")


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure

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