Chilkat Online Tools

VB6 / 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 ChilkatHttp
Dim success As Long

http.BasicAuth = 1
http.Login = "{{secretId}}"
http.Password = "{{secretPassword}}"

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

Dim resp As ChilkatHttpResponse
Set resp = http.QuickRequestParams("GET","https://domain.com/api/institutions/",queryParams)
If (http.LastMethodSuccess = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim sbResponseBody As New ChilkatStringBuilder
success = resp.GetBodySb(sbResponseBody)

Dim jResp As New ChilkatJsonObject
success = jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = 0

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

Dim respStatusCode As Long
respStatusCode = resp.StatusCode
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print resp.Header
    Debug.Print "Failed."

    Exit Sub
End If

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

' {
'   "count": "<integer>",
'   "next": "<string>",
'   "previous": "<string>",
'   "results": [
'     {
'       "id": "<string>",
'       "name": "<string>",
'       "type": "culpa dolore in",
'       "website": "<string>",
'       "display_name": "<string>",
'       "country_codes": [
'         "<string>",
'         "<string>"
'       ],
'       "primary_color": "<string>",
'       "logo": "<string>",
'       "icon_logo": "<string>",
'       "text_logo": "<string>",
'       "form_fields": [
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "type": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "label": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "placeholder": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation_message": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "value": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         },
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "type": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "label": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "placeholder": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation_message": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "value": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         }
'       ],
'       "features": [
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "description": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         },
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "description": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         }
'       ]
'     },
'     {
'       "id": "<string>",
'       "name": "<string>",
'       "type": "incididunt ut",
'       "website": "<string>",
'       "display_name": "<string>",
'       "country_codes": [
'         "<string>",
'         "<string>"
'       ],
'       "primary_color": "<string>",
'       "logo": "<string>",
'       "icon_logo": "<string>",
'       "text_logo": "<string>",
'       "form_fields": [
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "type": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "label": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "placeholder": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation_message": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "value": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         },
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "type": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "label": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "placeholder": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "validation_message": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "value": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         }
'       ],
'       "features": [
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "description": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         },
'         {
'           "name": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           },
'           "description": {
'             "value": "<Error: Too many levels of nesting to fake this schema>"
'           }
'         }
'       ]
'     }
'   ]
' }

' 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 name As String
Dim v_type As String
Dim website As String
Dim display_name As String
Dim primary_color As String
Dim logo As String
Dim icon_logo As String
Dim text_logo As String
Dim j As Long
Dim count_j As Long
Dim strVal As String
Dim Value As String
Dim typeValue As String
Dim labelValue As String
Dim validationValue As String
Dim placeholderValue As String
Dim validation_messageValue As String
Dim valueValue As String
Dim nameValue As String
Dim descriptionValue 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 Long
i = 0
Dim count_i As Long
count_i = jResp.SizeOfArray("results")
Do While i < count_i
    jResp.I = i
    id = jResp.StringOf("results[i].id")
    name = jResp.StringOf("results[i].name")
    v_type = jResp.StringOf("results[i].type")
    website = jResp.StringOf("results[i].website")
    display_name = jResp.StringOf("results[i].display_name")
    primary_color = jResp.StringOf("results[i].primary_color")
    logo = jResp.StringOf("results[i].logo")
    icon_logo = jResp.StringOf("results[i].icon_logo")
    text_logo = jResp.StringOf("results[i].text_logo")
    j = 0
    count_j = jResp.SizeOfArray("results[i].country_codes")
    Do While j < count_j
        jResp.J = j
        strVal = jResp.StringOf("results[i].country_codes[j]")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("results[i].form_fields")
    Do While j < count_j
        jResp.J = j
        Value = jResp.StringOf("results[i].form_fields[j].name.value")
        typeValue = jResp.StringOf("results[i].form_fields[j].type.value")
        labelValue = jResp.StringOf("results[i].form_fields[j].label.value")
        validationValue = jResp.StringOf("results[i].form_fields[j].validation.value")
        placeholderValue = jResp.StringOf("results[i].form_fields[j].placeholder.value")
        validation_messageValue = jResp.StringOf("results[i].form_fields[j].validation_message.value")
        valueValue = jResp.StringOf("results[i].form_fields[j].value.value")
        j = j + 1
    Loop
    j = 0
    count_j = jResp.SizeOfArray("results[i].features")
    Do While j < count_j
        jResp.J = j
        nameValue = jResp.StringOf("results[i].features[j].name.value")
        descriptionValue = jResp.StringOf("results[i].features[j].description.value")
        j = j + 1
    Loop
    i = i + 1
Loop

Curl Command

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

Postman Collection Item JSON

{
  "name": "List",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/institutions/?page=1",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "institutions",
        ""
      ],
      "query": [
        {
          "key": "page",
          "value": "1",
          "description": "A page number within the paginated result set."
        }
      ]
    },
    "description": "Get a paginated list of all the institutions currently supported by Belvo. 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/institutions?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions"
          ],
          "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\": \"<string>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"type\": \"culpa dolore in\",\n\t\t\t\"website\": \"<string>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"country_codes\": [\n\t\t\t\t\"<string>\",\n\t\t\t\t\"<string>\"\n\t\t\t],\n\t\t\t\"primary_color\": \"<string>\",\n\t\t\t\"logo\": \"<string>\",\n\t\t\t\"icon_logo\": \"<string>\",\n\t\t\t\"text_logo\": \"<string>\",\n\t\t\t\"form_fields\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"label\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"placeholder\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation_message\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"label\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"placeholder\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation_message\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"features\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<string>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"type\": \"incididunt ut\",\n\t\t\t\"website\": \"<string>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"country_codes\": [\n\t\t\t\t\"<string>\",\n\t\t\t\t\"<string>\"\n\t\t\t],\n\t\t\t\"primary_color\": \"<string>\",\n\t\t\t\"logo\": \"<string>\",\n\t\t\t\"icon_logo\": \"<string>\",\n\t\t\t\"text_logo\": \"<string>\",\n\t\t\t\"form_fields\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"label\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"placeholder\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation_message\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"type\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"label\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"placeholder\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"validation_message\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"value\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"features\": [\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"name\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t},\n\t\t\t\t\t\"description\": {\n\t\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t]\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/institutions?page=<integer>",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions"
          ],
          "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]"
    }
  ]
}