Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkHttp.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
CkHttp::setCkBasicAuth(http, 1)
CkHttp::setCkLogin(http, "{{secretId}}")
CkHttp::setCkPassword(http, "{{secretPassword}}")
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkHttp::ckQuickGetSb(http,"https://domain.com/api/transactions/:id/",sbResponseBody)
If success = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,sbResponseBody)
CkJsonObject::setCkEmitCompact(jResp, 0)
Debug "Response Body:"
Debug CkJsonObject::ckEmit(jResp)
respStatusCode.i = CkHttp::ckLastStatus(http)
Debug "Response Status Code = " + Str(respStatusCode)
If respStatusCode >= 400
Debug "Response Header:"
Debug CkHttp::ckLastHeader(http)
Debug "Failed."
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndIf
; 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
value.s
id.s = CkJsonObject::ckStringOf(jResp,"id")
Id.s = CkJsonObject::ckStringOf(jResp,"account.id")
Value.s = CkJsonObject::ckStringOf(jResp,"account.link.value")
InstitutionValue.s = CkJsonObject::ckStringOf(jResp,"account.institution.value")
Collected_atValue.s = CkJsonObject::ckStringOf(jResp,"account.collected_at.value")
CategoryValue.s = CkJsonObject::ckStringOf(jResp,"account.category.value")
TypeValue.s = CkJsonObject::ckStringOf(jResp,"account.type.value")
NameValue.s = CkJsonObject::ckStringOf(jResp,"account.name.value")
NumberValue.s = CkJsonObject::ckStringOf(jResp,"account.number.value")
BalanceValue.s = CkJsonObject::ckStringOf(jResp,"account.balance.value")
CurrencyValue.s = CkJsonObject::ckStringOf(jResp,"account.currency.value")
Bank_product_idValue.s = CkJsonObject::ckStringOf(jResp,"account.bank_product_id.value")
Internal_identificationValue.s = CkJsonObject::ckStringOf(jResp,"account.internal_identification.value")
Public_identification_nameValue.s = CkJsonObject::ckStringOf(jResp,"account.public_identification_name.value")
Public_identification_valueValue.s = CkJsonObject::ckStringOf(jResp,"account.public_identification_value.value")
Last_accessed_atValue.s = CkJsonObject::ckStringOf(jResp,"account.last_accessed_at.value")
Credit_dataValue.s = CkJsonObject::ckStringOf(jResp,"account.credit_data.value")
Loan_dataValue.s = CkJsonObject::ckStringOf(jResp,"account.loan_data.value")
Funds_dataValue.s = CkJsonObject::ckStringOf(jResp,"account.funds_data.value")
Gig_payment_dataValue.s = CkJsonObject::ckStringOf(jResp,"account.gig_payment_data.value")
collected_at.s = CkJsonObject::ckStringOf(jResp,"collected_at")
value_date.s = CkJsonObject::ckStringOf(jResp,"value_date")
accounting_date.s = CkJsonObject::ckStringOf(jResp,"accounting_date")
amount.s = CkJsonObject::ckStringOf(jResp,"amount")
balance.s = CkJsonObject::ckStringOf(jResp,"balance")
v_currency.s = CkJsonObject::ckStringOf(jResp,"currency")
description.s = CkJsonObject::ckStringOf(jResp,"description")
observations.s = CkJsonObject::ckStringOf(jResp,"observations")
category.s = CkJsonObject::ckStringOf(jResp,"category")
reference.s = CkJsonObject::ckStringOf(jResp,"reference")
v_type.s = CkJsonObject::ckStringOf(jResp,"type")
status.s = CkJsonObject::ckStringOf(jResp,"status")
Pickup_at.s = CkJsonObject::ckStringOf(jResp,"gig_data.pickup_at")
Dropoff_at.s = CkJsonObject::ckStringOf(jResp,"gig_data.dropoff_at")
Request_at.s = CkJsonObject::ckStringOf(jResp,"gig_data.request_at")
Pickup_address.s = CkJsonObject::ckStringOf(jResp,"gig_data.pickup_address")
Dropoff_address.s = CkJsonObject::ckStringOf(jResp,"gig_data.dropoff_address")
Pickup_latitude.s = CkJsonObject::ckStringOf(jResp,"gig_data.pickup_latitude")
Pickup_longitude.s = CkJsonObject::ckStringOf(jResp,"gig_data.pickup_longitude")
Dropoff_latitude.s = CkJsonObject::ckStringOf(jResp,"gig_data.dropoff_latitude")
Dropoff_longitude.s = CkJsonObject::ckStringOf(jResp,"gig_data.dropoff_longitude")
Distance.s = CkJsonObject::ckStringOf(jResp,"gig_data.distance")
Payment_method.s = CkJsonObject::ckStringOf(jResp,"gig_data.payment_method")
Vehicle_type.s = CkJsonObject::ckStringOf(jResp,"gig_data.vehicle_type")
Merchant_type.s = CkJsonObject::ckStringOf(jResp,"gig_data.merchant_type")
Collected_at.s = CkJsonObject::ckStringOf(jResp,"gig_data.collected_at")
Bill_name.s = CkJsonObject::ckStringOf(jResp,"credit_card_data.bill_name")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"gig_data.breakdown")
While i < count_i
CkJsonObject::setCkI(jResp, i)
value = CkJsonObject::ckStringOf(jResp,"gig_data.breakdown[i].value")
i = i + 1
Wend
CkHttp::ckDispose(http)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
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]"
}
]
}
