Chilkat Online Tools

C# / 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.

Chilkat.Http http = new Chilkat.Http();
bool success;

http.BasicAuth = true;
http.Login = "{{secretId}}";
http.Password = "{{secretPassword}}";

Chilkat.JsonObject queryParams = new Chilkat.JsonObject();
queryParams.UpdateInt("page",1);

Chilkat.HttpResponse resp = http.QuickRequestParams("GET","https://domain.com/api/institutions/",queryParams);
if (http.LastMethodSuccess == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);

Chilkat.JsonObject jResp = new Chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;

Debug.WriteLine("Response Body:");
Debug.WriteLine(jResp.Emit());

int respStatusCode = resp.StatusCode;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(resp.Header);
    Debug.WriteLine("Failed.");

    return;
}

// 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

string id;
string name;
string v_type;
string website;
string display_name;
string primary_color;
string logo;
string icon_logo;
string text_logo;
int j;
int count_j;
string strVal;
string Value;
string typeValue;
string labelValue;
string validationValue;
string placeholderValue;
string validation_messageValue;
string valueValue;
string nameValue;
string descriptionValue;

string count = jResp.StringOf("count");
string v_next = jResp.StringOf("next");
string previous = jResp.StringOf("previous");
int i = 0;
int count_i = jResp.SizeOfArray("results");
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");
    while (j < count_j) {
        jResp.J = j;
        strVal = jResp.StringOf("results[i].country_codes[j]");
        j = j + 1;
    }

    j = 0;
    count_j = jResp.SizeOfArray("results[i].form_fields");
    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;
    }

    j = 0;
    count_j = jResp.SizeOfArray("results[i].features");
    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;
    }

    i = i + 1;
}

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]"
    }
  ]
}