Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.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}}";
CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateInt: @"page" value: [NSNumber numberWithInt: 1]];
CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/api/owners/" json: queryParams];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "count": "<integer>",
// "next": "<string>",
// "previous": "<string>",
// "results": [
// {
// "id": "<uuid>",
// "link": "<uuid>",
// "collected_at": "<dateTime>",
// "display_name": "<string>",
// "first_name": "<string>",
// "last_name": "<string>",
// "second_last_name": "<string>",
// "address": "<string>",
// "email": "<email>",
// "phone_number": "<string>",
// "accounts": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "gig_data": {
// "collected_at": "<dateTime>",
// "status": "<string>",
// "acceptance_rate": "<number>"
// }
// },
// {
// "id": "<uuid>",
// "link": "<uuid>",
// "collected_at": "<dateTime>",
// "display_name": "<string>",
// "first_name": "<string>",
// "last_name": "<string>",
// "second_last_name": "<string>",
// "address": "<string>",
// "email": "<email>",
// "phone_number": "<string>",
// "accounts": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "gig_data": {
// "collected_at": "<dateTime>",
// "status": "<string>",
// "acceptance_rate": "<number>"
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *id = 0;
NSString *link = 0;
NSString *collected_at = 0;
NSString *display_name = 0;
NSString *first_name = 0;
NSString *last_name = 0;
NSString *second_last_name = 0;
NSString *address = 0;
NSString *email = 0;
NSString *phone_number = 0;
NSString *Collected_at = 0;
NSString *Status = 0;
NSString *Acceptance_rate = 0;
int j;
int count_j;
NSString *value = 0;
NSString *count = [jResp StringOf: @"count"];
NSString *v_next = [jResp StringOf: @"next"];
NSString *previous = [jResp StringOf: @"previous"];
int i = 0;
int count_i = [[jResp SizeOfArray: @"results"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
id = [jResp StringOf: @"results[i].id"];
link = [jResp StringOf: @"results[i].link"];
collected_at = [jResp StringOf: @"results[i].collected_at"];
display_name = [jResp StringOf: @"results[i].display_name"];
first_name = [jResp StringOf: @"results[i].first_name"];
last_name = [jResp StringOf: @"results[i].last_name"];
second_last_name = [jResp StringOf: @"results[i].second_last_name"];
address = [jResp StringOf: @"results[i].address"];
email = [jResp StringOf: @"results[i].email"];
phone_number = [jResp StringOf: @"results[i].phone_number"];
Collected_at = [jResp StringOf: @"results[i].gig_data.collected_at"];
Status = [jResp StringOf: @"results[i].gig_data.status"];
Acceptance_rate = [jResp StringOf: @"results[i].gig_data.acceptance_rate"];
j = 0;
count_j = [[jResp SizeOfArray: @"results[i].accounts"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
value = [jResp StringOf: @"results[i].accounts[j].value"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -G -d "page=1"
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/owners/
Postman Collection Item JSON
{
"name": "List",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/owners/?page=1",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners",
""
],
"query": [
{
"key": "page",
"value": "1",
"description": "A page number within the paginated result set."
}
]
},
"description": "Get a paginated list of all existing owners in your Belvo account. 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/owners?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
],
"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\": \"<uuid>\",\n\t\t\t\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"first_name\": \"<string>\",\n\t\t\t\"last_name\": \"<string>\",\n\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\"address\": \"<string>\",\n\t\t\t\"email\": \"<email>\",\n\t\t\t\"phone_number\": \"<string>\",\n\t\t\t\"accounts\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"gig_data\": {\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"status\": \"<string>\",\n\t\t\t\t\"acceptance_rate\": \"<number>\"\n\t\t\t}\n\t\t},\n\t\t{\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"link\": \"<uuid>\",\n\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\"display_name\": \"<string>\",\n\t\t\t\"first_name\": \"<string>\",\n\t\t\t\"last_name\": \"<string>\",\n\t\t\t\"second_last_name\": \"<string>\",\n\t\t\t\"address\": \"<string>\",\n\t\t\t\"email\": \"<email>\",\n\t\t\t\"phone_number\": \"<string>\",\n\t\t\t\"accounts\": [\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t},\n\t\t\t\t{\n\t\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t\t}\n\t\t\t],\n\t\t\t\"gig_data\": {\n\t\t\t\t\"collected_at\": \"<dateTime>\",\n\t\t\t\t\"status\": \"<string>\",\n\t\t\t\t\"acceptance_rate\": \"<number>\"\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/owners?page=<integer>",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"owners"
],
"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]"
}
]
}
