Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *value;
const wchar_t *id;
const wchar_t *Id;
const wchar_t *Value;
const wchar_t *InstitutionValue;
const wchar_t *Collected_atValue;
const wchar_t *CategoryValue;
const wchar_t *TypeValue;
const wchar_t *NameValue;
const wchar_t *NumberValue;
const wchar_t *BalanceValue;
const wchar_t *CurrencyValue;
const wchar_t *Bank_product_idValue;
const wchar_t *Internal_identificationValue;
const wchar_t *Public_identification_nameValue;
const wchar_t *Public_identification_valueValue;
const wchar_t *Last_accessed_atValue;
const wchar_t *Credit_dataValue;
const wchar_t *Loan_dataValue;
const wchar_t *Funds_dataValue;
const wchar_t *Gig_payment_dataValue;
const wchar_t *collected_at;
const wchar_t *value_date;
const wchar_t *accounting_date;
const wchar_t *amount;
const wchar_t *balance;
const wchar_t *v_currency;
const wchar_t *description;
const wchar_t *observations;
const wchar_t *category;
const wchar_t *reference;
const wchar_t *v_type;
const wchar_t *status;
const wchar_t *Pickup_at;
const wchar_t *Dropoff_at;
const wchar_t *Request_at;
const wchar_t *Pickup_address;
const wchar_t *Dropoff_address;
const wchar_t *Pickup_latitude;
const wchar_t *Pickup_longitude;
const wchar_t *Dropoff_latitude;
const wchar_t *Dropoff_longitude;
const wchar_t *Distance;
const wchar_t *Payment_method;
const wchar_t *Vehicle_type;
const wchar_t *Merchant_type;
const wchar_t *Collected_at;
const wchar_t *Bill_name;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
CkHttpW_putBasicAuth(http,TRUE);
CkHttpW_putLogin(http,L"{{secretId}}");
CkHttpW_putPassword(http,L"{{secretPassword}}");
sbResponseBody = CkStringBuilderW_Create();
success = CkHttpW_QuickGetSb(http,L"https://domain.com/api/transactions/:id/",sbResponseBody);
if (success == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
return;
}
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpW_getLastStatus(http);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpW_lastHeader(http));
wprintf(L"Failed.\n");
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "link": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "institution": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "collected_at": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "category": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "type": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "name": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "number": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "balance": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "currency": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "bank_product_id": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "internal_identification": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "public_identification_name": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "public_identification_value": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "last_accessed_at": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "credit_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "loan_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "funds_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// "gig_payment_data": {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// },
// "collected_at": "<date>",
// "value_date": "<string>",
// "accounting_date": "<date>",
// "amount": "<number>",
// "balance": "<number>",
// "currency": "<string>",
// "description": "<string>",
// "observations": "<string>",
// "category": "<string>",
// "reference": "<string>",
// "type": "eiusmod veniam ea sint",
// "status": "est nostrud",
// "gig_data": {
// "pickup_at": "<dateTime>",
// "dropoff_at": "<dateTime>",
// "request_at": "<dateTime>",
// "pickup_address": "<string>",
// "dropoff_address": "<string>",
// "pickup_latitude": "<number>",
// "pickup_longitude": "<number>",
// "dropoff_latitude": "<number>",
// "dropoff_longitude": "<number>",
// "distance": "<number>",
// "payment_method": "<string>",
// "vehicle_type": "<string>",
// "merchant_type": "<string>",
// "breakdown": [
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// },
// {
// "value": "<Error: Too many levels of nesting to fake this schema>"
// }
// ],
// "collected_at": "<dateTime>"
// },
// "credit_card_data": {
// "bill_name": "<string>"
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
id = CkJsonObjectW_stringOf(jResp,L"id");
Id = CkJsonObjectW_stringOf(jResp,L"account.id");
Value = CkJsonObjectW_stringOf(jResp,L"account.link.value");
InstitutionValue = CkJsonObjectW_stringOf(jResp,L"account.institution.value");
Collected_atValue = CkJsonObjectW_stringOf(jResp,L"account.collected_at.value");
CategoryValue = CkJsonObjectW_stringOf(jResp,L"account.category.value");
TypeValue = CkJsonObjectW_stringOf(jResp,L"account.type.value");
NameValue = CkJsonObjectW_stringOf(jResp,L"account.name.value");
NumberValue = CkJsonObjectW_stringOf(jResp,L"account.number.value");
BalanceValue = CkJsonObjectW_stringOf(jResp,L"account.balance.value");
CurrencyValue = CkJsonObjectW_stringOf(jResp,L"account.currency.value");
Bank_product_idValue = CkJsonObjectW_stringOf(jResp,L"account.bank_product_id.value");
Internal_identificationValue = CkJsonObjectW_stringOf(jResp,L"account.internal_identification.value");
Public_identification_nameValue = CkJsonObjectW_stringOf(jResp,L"account.public_identification_name.value");
Public_identification_valueValue = CkJsonObjectW_stringOf(jResp,L"account.public_identification_value.value");
Last_accessed_atValue = CkJsonObjectW_stringOf(jResp,L"account.last_accessed_at.value");
Credit_dataValue = CkJsonObjectW_stringOf(jResp,L"account.credit_data.value");
Loan_dataValue = CkJsonObjectW_stringOf(jResp,L"account.loan_data.value");
Funds_dataValue = CkJsonObjectW_stringOf(jResp,L"account.funds_data.value");
Gig_payment_dataValue = CkJsonObjectW_stringOf(jResp,L"account.gig_payment_data.value");
collected_at = CkJsonObjectW_stringOf(jResp,L"collected_at");
value_date = CkJsonObjectW_stringOf(jResp,L"value_date");
accounting_date = CkJsonObjectW_stringOf(jResp,L"accounting_date");
amount = CkJsonObjectW_stringOf(jResp,L"amount");
balance = CkJsonObjectW_stringOf(jResp,L"balance");
v_currency = CkJsonObjectW_stringOf(jResp,L"currency");
description = CkJsonObjectW_stringOf(jResp,L"description");
observations = CkJsonObjectW_stringOf(jResp,L"observations");
category = CkJsonObjectW_stringOf(jResp,L"category");
reference = CkJsonObjectW_stringOf(jResp,L"reference");
v_type = CkJsonObjectW_stringOf(jResp,L"type");
status = CkJsonObjectW_stringOf(jResp,L"status");
Pickup_at = CkJsonObjectW_stringOf(jResp,L"gig_data.pickup_at");
Dropoff_at = CkJsonObjectW_stringOf(jResp,L"gig_data.dropoff_at");
Request_at = CkJsonObjectW_stringOf(jResp,L"gig_data.request_at");
Pickup_address = CkJsonObjectW_stringOf(jResp,L"gig_data.pickup_address");
Dropoff_address = CkJsonObjectW_stringOf(jResp,L"gig_data.dropoff_address");
Pickup_latitude = CkJsonObjectW_stringOf(jResp,L"gig_data.pickup_latitude");
Pickup_longitude = CkJsonObjectW_stringOf(jResp,L"gig_data.pickup_longitude");
Dropoff_latitude = CkJsonObjectW_stringOf(jResp,L"gig_data.dropoff_latitude");
Dropoff_longitude = CkJsonObjectW_stringOf(jResp,L"gig_data.dropoff_longitude");
Distance = CkJsonObjectW_stringOf(jResp,L"gig_data.distance");
Payment_method = CkJsonObjectW_stringOf(jResp,L"gig_data.payment_method");
Vehicle_type = CkJsonObjectW_stringOf(jResp,L"gig_data.vehicle_type");
Merchant_type = CkJsonObjectW_stringOf(jResp,L"gig_data.merchant_type");
Collected_at = CkJsonObjectW_stringOf(jResp,L"gig_data.collected_at");
Bill_name = CkJsonObjectW_stringOf(jResp,L"credit_card_data.bill_name");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"gig_data.breakdown");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
value = CkJsonObjectW_stringOf(jResp,L"gig_data.breakdown[i].value");
i = i + 1;
}
CkHttpW_Dispose(http);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
}
Curl Command
curl -X GET
-u '{{secretId}}:{{secretPassword}}'
https://domain.com/api/transactions/:id/
Postman Collection Item JSON
{
"name": "Detail",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/api/transactions/:id/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":id",
""
],
"variable": [
{
"key": "id",
"value": "consequa",
"description": "(Required) The `transaction.id` you want to get detailed information about."
}
]
},
"description": "Get the details of a specific transaction."
},
"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/transactions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":id"
],
"variable": [
{
"key": "id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"id\": \"<uuid>\",\n\t\"account\": {\n\t\t\"id\": \"<uuid>\",\n\t\t\"link\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"institution\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"collected_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"category\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"type\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"number\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"balance\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"currency\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"bank_product_id\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"internal_identification\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_name\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"public_identification_value\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"last_accessed_at\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"credit_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"loan_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"funds_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t},\n\t\t\"gig_payment_data\": {\n\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t}\n\t},\n\t\"collected_at\": \"<date>\",\n\t\"value_date\": \"<string>\",\n\t\"accounting_date\": \"<date>\",\n\t\"amount\": \"<number>\",\n\t\"balance\": \"<number>\",\n\t\"currency\": \"<string>\",\n\t\"description\": \"<string>\",\n\t\"observations\": \"<string>\",\n\t\"category\": \"<string>\",\n\t\"reference\": \"<string>\",\n\t\"type\": \"eiusmod veniam ea sint\",\n\t\"status\": \"est nostrud\",\n\t\"gig_data\": {\n\t\t\"pickup_at\": \"<dateTime>\",\n\t\t\"dropoff_at\": \"<dateTime>\",\n\t\t\"request_at\": \"<dateTime>\",\n\t\t\"pickup_address\": \"<string>\",\n\t\t\"dropoff_address\": \"<string>\",\n\t\t\"pickup_latitude\": \"<number>\",\n\t\t\"pickup_longitude\": \"<number>\",\n\t\t\"dropoff_latitude\": \"<number>\",\n\t\t\"dropoff_longitude\": \"<number>\",\n\t\t\"distance\": \"<number>\",\n\t\t\"payment_method\": \"<string>\",\n\t\t\"vehicle_type\": \"<string>\",\n\t\t\"merchant_type\": \"<string>\",\n\t\t\"breakdown\": [\n\t\t\t{\n\t\t\t\t\"value\": \"<Error: Too many levels of nesting to fake this schema>\"\n\t\t\t},\n\t\t\t{\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\"collected_at\": \"<dateTime>\"\n\t},\n\t\"credit_card_data\": {\n\t\t\"bill_name\": \"<string>\"\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/transactions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":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/transactions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"transactions",
":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]"
}
]
}
