Chilkat Online Tools

VB.NET / Support API / List Resource Collections

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

' {
'   "count": "<integer>",
'   "next_page": "<string>",
'   "previous_page": "<string>",
'   "resource_collections": [
'     {
'       "created_at": "<dateTime>",
'       "id": "<integer>",
'       "resources": "<array>",
'       "updated_at": "<dateTime>"
'     },
'     {
'       "created_at": "<dateTime>",
'       "id": "<integer>",
'       "resources": "<array>",
'       "updated_at": "<dateTime>"
'     }
'   ]
' }

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



Dim created_at As String
Dim id As String
Dim resources As String
Dim updated_at As String

Dim count As String = jResp.StringOf("count")
Dim next_page As String = jResp.StringOf("next_page")
Dim previous_page As String = jResp.StringOf("previous_page")
Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("resource_collections")
While i < count_i
    jResp.I = i
    created_at = jResp.StringOf("resource_collections[i].created_at")
    id = jResp.StringOf("resource_collections[i].id")
    resources = jResp.StringOf("resource_collections[i].resources")
    updated_at = jResp.StringOf("resource_collections[i].updated_at")
    i = i + 1
End While

Curl Command

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

Postman Collection Item JSON

{
  "name": "List Resource Collections",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/resource_collections",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "resource_collections"
      ]
    },
    "description": "Lists resource collections for the account.\n\n#### Allowed for\n\n* Admins\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/resource_collections",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "resource_collections"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"count\": \"<integer>\",\n  \"next_page\": \"<string>\",\n  \"previous_page\": \"<string>\",\n  \"resource_collections\": [\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"resources\": \"<array>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"created_at\": \"<dateTime>\",\n      \"id\": \"<integer>\",\n      \"resources\": \"<array>\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ]\n}"
    }
  ]
}