Chilkat Online Tools

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

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

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

Chilkat.StringBuilder sbResponseBody = new Chilkat.StringBuilder();
success = http.QuickGetSb("https://domain.com/api/institutions/:id/",sbResponseBody);
if (success == false) {
    Debug.WriteLine(http.LastErrorText);
    return;
}

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

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

int respStatusCode = http.LastStatus;
Debug.WriteLine("Response Status Code = " + Convert.ToString(respStatusCode));
if (respStatusCode >= 400) {
    Debug.WriteLine("Response Header:");
    Debug.WriteLine(http.LastHeader);
    Debug.WriteLine("Failed.");
    return;
}

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

string strVal;
string Value;
string typeValue;
string labelValue;
string validationValue;
string placeholderValue;
string validation_messageValue;
string valueValue;
string nameValue;
string descriptionValue;

string id = jResp.StringOf("id");
string name = jResp.StringOf("name");
string v_type = jResp.StringOf("type");
string website = jResp.StringOf("website");
string display_name = jResp.StringOf("display_name");
string primary_color = jResp.StringOf("primary_color");
string logo = jResp.StringOf("logo");
string icon_logo = jResp.StringOf("icon_logo");
string text_logo = jResp.StringOf("text_logo");
int i = 0;
int count_i = jResp.SizeOfArray("country_codes");
while (i < count_i) {
    jResp.I = i;
    strVal = jResp.StringOf("country_codes[i]");
    i = i + 1;
}

i = 0;
count_i = jResp.SizeOfArray("form_fields");
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;
}

i = 0;
count_i = jResp.SizeOfArray("features");
while (i < count_i) {
    jResp.I = i;
    nameValue = jResp.StringOf("features[i].name.value");
    descriptionValue = jResp.StringOf("features[i].description.value");
    i = i + 1;
}

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