PureBasic / Support API / Show Compliance Deletion Statuses
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.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")
queryParams.i = CkJsonObject::ckCreate()
If queryParams.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(queryParams,"application","<string>")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
resp.i = CkHttp::ckQuickRequestParams(http,"GET","https://example.zendesk.com/api/v2/users/:user_id/compliance_deletion_statuses",queryParams)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
ProcedureReturn
EndIf
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkHttpResponse::ckGetBodySb(resp,sbResponseBody)
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 = CkHttpResponse::ckStatusCode(resp)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttpResponse::ckHeader(resp)
Debug "Failed."
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
CkHttpResponse::ckDispose(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
action.s
application.s
account_subdomain.s
executer_id.s
user_id.s
created_at.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"compliance_deletion_statuses")
While i < count_i
CkJsonObject::setCkI(jResp, i)
action = CkJsonObject::ckStringOf(jResp,"compliance_deletion_statuses[i].action")
application = CkJsonObject::ckStringOf(jResp,"compliance_deletion_statuses[i].application")
account_subdomain = CkJsonObject::ckStringOf(jResp,"compliance_deletion_statuses[i].account_subdomain")
executer_id = CkJsonObject::ckStringOf(jResp,"compliance_deletion_statuses[i].executer_id")
user_id = CkJsonObject::ckStringOf(jResp,"compliance_deletion_statuses[i].user_id")
created_at = CkJsonObject::ckStringOf(jResp,"compliance_deletion_statuses[i].created_at")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(queryParams)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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}"
}
]
}
