Chilkat Online Tools

VB.NET / Support API / Show User

Back to Collection Items

' This example assumes the Chilkat API to have been previously unlocked.
' See Global Unlock Sample for sample code.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "login"
http.Password = "password"

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

Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://example.zendesk.com/api/v2/users/:user_id",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' Sample JSON response:
' (Sample code for parsing the JSON response is shown below)

' {
'   "user": {
'     "name": "<string>",
'     "active": "<boolean>",
'     "alias": "<string>",
'     "chat_only": "<boolean>",
'     "created_at": "<string>",
'     "custom_role_id": "<integer>",
'     "default_group_id": "<integer>",
'     "details": "<string>",
'     "email": "<string>",
'     "external_id": "<string>",
'     "iana_time_zone": "<string>",
'     "id": "<integer>",
'     "last_login_at": "<string>",
'     "locale": "<string>",
'     "locale_id": "<integer>",
'     "moderator": "<boolean>",
'     "notes": "<string>",
'     "only_private_comments": "<boolean>",
'     "organization_id": "<integer>",
'     "phone": "<string>",
'     "photo": {
'       "dolorea1": false,
'       "deserunt3": 95124319.10825741
'     },
'     "remote_photo_url": "<string>",
'     "report_csv": "<boolean>",
'     "restricted_agent": "<boolean>",
'     "role": "<string>",
'     "role_type": "<integer>",
'     "shared": "<boolean>",
'     "shared_agent": "<boolean>",
'     "shared_phone_number": "<boolean>",
'     "signature": "<string>",
'     "suspended": "<boolean>",
'     "tags": "<array>",
'     "ticket_restriction": "<string>",
'     "time_zone": "<string>",
'     "two_factor_auth_enabled": "<boolean>",
'     "updated_at": "<string>",
'     "url": "<string>",
'     "user_fields": {
'       "nostrudacc": -12929960.546221554,
'       "in_80e": 25167751.960886702,
'       "proident_e2": true,
'       "voluptate_98": -58995022
'     },
'     "verified": "<boolean>"
'   }
' }

' Sample code for parsing the JSON response...
' Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code




Dim Name As String = jResp.StringOf("user.name")
Dim Active As String = jResp.StringOf("user.active")
Dim Alias As String = jResp.StringOf("user.alias")
Dim Chat_only As String = jResp.StringOf("user.chat_only")
Dim Created_at As String = jResp.StringOf("user.created_at")
Dim Custom_role_id As String = jResp.StringOf("user.custom_role_id")
Dim Default_group_id As String = jResp.StringOf("user.default_group_id")
Dim Details As String = jResp.StringOf("user.details")
Dim v_Email As String = jResp.StringOf("user.email")
Dim External_id As String = jResp.StringOf("user.external_id")
Dim Iana_time_zone As String = jResp.StringOf("user.iana_time_zone")
Dim Id As String = jResp.StringOf("user.id")
Dim Last_login_at As String = jResp.StringOf("user.last_login_at")
Dim Locale As String = jResp.StringOf("user.locale")
Dim Locale_id As String = jResp.StringOf("user.locale_id")
Dim Moderator As String = jResp.StringOf("user.moderator")
Dim Notes As String = jResp.StringOf("user.notes")
Dim Only_private_comments As String = jResp.StringOf("user.only_private_comments")
Dim Organization_id As String = jResp.StringOf("user.organization_id")
Dim Phone As String = jResp.StringOf("user.phone")
Dim Dolorea1 As Boolean = jResp.BoolOf("user.photo.dolorea1")
Dim Deserunt3 As String = jResp.StringOf("user.photo.deserunt3")
Dim Remote_photo_url As String = jResp.StringOf("user.remote_photo_url")
Dim Report_csv As String = jResp.StringOf("user.report_csv")
Dim Restricted_agent As String = jResp.StringOf("user.restricted_agent")
Dim Role As String = jResp.StringOf("user.role")
Dim Role_type As String = jResp.StringOf("user.role_type")
Dim v_Shared As String = jResp.StringOf("user.shared")
Dim Shared_agent As String = jResp.StringOf("user.shared_agent")
Dim Shared_phone_number As String = jResp.StringOf("user.shared_phone_number")
Dim Signature As String = jResp.StringOf("user.signature")
Dim Suspended As String = jResp.StringOf("user.suspended")
Dim Tags As String = jResp.StringOf("user.tags")
Dim Ticket_restriction As String = jResp.StringOf("user.ticket_restriction")
Dim Time_zone As String = jResp.StringOf("user.time_zone")
Dim Two_factor_auth_enabled As String = jResp.StringOf("user.two_factor_auth_enabled")
Dim Updated_at As String = jResp.StringOf("user.updated_at")
Dim v_Url As String = jResp.StringOf("user.url")
Dim Nostrudacc As String = jResp.StringOf("user.user_fields.nostrudacc")
Dim In_80e As String = jResp.StringOf("user.user_fields.in_80e")
Dim Proident_e2 As Boolean = jResp.BoolOf("user.user_fields.proident_e2")
Dim Voluptate_98 As Integer = jResp.IntOf("user.user_fields.voluptate_98")
Dim Verified As String = jResp.StringOf("user.verified")

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/users/:user_id

Postman Collection Item JSON

{
  "name": "Show User",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/users/:user_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "users",
        ":user_id"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>"
        }
      ]
    },
    "description": "#### 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/users/:user_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "users",
            ":user_id"
          ],
          "variable": [
            {
              "key": "user_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"user\": {\n    \"name\": \"<string>\",\n    \"active\": \"<boolean>\",\n    \"alias\": \"<string>\",\n    \"chat_only\": \"<boolean>\",\n    \"created_at\": \"<string>\",\n    \"custom_role_id\": \"<integer>\",\n    \"default_group_id\": \"<integer>\",\n    \"details\": \"<string>\",\n    \"email\": \"<string>\",\n    \"external_id\": \"<string>\",\n    \"iana_time_zone\": \"<string>\",\n    \"id\": \"<integer>\",\n    \"last_login_at\": \"<string>\",\n    \"locale\": \"<string>\",\n    \"locale_id\": \"<integer>\",\n    \"moderator\": \"<boolean>\",\n    \"notes\": \"<string>\",\n    \"only_private_comments\": \"<boolean>\",\n    \"organization_id\": \"<integer>\",\n    \"phone\": \"<string>\",\n    \"photo\": {\n      \"dolorea1\": false,\n      \"deserunt3\": 95124319.10825741\n    },\n    \"remote_photo_url\": \"<string>\",\n    \"report_csv\": \"<boolean>\",\n    \"restricted_agent\": \"<boolean>\",\n    \"role\": \"<string>\",\n    \"role_type\": \"<integer>\",\n    \"shared\": \"<boolean>\",\n    \"shared_agent\": \"<boolean>\",\n    \"shared_phone_number\": \"<boolean>\",\n    \"signature\": \"<string>\",\n    \"suspended\": \"<boolean>\",\n    \"tags\": \"<array>\",\n    \"ticket_restriction\": \"<string>\",\n    \"time_zone\": \"<string>\",\n    \"two_factor_auth_enabled\": \"<boolean>\",\n    \"updated_at\": \"<string>\",\n    \"url\": \"<string>\",\n    \"user_fields\": {\n      \"nostrudacc\": -12929960.546221554,\n      \"in_80e\": 25167751.960886702,\n      \"proident_e2\": true,\n      \"voluptate_98\": -58995022\n    },\n    \"verified\": \"<boolean>\"\n  }\n}"
    }
  ]
}