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
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
let sbResponseBody = CkoStringBuilder()
success = http.QuickGetSb("https://domain.com/crm/v2.1/org/currencies", sbContent: sbResponseBody)
if success == false {
print("\(http.LastErrorText)")
return
}
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = http.LastStatus.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(http.LastHeader)")
print("Failed.")
return
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "currencies": [
// {
// "symbol": "Af",
// "created_time": "2020-03-27T06:03:01-00:00",
// "is_active": true,
// "exchange_rate": "1.000000000",
// "format": {
// "decimal_separator": "Period",
// "thousand_separator": "Comma",
// "decimal_places": "0"
// },
// "created_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "prefix_symbol": true,
// "is_base": true,
// "modified_time": "2020-03-27T06:03:01-00:00",
// "name": "Afghan Afghani - AFN",
// "modified_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "id": "738964000000650003",
// "iso_code": "AFN"
// },
// {
// "symbol": "SR",
// "created_time": "2020-03-27T06:42:37-00:00",
// "is_active": false,
// "exchange_rate": "1.000000000",
// "format": {
// "decimal_separator": "Period",
// "thousand_separator": "Comma",
// "decimal_places": "2"
// },
// "created_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "prefix_symbol": true,
// "is_base": false,
// "modified_time": "2020-03-27T07:11:24-00:00",
// "name": "Saudi Riyal - SAR",
// "modified_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "id": "738964000000650008",
// "iso_code": "SAR"
// },
// {
// "symbol": "₹",
// "created_time": "2020-03-27T06:46:36-00:00",
// "is_active": true,
// "exchange_rate": "1.000000000",
// "format": {
// "decimal_separator": "Period",
// "thousand_separator": "Comma",
// "decimal_places": "2"
// },
// "created_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "prefix_symbol": true,
// "is_base": false,
// "modified_time": "2020-03-27T06:46:36-00:00",
// "name": "Indian Rupee - INR",
// "modified_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "id": "738964000000650012",
// "iso_code": "INR"
// },
// {
// "symbol": "¥",
// "created_time": "2020-03-27T06:49:55-00:00",
// "is_active": true,
// "exchange_rate": "1.000000000",
// "format": {
// "decimal_separator": "Period",
// "thousand_separator": "Comma",
// "decimal_places": "2"
// },
// "created_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "prefix_symbol": true,
// "is_base": false,
// "modified_time": "2020-03-27T06:49:55-00:00",
// "name": "Japanese Yen - JPY",
// "modified_by": {
// "name": "patricia patricia",
// "id": "738964000000291009"
// },
// "id": "738964000000650016",
// "iso_code": "JPY"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var symbol: String?
var created_time: String?
var is_active: Bool
var exchange_rate: String?
var Decimal_separator: String?
var Thousand_separator: String?
var Decimal_places: String?
var Name: String?
var Id: String?
var prefix_symbol: Bool
var is_base: Bool
var modified_time: String?
var name: String?
var modified_byName: String?
var modified_byId: String?
var id: String?
var iso_code: String?
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("currencies").intValue
while i < count_i {
jResp.I = i
symbol = jResp.StringOf("currencies[i].symbol")
created_time = jResp.StringOf("currencies[i].created_time")
is_active = jResp.BoolOf("currencies[i].is_active")
exchange_rate = jResp.StringOf("currencies[i].exchange_rate")
Decimal_separator = jResp.StringOf("currencies[i].format.decimal_separator")
Thousand_separator = jResp.StringOf("currencies[i].format.thousand_separator")
Decimal_places = jResp.StringOf("currencies[i].format.decimal_places")
Name = jResp.StringOf("currencies[i].created_by.name")
Id = jResp.StringOf("currencies[i].created_by.id")
prefix_symbol = jResp.BoolOf("currencies[i].prefix_symbol")
is_base = jResp.BoolOf("currencies[i].is_base")
modified_time = jResp.StringOf("currencies[i].modified_time")
name = jResp.StringOf("currencies[i].name")
modified_byName = jResp.StringOf("currencies[i].modified_by.name")
modified_byId = jResp.StringOf("currencies[i].modified_by.id")
id = jResp.StringOf("currencies[i].id")
iso_code = jResp.StringOf("currencies[i].iso_code")
i = i + 1
}
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/org/currencies
Postman Collection Item JSON
{
"name": "Currencies Data",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies"
]
},
"description": "To get all the available currencies in your organization."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:16:24 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "clientVersion",
"value": "4016256"
},
{
"key": "clientsubVersion",
"value": "8ef7aa3133ce0e105307c407d89b23d9"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"currencies\": [\n {\n \"symbol\": \"Af\",\n \"created_time\": \"2020-03-27T06:03:01-00:00\",\n \"is_active\": true,\n \"exchange_rate\": \"1.000000000\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"0\"\n },\n \"created_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"prefix_symbol\": true,\n \"is_base\": true,\n \"modified_time\": \"2020-03-27T06:03:01-00:00\",\n \"name\": \"Afghan Afghani - AFN\",\n \"modified_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"id\": \"738964000000650003\",\n \"iso_code\": \"AFN\"\n },\n {\n \"symbol\": \"SR\",\n \"created_time\": \"2020-03-27T06:42:37-00:00\",\n \"is_active\": false,\n \"exchange_rate\": \"1.000000000\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"created_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"prefix_symbol\": true,\n \"is_base\": false,\n \"modified_time\": \"2020-03-27T07:11:24-00:00\",\n \"name\": \"Saudi Riyal - SAR\",\n \"modified_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"id\": \"738964000000650008\",\n \"iso_code\": \"SAR\"\n },\n {\n \"symbol\": \"₹\",\n \"created_time\": \"2020-03-27T06:46:36-00:00\",\n \"is_active\": true,\n \"exchange_rate\": \"1.000000000\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"created_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"prefix_symbol\": true,\n \"is_base\": false,\n \"modified_time\": \"2020-03-27T06:46:36-00:00\",\n \"name\": \"Indian Rupee - INR\",\n \"modified_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"id\": \"738964000000650012\",\n \"iso_code\": \"INR\"\n },\n {\n \"symbol\": \"¥\",\n \"created_time\": \"2020-03-27T06:49:55-00:00\",\n \"is_active\": true,\n \"exchange_rate\": \"1.000000000\",\n \"format\": {\n \"decimal_separator\": \"Period\",\n \"thousand_separator\": \"Comma\",\n \"decimal_places\": \"2\"\n },\n \"created_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"prefix_symbol\": true,\n \"is_base\": false,\n \"modified_time\": \"2020-03-27T06:49:55-00:00\",\n \"name\": \"Japanese Yen - JPY\",\n \"modified_by\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\"\n },\n \"id\": \"738964000000650016\",\n \"iso_code\": \"JPY\"\n }\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencie",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencie"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:16:44 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "131"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-07T14:14:22+00:00"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "Content-Language",
"value": "en-US"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_URL_PATTERN\",\n \"details\": {},\n \"message\": \"Please check if the URL trying to access is a correct one\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:17:06 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Fri, 07 May 2021 13:17:22 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org",
"currencies"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 08:17:16 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
