Chilkat Online Tools

VB.NET / Support API / List Sessions

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/sessions",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)

' {
'   "sessions": [
'     {
'       "id": "<integer>",
'       "authenticated_at": "<string>",
'       "last_seen_at": "<string>",
'       "url": "<string>",
'       "user_id": "<integer>"
'     },
'     {
'       "id": "<integer>",
'       "authenticated_at": "<string>",
'       "last_seen_at": "<string>",
'       "url": "<string>",
'       "user_id": "<integer>"
'     }
'   ]
' }

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



Dim id As String
Dim authenticated_at As String
Dim last_seen_at As String
Dim url As String
Dim user_id As String

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("sessions")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("sessions[i].id")
    authenticated_at = jResp.StringOf("sessions[i].authenticated_at")
    last_seen_at = jResp.StringOf("sessions[i].last_seen_at")
    url = jResp.StringOf("sessions[i].url")
    user_id = jResp.StringOf("sessions[i].user_id")
    i = i + 1
End While

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Sessions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sessions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sessions"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>",
          "description": "(Required) The id of the user"
        }
      ]
    },
    "description": "If authenticated as an admin, returns all the account's sessions. If authenticated as an agent or end user, returns only the sessions of the user making the request.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\n#### Allowed For\n\n* Admins, Agents, End users\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/sessions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sessions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sessions\": [\n    {\n      \"id\": \"<integer>\",\n      \"authenticated_at\": \"<string>\",\n      \"last_seen_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_id\": \"<integer>\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"authenticated_at\": \"<string>\",\n      \"last_seen_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_id\": \"<integer>\"\n    }\n  ]\n}"
    }
  ]
}