Chilkat Online Tools

Xojo / Belvo API Docs / List

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 = "{{secretId}}"
http.Password = "{{secretPassword}}"

Dim queryParams As New Chilkat.JsonObject
success = queryParams.UpdateInt("page",1)

Dim resp As Chilkat.HttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/api/links/",queryParams)
If (http.LastMethodSuccess = False) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim sbResponseBody As New Chilkat.StringBuilder
success = resp.GetBodySb(sbResponseBody)

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

System.DebugLog("Response Body:")
System.DebugLog(jResp.Emit())

Dim respStatusCode As Int32
respStatusCode = resp.StatusCode
System.DebugLog("Response Status Code = " + Str(respStatusCode))
If (respStatusCode >= 400) Then
    System.DebugLog("Response Header:")
    System.DebugLog(resp.Header)
    System.DebugLog("Failed.")

    Return
End If

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

// {
//   "count": "<integer>",
//   "next": "<string>",
//   "previous": "<string>",
//   "results": [
//     {
//       "id": "<uuid>",
//       "institution": "<string>",
//       "access_mode": "<string>",
//       "last_accessed_at": "<dateTime>",
//       "status": "<string>",
//       "created_by": "<uuid>",
//       "refresh_rate": "<string>"
//     },
//     {
//       "id": "<uuid>",
//       "institution": "<string>",
//       "access_mode": "<string>",
//       "last_accessed_at": "<dateTime>",
//       "status": "<string>",
//       "created_by": "<uuid>",
//       "refresh_rate": "<string>"
//     }
//   ]
// }

// 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 institution As String
Dim access_mode As String
Dim last_accessed_at As String
Dim status As String
Dim created_by As String
Dim refresh_rate As String

Dim count As String
count = jResp.StringOf("count")
Dim v_next As String
v_next = jResp.StringOf("next")
Dim previous As String
previous = jResp.StringOf("previous")
Dim i As Int32
i = 0
Dim count_i As Int32
count_i = jResp.SizeOfArray("results")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("results[i].id")
    institution = jResp.StringOf("results[i].institution")
    access_mode = jResp.StringOf("results[i].access_mode")
    last_accessed_at = jResp.StringOf("results[i].last_accessed_at")
    status = jResp.StringOf("results[i].status")
    created_by = jResp.StringOf("results[i].created_by")
    refresh_rate = jResp.StringOf("results[i].refresh_rate")
    i = i + 1
Wend

Curl Command

curl -G -d "page=1"
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/links/

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/links/?page=1",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "links",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set."
        }
      ]
    },
    "description": "Get a paginated list of all the existing links in your Belvo account. We return up to 100 results per page."
  },
  "response": [
    {
      "name": "Ok",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/links?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"count\": \"<integer>\",\n\t\"next\": \"<string>\",\n\t\"previous\": \"<string>\",\n\t\"results\": [\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"institution\": \"<string>\",\n\t\t\t\"access_mode\": \"<string>\",\n\t\t\t\"last_accessed_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"created_by\": \"<uuid>\",\n\t\t\t\"refresh_rate\": \"<string>\"\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"institution\": \"<string>\",\n\t\t\t\"access_mode\": \"<string>\",\n\t\t\t\"last_accessed_at\": \"<dateTime>\",\n\t\t\t\"status\": \"<string>\",\n\t\t\t\"created_by\": \"<uuid>\",\n\t\t\t\"refresh_rate\": \"<string>\"\n\t\t}\n\t]\n}"
    },
    {
      "name": "Unauthorized",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/links?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "links"
          ],
          "query": [
            {
              "key": "page",
              "value": "<integer>"
            }
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t},\n\t{\n\t\t\"code\": \"<string>\",\n\t\t\"message\": \"<string>\",\n\t\t\"request_id\": \"<string>\"\n\t}\n]"
    }
  ]
}