Chilkat Online Tools

VB6 / Belvo API Docs / Detail

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 sbResponseBody As New ChilkatStringBuilder
success = http.QuickGetSb("https://domain.com/api/institutions/:id/",sbResponseBody)
If (success = 0) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

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 = http.LastStatus
Debug.Print "Response Status Code = " & respStatusCode
If (respStatusCode >= 400) Then
    Debug.Print "Response Header:"
    Debug.Print http.LastHeader
    Debug.Print "Failed."
    Exit Sub
End If

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

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

Curl Command

curl -X GET
	-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/institutions/:id/

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/institutions/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "institutions",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `institution.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific institution."
  },
  "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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n\t\"id\": \"<string>\",\n\t\"name\": \"<string>\",\n\t\"type\": \"nulla Excepteur nisi\",\n\t\"website\": \"<string>\",\n\t\"display_name\": \"<string>\",\n\t\"country_codes\": [\n\t\t\"<string>\",\n\t\t\"<string>\"\n\t],\n\t\"primary_color\": \"<string>\",\n\t\"logo\": \"<string>\",\n\t\"icon_logo\": \"<string>\",\n\t\"text_logo\": \"<string>\",\n\t\"form_fields\": [\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"label\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"placeholder\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation_message\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"type\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"label\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"placeholder\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"validation_message\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"value\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t}\n\t],\n\t\"features\": [\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"name\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t\"description\": {\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\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/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "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]"
    },
    {
      "name": "Too Many Sessions",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/institutions/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "institutions",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_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]"
    }
  ]
}