Chilkat Online Tools

PureBasic / Support API / Show Deleted User

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/:deleted_user_id",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_user": {
    ;     "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 = CkJsonObject::ckStringOf(jResp,"deleted_user.id")
    v_Url.s = CkJsonObject::ckStringOf(jResp,"deleted_user.url")
    Name.s = CkJsonObject::ckStringOf(jResp,"deleted_user.name")
    v_Email.s = CkJsonObject::ckStringOf(jResp,"deleted_user.email")
    Created_at.s = CkJsonObject::ckStringOf(jResp,"deleted_user.created_at")
    Updated_at.s = CkJsonObject::ckStringOf(jResp,"deleted_user.updated_at")
    Time_zone.s = CkJsonObject::ckStringOf(jResp,"deleted_user.time_zone")
    Phone.s = CkJsonObject::ckStringOf(jResp,"deleted_user.phone")
    Shared_phone_number.s = CkJsonObject::ckStringOf(jResp,"deleted_user.shared_phone_number")
    Locale_id.s = CkJsonObject::ckStringOf(jResp,"deleted_user.locale_id")
    Locale.s = CkJsonObject::ckStringOf(jResp,"deleted_user.locale")
    Organization_id.s = CkJsonObject::ckStringOf(jResp,"deleted_user.organization_id")
    Role.s = CkJsonObject::ckStringOf(jResp,"deleted_user.role")
    Active.s = CkJsonObject::ckStringOf(jResp,"deleted_user.active")


    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/:deleted_user_id

Postman Collection Item JSON

{
  "name": "Show Deleted User",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/deleted_users/:deleted_user_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "deleted_users",
        ":deleted_user_id"
      ],
      "variable": [
        {
          "key": "deleted_user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "Returns users that have been deleted but not permanently yet. See [Permanently Delete User](#permanently-delete-user).\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/:deleted_user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "deleted_users",
            ":deleted_user_id"
          ],
          "variable": [
            {
              "key": "deleted_user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"deleted_user\": {\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}"
    }
  ]
}