Chilkat Online Tools

Objective-C / Belvo API Docs / Detail

Back to Collection Items

#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonArray.h>
#import <CkoJsonObject.h>
#import <NSString.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/api/incomes/:id/" sbContent: sbResponseBody];
if (success == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

CkoJsonArray *jarrResp = [[CkoJsonArray alloc] init];
[jarrResp LoadSb: sbResponseBody];
jarrResp.EmitCompact = NO;

NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jarrResp Emit]);

int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",http.LastHeader);
    NSLog(@"%@",@"Failed.");
    return;
}

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

CkoJsonObject *json = 0;
NSString *id = 0;
NSString *collected_at = 0;
NSString *Name = 0;
NSString *v_Currency = 0;
NSString *Category = 0;
NSString *v_currency = 0;
int j;
int count_j;
NSString *confidence = 0;
NSString *v_type = 0;
int k;
int count_k;
NSString *value = 0;

int i = 0;
int count_i = [jarrResp.Size intValue];
while (i < count_i) {
    json = [jarrResp ObjectAt: [NSNumber numberWithInt: 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"] intValue];
    while (j < count_j) {
        json.J = [NSNumber numberWithInt: j];
        confidence = [json StringOf: @"sources[j].confidence"];
        v_type = [json StringOf: @"sources[j].type"];
        k = 0;
        count_k = [[json SizeOfArray: @"sources[j].transactions"] intValue];
        while (k < count_k) {
            json.K = [NSNumber numberWithInt: k];
            value = [json StringOf: @"sources[j].transactions[k].value"];
            k = k + 1;
        }

        j = j + 1;
    }

    i = i + 1;
}

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