Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/crm/v2/org/currencies",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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": "3"
; },
; "created_by": {
; "name": "Patricia Boyle",
; "id": "738964000000291009"
; },
; "prefix_symbol": true,
; "is_base": true,
; "modified_time": "2021-05-07T13:23:33-00:00",
; "name": "Afghan Afghani - AFN",
; "modified_by": {
; "name": "Patricia Boyle",
; "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 Boyle",
; "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 Boyle",
; "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 Boyle",
; "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 Boyle",
; "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 Boyle",
; "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 Boyle",
; "id": "738964000000291009"
; },
; "id": "738964000000650016",
; "iso_code": "JPY"
; },
; {
; "symbol": "ALL",
; "created_time": "2021-05-07T13:19:03-00:00",
; "is_active": true,
; "exchange_rate": "1.000000000",
; "format": {
; "decimal_separator": "Period",
; "thousand_separator": "Comma",
; "decimal_places": "2"
; },
; "created_by": {
; "name": "Patricia Boyle",
; "id": "738964000000291009"
; },
; "prefix_symbol": true,
; "is_base": false,
; "modified_time": "2021-05-07T13:19:03-00:00",
; "name": "Albanian Lek - ALL",
; "modified_by": {
; "name": "Patricia Boyle",
; "id": "738964000000291009"
; },
; "id": "738964000002130609",
; "iso_code": "ALL"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $symbol
Local $sCreated_time
Local $bIs_active
Local $sExchange_rate
Local $sDecimal_separator
Local $sThousand_separator
Local $sDecimal_places
Local $sName
Local $sId
Local $bPrefix_symbol
Local $bIs_base
Local $sModified_time
Local $sName
Local $sModified_byName
Local $sModified_byId
Local $sId
Local $sIso_code
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("currencies")
While $i < $iCount_i
$oJResp.I = $i
$symbol = $oJResp.StringOf("currencies[i].symbol")
$sCreated_time = $oJResp.StringOf("currencies[i].created_time")
$bIs_active = $oJResp.BoolOf("currencies[i].is_active")
$sExchange_rate = $oJResp.StringOf("currencies[i].exchange_rate")
$sDecimal_separator = $oJResp.StringOf("currencies[i].format.decimal_separator")
$sThousand_separator = $oJResp.StringOf("currencies[i].format.thousand_separator")
$sDecimal_places = $oJResp.StringOf("currencies[i].format.decimal_places")
$sName = $oJResp.StringOf("currencies[i].created_by.name")
$sId = $oJResp.StringOf("currencies[i].created_by.id")
$bPrefix_symbol = $oJResp.BoolOf("currencies[i].prefix_symbol")
$bIs_base = $oJResp.BoolOf("currencies[i].is_base")
$sModified_time = $oJResp.StringOf("currencies[i].modified_time")
$sName = $oJResp.StringOf("currencies[i].name")
$sModified_byName = $oJResp.StringOf("currencies[i].modified_by.name")
$sModified_byId = $oJResp.StringOf("currencies[i].modified_by.id")
$sId = $oJResp.StringOf("currencies[i].id")
$sIso_code = $oJResp.StringOf("currencies[i].iso_code")
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2/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/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"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/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:00:01 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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+00:00"
},
{
"key": "clientVersion",
"value": "4027076"
},
{
"key": "clientsubVersion",
"value": "748ecbe82ec7e144b66ee25f264bbd88"
},
{
"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\": \"3\"\n },\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"prefix_symbol\": true,\n \"is_base\": true,\n \"modified_time\": \"2021-05-07T13:23:33-00:00\",\n \"name\": \"Afghan Afghani - AFN\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\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 Boyle\",\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 Boyle\",\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 Boyle\",\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 Boyle\",\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 Boyle\",\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 Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"id\": \"738964000000650016\",\n \"iso_code\": \"JPY\"\n },\n {\n \"symbol\": \"ALL\",\n \"created_time\": \"2021-05-07T13:19:03-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 Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"prefix_symbol\": true,\n \"is_base\": false,\n \"modified_time\": \"2021-05-07T13:19:03-00:00\",\n \"name\": \"Albanian Lek - ALL\",\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"738964000000291009\"\n },\n \"id\": \"738964000002130609\",\n \"iso_code\": \"ALL\"\n }\n ]\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencie",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencie"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:00:17 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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-12T07:56:48+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/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:00:38 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/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 12 May 2021 07:00:54 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": "INVALID_REQUEST",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2/org/currencies",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org",
"currencies"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:42:57 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "192"
},
{
"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\": \"INVALID_REQUEST\",\n \"details\": {},\n \"message\": \"unable to process your request. please verify whether you have entered proper method name, parameter and parameter values.\",\n \"status\": \"error\"\n}"
}
]
}
