C / Support API / Show Compliance Deletion Statuses
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *action;
const char *application;
const char *account_subdomain;
const char *executer_id;
const char *user_id;
const char *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 = CkHttp_Create();
CkHttp_putBasicAuth(http,TRUE);
CkHttp_putLogin(http,"login");
CkHttp_putPassword(http,"password");
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"application","<string>");
CkHttp_SetRequestHeader(http,"Accept","application/json");
resp = CkHttp_QuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/users/:user_id/compliance_deletion_statuses",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_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 = CkJsonObject_SizeOfArray(jResp,"compliance_deletion_statuses");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
action = CkJsonObject_stringOf(jResp,"compliance_deletion_statuses[i].action");
application = CkJsonObject_stringOf(jResp,"compliance_deletion_statuses[i].application");
account_subdomain = CkJsonObject_stringOf(jResp,"compliance_deletion_statuses[i].account_subdomain");
executer_id = CkJsonObject_stringOf(jResp,"compliance_deletion_statuses[i].executer_id");
user_id = CkJsonObject_stringOf(jResp,"compliance_deletion_statuses[i].user_id");
created_at = CkJsonObject_stringOf(jResp,"compliance_deletion_statuses[i].created_at");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_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}"
}
]
}