PowerBuilder / Support API / List Support Addresses
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Email
string ls_Brand_id
string ls_Cname_status
string ls_Created_at
string ls_Default
string ls_Dns_results
string ls_Domain_verification_code
string ls_Domain_verification_status
string ls_Forwarding_status
string ls_Id
string ls_Name
string ls_Spf_status
string ls_Updated_at
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_Http.BasicAuth = 1
loo_Http.Login = "login"
loo_Http.Password = "password"
loo_Http.SetRequestHeader("Accept","application/json")
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
li_Success = loo_Http.QuickGetSb("https://example.zendesk.com/api/v2/recipient_addresses",loo_SbResponseBody)
if li_Success = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_SbResponseBody
return
end if
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Http.LastStatus
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Http.LastHeader
Write-Debug "Failed."
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "recipient_addresses": [
// {
// "email": "<string>",
// "brand_id": "<integer>",
// "cname_status": "failed",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "dns_results": "failed",
// "domain_verification_code": "<string>",
// "domain_verification_status": "unknown",
// "forwarding_status": "verified",
// "id": "<integer>",
// "name": "<string>",
// "spf_status": "verified",
// "updated_at": "<dateTime>"
// },
// {
// "email": "<string>",
// "brand_id": "<integer>",
// "cname_status": "verified",
// "created_at": "<dateTime>",
// "default": "<boolean>",
// "dns_results": "failed",
// "domain_verification_code": "<string>",
// "domain_verification_status": "failed",
// "forwarding_status": "verified",
// "id": "<integer>",
// "name": "<string>",
// "spf_status": "verified",
// "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
i = 0
li_Count_i = loo_JResp.SizeOfArray("recipient_addresses")
do while i < li_Count_i
loo_JResp.I = i
ls_Email = loo_JResp.StringOf("recipient_addresses[i].email")
ls_Brand_id = loo_JResp.StringOf("recipient_addresses[i].brand_id")
ls_Cname_status = loo_JResp.StringOf("recipient_addresses[i].cname_status")
ls_Created_at = loo_JResp.StringOf("recipient_addresses[i].created_at")
ls_Default = loo_JResp.StringOf("recipient_addresses[i].default")
ls_Dns_results = loo_JResp.StringOf("recipient_addresses[i].dns_results")
ls_Domain_verification_code = loo_JResp.StringOf("recipient_addresses[i].domain_verification_code")
ls_Domain_verification_status = loo_JResp.StringOf("recipient_addresses[i].domain_verification_status")
ls_Forwarding_status = loo_JResp.StringOf("recipient_addresses[i].forwarding_status")
ls_Id = loo_JResp.StringOf("recipient_addresses[i].id")
ls_Name = loo_JResp.StringOf("recipient_addresses[i].name")
ls_Spf_status = loo_JResp.StringOf("recipient_addresses[i].spf_status")
ls_Updated_at = loo_JResp.StringOf("recipient_addresses[i].updated_at")
i = i + 1
loop
destroy loo_Http
destroy loo_SbResponseBody
destroy loo_JResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/recipient_addresses
Postman Collection Item JSON
{
"name": "List Support Addresses",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/recipient_addresses",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses"
]
},
"description": "Lists all the support addresses for the account.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\nReturns a maximum of 100 records per page.\n\n#### 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",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"recipient_addresses"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"recipient_addresses\": [\n {\n \"email\": \"<string>\",\n \"brand_id\": \"<integer>\",\n \"cname_status\": \"failed\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"dns_results\": \"failed\",\n \"domain_verification_code\": \"<string>\",\n \"domain_verification_status\": \"unknown\",\n \"forwarding_status\": \"verified\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"spf_status\": \"verified\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"email\": \"<string>\",\n \"brand_id\": \"<integer>\",\n \"cname_status\": \"verified\",\n \"created_at\": \"<dateTime>\",\n \"default\": \"<boolean>\",\n \"dns_results\": \"failed\",\n \"domain_verification_code\": \"<string>\",\n \"domain_verification_status\": \"failed\",\n \"forwarding_status\": \"verified\",\n \"id\": \"<integer>\",\n \"name\": \"<string>\",\n \"spf_status\": \"verified\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}
