unicodeC / Support API / Show Compliance Deletion Statuses
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *action;
const wchar_t *application;
const wchar_t *account_subdomain;
const wchar_t *executer_id;
const wchar_t *user_id;
const wchar_t *created_at;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"login");
CkHttpW_putPassword(http,L"password");
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"application",L"<string>");
CkHttpW_SetRequestHeader(http,L"Accept",L"application/json");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://example.zendesk.com/api/v2/users/:user_id/compliance_deletion_statuses",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "compliance_deletion_statuses": [
// {
// "action": "<string>",
// "application": "<string>",
// "account_subdomain": "<string>",
// "executer_id": "<integer>",
// "user_id": "<integer>",
// "created_at": "<string>"
// },
// {
// "action": "<string>",
// "application": "<string>",
// "account_subdomain": "<string>",
// "executer_id": "<integer>",
// "user_id": "<integer>",
// "created_at": "<string>"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"compliance_deletion_statuses");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
action = CkJsonObjectW_stringOf(jResp,L"compliance_deletion_statuses[i].action");
application = CkJsonObjectW_stringOf(jResp,L"compliance_deletion_statuses[i].application");
account_subdomain = CkJsonObjectW_stringOf(jResp,L"compliance_deletion_statuses[i].account_subdomain");
executer_id = CkJsonObjectW_stringOf(jResp,L"compliance_deletion_statuses[i].executer_id");
user_id = CkJsonObjectW_stringOf(jResp,L"compliance_deletion_statuses[i].user_id");
created_at = CkJsonObjectW_stringOf(jResp,L"compliance_deletion_statuses[i].created_at");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -u login:password -G -d "application=%3Cstring%3E"
-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id/compliance_deletion_statuses
Postman Collection Item JSON
{
"name": "Show Compliance Deletion Statuses",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/users/:user_id/compliance_deletion_statuses?application=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"compliance_deletion_statuses"
],
"query": [
{
"key": "application",
"value": "<string>",
"description": "Area of compliance"
}
],
"variable": [
{
"key": "user_id",
"value": "<integer>"
}
]
},
"description": "Returns the GDPR status for each user per area of compliance. A Zendesk area of compliance is typically a product like \"support/explore\" but can be more fine-grained for areas within the product lines.\n\nIf the user is not in the account, the request returns a 404 status.\n\n```http\nStatus: 404\n{\n \"error\":\"RecordNotFound\",\n \"description\":\"Not found\"\n}\n```\n\n#### Allowed For\n\n* Agents, with restrictions\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/users/:user_id/compliance_deletion_statuses?application=<string>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"users",
":user_id",
"compliance_deletion_statuses"
],
"query": [
{
"key": "application",
"value": "<string>",
"description": "Area of compliance"
}
],
"variable": [
{
"key": "user_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"compliance_deletion_statuses\": [\n {\n \"action\": \"<string>\",\n \"application\": \"<string>\",\n \"account_subdomain\": \"<string>\",\n \"executer_id\": \"<integer>\",\n \"user_id\": \"<integer>\",\n \"created_at\": \"<string>\"\n },\n {\n \"action\": \"<string>\",\n \"application\": \"<string>\",\n \"account_subdomain\": \"<string>\",\n \"executer_id\": \"<integer>\",\n \"user_id\": \"<integer>\",\n \"created_at\": \"<string>\"\n }\n ]\n}"
}
]
}
