Chilkat Online Tools

delphiDll / Belvo API Docs / Detail

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
strVal: PWideChar;
Value: PWideChar;
typeValue: PWideChar;
labelValue: PWideChar;
validationValue: PWideChar;
placeholderValue: PWideChar;
validation_messageValue: PWideChar;
valueValue: PWideChar;
nameValue: PWideChar;
descriptionValue: PWideChar;
id: PWideChar;
name: PWideChar;
v_type: PWideChar;
website: PWideChar;
display_name: PWideChar;
primary_color: PWideChar;
logo: PWideChar;
icon_logo: PWideChar;
text_logo: PWideChar;
i: Integer;
count_i: Integer;

begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

http := CkHttp_Create();

CkHttp_putBasicAuth(http,True);
CkHttp_putLogin(http,'{{secretId}}');
CkHttp_putPassword(http,'{{secretPassword}}');

sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/api/institutions/:id/',sbResponseBody);
if (success = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));

respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
  begin
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkHttp__lastHeader(http));
    Memo1.Lines.Add('Failed.');
    Exit;
  end;

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

id := CkJsonObject__stringOf(jResp,'id');
name := CkJsonObject__stringOf(jResp,'name');
v_type := CkJsonObject__stringOf(jResp,'type');
website := CkJsonObject__stringOf(jResp,'website');
display_name := CkJsonObject__stringOf(jResp,'display_name');
primary_color := CkJsonObject__stringOf(jResp,'primary_color');
logo := CkJsonObject__stringOf(jResp,'logo');
icon_logo := CkJsonObject__stringOf(jResp,'icon_logo');
text_logo := CkJsonObject__stringOf(jResp,'text_logo');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'country_codes');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    strVal := CkJsonObject__stringOf(jResp,'country_codes[i]');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'form_fields');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    Value := CkJsonObject__stringOf(jResp,'form_fields[i].name.value');
    typeValue := CkJsonObject__stringOf(jResp,'form_fields[i].type.value');
    labelValue := CkJsonObject__stringOf(jResp,'form_fields[i].label.value');
    validationValue := CkJsonObject__stringOf(jResp,'form_fields[i].validation.value');
    placeholderValue := CkJsonObject__stringOf(jResp,'form_fields[i].placeholder.value');
    validation_messageValue := CkJsonObject__stringOf(jResp,'form_fields[i].validation_message.value');
    valueValue := CkJsonObject__stringOf(jResp,'form_fields[i].value.value');
    i := i + 1;
  end;

i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'features');
while i < count_i do
  begin
    CkJsonObject_putI(jResp,i);
    nameValue := CkJsonObject__stringOf(jResp,'features[i].name.value');
    descriptionValue := CkJsonObject__stringOf(jResp,'features[i].description.value');
    i := i + 1;
  end;

CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);

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