PureBasic / Support API / List Deleted Users
Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.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")
CkHttp::ckSetRequestHeader(http,"Accept","application/json")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://example.zendesk.com/api/v2/deleted_users",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
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 = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "deleted_users": [
; {
; "id": "<integer>",
; "url": "<string>",
; "name": "<string>",
; "email": "<null>",
; "created_at": "<string>",
; "updated_at": "<string>",
; "time_zone": "<string>",
; "phone": "<string>",
; "shared_phone_number": "<string>",
; "photo": {},
; "locale_id": "<integer>",
; "locale": "<string>",
; "organization_id": "<null>",
; "role": "<string>",
; "active": "<boolean>"
; },
; {
; "id": "<integer>",
; "url": "<string>",
; "name": "<string>",
; "email": "<null>",
; "created_at": "<string>",
; "updated_at": "<string>",
; "time_zone": "<string>",
; "phone": "<string>",
; "shared_phone_number": "<string>",
; "photo": {},
; "locale_id": "<integer>",
; "locale": "<string>",
; "organization_id": "<null>",
; "role": "<string>",
; "active": "<boolean>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
id.s
url.s
name.s
email.s
created_at.s
updated_at.s
time_zone.s
phone.s
shared_phone_number.s
locale_id.s
locale.s
organization_id.s
role.s
active.s
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"deleted_users")
While i < count_i
CkJsonObject::setCkI(jResp, i)
id = CkJsonObject::ckStringOf(jResp,"deleted_users[i].id")
url = CkJsonObject::ckStringOf(jResp,"deleted_users[i].url")
name = CkJsonObject::ckStringOf(jResp,"deleted_users[i].name")
email = CkJsonObject::ckStringOf(jResp,"deleted_users[i].email")
created_at = CkJsonObject::ckStringOf(jResp,"deleted_users[i].created_at")
updated_at = CkJsonObject::ckStringOf(jResp,"deleted_users[i].updated_at")
time_zone = CkJsonObject::ckStringOf(jResp,"deleted_users[i].time_zone")
phone = CkJsonObject::ckStringOf(jResp,"deleted_users[i].phone")
shared_phone_number = CkJsonObject::ckStringOf(jResp,"deleted_users[i].shared_phone_number")
locale_id = CkJsonObject::ckStringOf(jResp,"deleted_users[i].locale_id")
locale = CkJsonObject::ckStringOf(jResp,"deleted_users[i].locale")
organization_id = CkJsonObject::ckStringOf(jResp,"deleted_users[i].organization_id")
role = CkJsonObject::ckStringOf(jResp,"deleted_users[i].role")
active = CkJsonObject::ckStringOf(jResp,"deleted_users[i].active")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/deleted_users
Postman Collection Item JSON
{
"name": "List Deleted Users",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/deleted_users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users"
]
},
"description": "Returns deleted users, including permanently deleted users.\n\nIf the results contains permanently deleted users, the users' properties\nthat normally contain personal data, such as `email` and `phone`,\nare null. The `name` property is \"Permanently Deleted User\".\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* 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/deleted_users",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"deleted_users"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"deleted_users\": [\n {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n },\n {\n \"id\": \"<integer>\",\n \"url\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"<null>\",\n \"created_at\": \"<string>\",\n \"updated_at\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"phone\": \"<string>\",\n \"shared_phone_number\": \"<string>\",\n \"photo\": {},\n \"locale_id\": \"<integer>\",\n \"locale\": \"<string>\",\n \"organization_id\": \"<null>\",\n \"role\": \"<string>\",\n \"active\": \"<boolean>\"\n }\n ]\n}"
}
]
}
