Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()!
var success: Bool
http.basicAuth = true
http.login = "{{secretId}}"
http.password = "{{secretPassword}}"
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "date_from": "2021-01-01",
// "date_to": "2021-03-30",
// "link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
// "token": "1234ab",
// "save_data": true,
// "account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
// }
let json = CkoJsonObject()!
json.update("date_from", value: "2021-01-01")
json.update("date_to", value: "2021-03-30")
json.update("link", value: "2ccd5e15-194a-4a19-a45a-e7223c7e6717")
json.update("token", value: "1234ab")
json.updateBool("save_data", value: true)
json.update("account", value: "d4617561-1c01-4b2f-83b6-a594f7b3bc57")
http.setRequestHeader("Content-Type", value: "application/json")
var resp: CkoHttpResponse? = http.postJson3("https://domain.com/api/balances/", contentType: "application/json", json: json)
if http.lastMethodSuccess == false {
print("\(http.lastErrorText!)")
return
}
let sbResponseBody = CkoStringBuilder()!
resp!.getBodySb(sbResponseBody)
let jarrResp = CkoJsonArray()!
jarrResp.loadSb(sbResponseBody)
jarrResp.emitCompact = false
print("Response Body:")
print("\(jarrResp.emit()!)")
var respStatusCode: Int = resp!.statusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.header!)")
print("Failed.")
resp = nil
return
}
resp = nil
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// [
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "eu exercitation id ullamco",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "value_date": "<date>",
// "balance": "<number>",
// "current_balance": "<number>",
// "statement": "<string>"
// },
// {
// "id": "<uuid>",
// "account": {
// "id": "<uuid>",
// "name": "<string>",
// "category": "eu tempor adipisicing",
// "currency": "<string>"
// },
// "collected_at": "<dateTime>",
// "value_date": "<date>",
// "balance": "<number>",
// "current_balance": "<number>",
// "statement": "<string>"
// }
// ]
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var json: CkoJsonObject?
var id: String?
var Id: String?
var Name: String?
var Category: String?
var v_Currency: String?
var collected_at: String?
var value_date: String?
var balance: String?
var current_balance: String?
var statement: String?
var i: Int = 0
var count_i: Int = jarrResp.size.intValue
while i < count_i {
json = jarrResp.object(at: i)
id = json!.string(of: "id")
Id = json!.string(of: "account.id")
Name = json!.string(of: "account.name")
Category = json!.string(of: "account.category")
v_Currency = json!.string(of: "account.currency")
collected_at = json!.string(of: "collected_at")
value_date = json!.string(of: "value_date")
balance = json!.string(of: "balance")
current_balance = json!.string(of: "current_balance")
statement = json!.string(of: "statement")
json = nil
i = i + 1
}
}
Curl Command
curl -X POST
-u '{{secretId}}:{{secretPassword}}'
-H "Content-Type: application/json"
-d '{
"date_from": "2021-01-01",
"date_to": "2021-03-30",
"link": "2ccd5e15-194a-4a19-a45a-e7223c7e6717",
"token": "1234ab",
"save_data": true,
"account": "d4617561-1c01-4b2f-83b6-a594f7b3bc57"
}'
https://domain.com/api/balances/
Postman Collection Item JSON
{
"name": "Retrieve",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"2021-01-01\",\n \"date_to\": \"2021-03-30\",\n \"link\": \"2ccd5e15-194a-4a19-a45a-e7223c7e6717\",\n \"token\": \"1234ab\",\n \"save_data\": true,\n \"account\": \"d4617561-1c01-4b2f-83b6-a594f7b3bc57\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances/",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances",
""
]
},
"description": "Retrieve balances from one or more accounts for a specific link within a specified date range."
},
"response": [
{
"name": "Ok (when save_data=false)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"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\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t}\n]"
},
{
"name": "Created (when save_data=true)",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "[\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu exercitation id ullamco\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t},\n\t{\n\t\t\"id\": \"<uuid>\",\n\t\t\"account\": {\n\t\t\t\"id\": \"<uuid>\",\n\t\t\t\"name\": \"<string>\",\n\t\t\t\"category\": \"eu tempor adipisicing\",\n\t\t\t\"currency\": \"<string>\"\n\t\t},\n\t\t\"collected_at\": \"<dateTime>\",\n\t\t\"value_date\": \"<date>\",\n\t\t\"balance\": \"<number>\",\n\t\t\"current_balance\": \"<number>\",\n\t\t\"statement\": \"<string>\"\n\t}\n]"
},
{
"name": "Bad request error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Bad Request",
"code": 400,
"_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": "Unauthorized",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"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": "Request Timeout",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Request Timeout",
"code": 408,
"_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": "MFA Token Required",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Precondition Required",
"code": 428,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n\t\"code\": \"<string>\",\n\t\"message\": \"<string>\",\n\t\"request_id\": \"<uuid>\",\n\t\"session\": \"<uuid>\",\n\t\"expiry\": \"<integer>\",\n\t\"link\": \"<uuid>\",\n\t\"token_generation_data\": {\n\t\t\"instructions\": \"<string>\",\n\t\t\"type\": \"<string>\",\n\t\t\"value\": \"<string>\"\n\t}\n}"
},
{
"name": "Unexpected Error",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"date_from\": \"<date>\",\n \"date_to\": \"<date>\",\n \"link\": \"<uuid>\",\n \"encryption_key\": \"<string>\",\n \"token\": \"<string>\",\n \"save_data\": true,\n \"account\": \"<uuid>\"\n}"
},
"url": {
"raw": "{{baseUrl}}/api/balances",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"balances"
]
}
},
"status": "Internal Server Error",
"code": 500,
"_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]"
}
]
}
