Chilkat Online Tools

delphiAx / Belvo API Docs / Detail

Back to Collection Items

var
http: TChilkatHttp;
success: Integer;
sbResponseBody: TChilkatStringBuilder;
jarrResp: TChilkatJsonArray;
respStatusCode: Integer;
json: IChilkatJsonObject;
id: WideString;
collected_at: WideString;
Name: WideString;
v_Currency: WideString;
Category: WideString;
v_currency: WideString;
j: Integer;
count_j: Integer;
confidence: WideString;
v_type: WideString;
k: Integer;
count_k: Integer;
value: WideString;
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 := TChilkatHttp.Create(Self);

http.BasicAuth := 1;
http.Login := '{{secretId}}';
http.Password := '{{secretPassword}}';

sbResponseBody := TChilkatStringBuilder.Create(Self);
success := http.QuickGetSb('https://domain.com/api/incomes/:id/',sbResponseBody.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(http.LastErrorText);
    Exit;
  end;

jarrResp := TChilkatJsonArray.Create(Self);
jarrResp.LoadSb(sbResponseBody.ControlInterface);
jarrResp.EmitCompact := 0;

Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(jarrResp.Emit());

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

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

// [
//   {
//     "id": "<uuid>",
//     "collected_at": "<dateTime>",
//     "account": {
//       "name": "<string>",
//       "currency": "<string>",
//       "category": "adipisicing pariatur sit"
//     },
//     "currency": "<string>",
//     "sources": [
//       {
//         "transactions": [
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           },
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           }
//         ],
//         "confidence": "<string>",
//         "type": "<string>"
//       },
//       {
//         "transactions": [
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           },
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           }
//         ],
//         "confidence": "<string>",
//         "type": "<string>"
//       }
//     ]
//   },
//   {
//     "id": "<uuid>",
//     "collected_at": "<dateTime>",
//     "account": {
//       "name": "<string>",
//       "currency": "<string>",
//       "category": "exercitation consequat"
//     },
//     "currency": "<string>",
//     "sources": [
//       {
//         "transactions": [
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           },
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           }
//         ],
//         "confidence": "<string>",
//         "type": "<string>"
//       },
//       {
//         "transactions": [
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           },
//           {
//             "value": "<Error: Too many levels of nesting to fake this schema>"
//           }
//         ],
//         "confidence": "<string>",
//         "type": "<string>"
//       }
//     ]
//   }
// ]

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i := 0;
count_i := jarrResp.Size;
while i < count_i do
  begin
    json := jarrResp.ObjectAt(i);
    id := json.StringOf('id');
    collected_at := json.StringOf('collected_at');
    Name := json.StringOf('account.name');
    v_Currency := json.StringOf('account.currency');
    Category := json.StringOf('account.category');
    v_currency := json.StringOf('currency');
    j := 0;
    count_j := json.SizeOfArray('sources');
    while j < count_j do
      begin
        json.J := j;
        confidence := json.StringOf('sources[j].confidence');
        v_type := json.StringOf('sources[j].type');
        k := 0;
        count_k := json.SizeOfArray('sources[j].transactions');
        while k < count_k do
          begin
            json.K := k;
            value := json.StringOf('sources[j].transactions[k].value');
            k := k + 1;
          end;

        j := j + 1;
      end;

    i := i + 1;
  end;

Curl Command

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

Postman Collection Item JSON

{
  "name": "Detail",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/api/incomes/:id/",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "incomes",
        ":id",
        ""
      ],
      "variable": [
        {
          "key": "id",
          "value": "consequa",
          "description": "(Required) The `income.id` you want to get detailed information about."
        }
      ]
    },
    "description": "Get the details of a specific income."
  },
  "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/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":id"
          ],
          "variable": [
            {
              "key": "id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"adipisicing pariatur sit\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\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{\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\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\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{\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\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t}\n\t\t]\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"account\": {\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"currency\": \"<string>\",\n\t\t\t\"category\": \"exercitation consequat\"\n\t\t},\n\t\t\"currency\": \"<string>\",\n\t\t\"sources\": [\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\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{\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\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"transactions\": [\n\t\t\t\t\t{\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{\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\"confidence\": \"<string>\",\n\t\t\t\t\"type\": \"<string>\"\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/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":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/incomes/:id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "incomes",
            ":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]"
    }
  ]
}