Chilkat Online Tools

PowerBuilder / Support API / Show Compliance Deletion Statuses

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_Action
string ls_Application
string ls_Account_subdomain
string ls_Executer_id
string ls_User_id
string ls_Created_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
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.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_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_QueryParams.UpdateString("application","<string>")

loo_Http.SetRequestHeader("Accept","application/json")

loo_Resp = loo_Http.QuickRequestParams("GET","https://example.zendesk.com/api/v2/users/:user_id/compliance_deletion_statuses",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")

loo_Resp.GetBodySb(loo_SbResponseBody)

loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0

Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()

li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
    Write-Debug "Response Header:"
    Write-Debug loo_Resp.Header
    Write-Debug "Failed."
    destroy loo_Resp
    destroy loo_Http
    destroy loo_QueryParams
    destroy loo_SbResponseBody
    destroy loo_JResp
    return
end if

destroy loo_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

i = 0
li_Count_i = loo_JResp.SizeOfArray("compliance_deletion_statuses")
do while i < li_Count_i
    loo_JResp.I = i
    ls_Action = loo_JResp.StringOf("compliance_deletion_statuses[i].action")
    ls_Application = loo_JResp.StringOf("compliance_deletion_statuses[i].application")
    ls_Account_subdomain = loo_JResp.StringOf("compliance_deletion_statuses[i].account_subdomain")
    ls_Executer_id = loo_JResp.StringOf("compliance_deletion_statuses[i].executer_id")
    ls_User_id = loo_JResp.StringOf("compliance_deletion_statuses[i].user_id")
    ls_Created_at = loo_JResp.StringOf("compliance_deletion_statuses[i].created_at")
    i = i + 1
loop


destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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}"
    }
  ]
}