Chilkat Online Tools

delphiDll / Support API / Show Support Address

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
v_Email: PWideChar;
Brand_id: PWideChar;
Cname_status: PWideChar;
Created_at: PWideChar;
Default: PWideChar;
Dns_results: PWideChar;
Domain_verification_code: PWideChar;
Domain_verification_status: PWideChar;
Forwarding_status: PWideChar;
Id: PWideChar;
Name: PWideChar;
Spf_status: PWideChar;
Updated_at: PWideChar;

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

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'login');
CkHttp_putPassword(http,'password');

CkHttp_SetRequestHeader(http,'Accept','application/json');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://example.zendesk.com/api/v2/recipient_addresses/:support_address_id',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

// 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 := CkJsonObject__stringOf(jResp,'recipient_address.email');
Brand_id := CkJsonObject__stringOf(jResp,'recipient_address.brand_id');
Cname_status := CkJsonObject__stringOf(jResp,'recipient_address.cname_status');
Created_at := CkJsonObject__stringOf(jResp,'recipient_address.created_at');
Default := CkJsonObject__stringOf(jResp,'recipient_address.default');
Dns_results := CkJsonObject__stringOf(jResp,'recipient_address.dns_results');
Domain_verification_code := CkJsonObject__stringOf(jResp,'recipient_address.domain_verification_code');
Domain_verification_status := CkJsonObject__stringOf(jResp,'recipient_address.domain_verification_status');
Forwarding_status := CkJsonObject__stringOf(jResp,'recipient_address.forwarding_status');
Id := CkJsonObject__stringOf(jResp,'recipient_address.id');
Name := CkJsonObject__stringOf(jResp,'recipient_address.name');
Spf_status := CkJsonObject__stringOf(jResp,'recipient_address.spf_status');
Updated_at := CkJsonObject__stringOf(jResp,'recipient_address.updated_at');

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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