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
$oHttp.SetRequestHeader "Authorization","{{authorization-token}}"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/crm/v2.1/org",$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)
; {
; "org": [
; {
; "country": null,
; "hierarchy_preferences": {
; "type": "Role_Hierarchy"
; },
; "photo_id": null,
; "city": null,
; "description": null,
; "mc_status": true,
; "gapps_enabled": false,
; "domain_name": "org60036018",
; "translation_enabled": true,
; "street": null,
; "alias": null,
; "currency": "Indian Rupee",
; "id": "738964000000300043",
; "state": null,
; "fax": null,
; "employee_count": null,
; "zip": null,
; "website": null,
; "currency_symbol": "₹",
; "mobile": null,
; "currency_locale": "en_IN",
; "primary_zuid": "60034346",
; "zia_portal_id": null,
; "time_zone": "Asia/Kolkata",
; "zgid": "60036018",
; "country_code": "IN",
; "license_details": {
; "paid_expiry": "2021-10-20T00:00:00+00:00",
; "users_license_purchased": 25,
; "trial_type": null,
; "trial_expiry": null,
; "paid": true,
; "paid_type": "enterprise"
; },
; "phone": "312",
; "company_name": "Zylker",
; "privacy_settings": false,
; "primary_email": "patricia@zohocorp.com",
; "iso_code": "INR"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sCountry
Local $sV_Type
Local $sPhoto_id
Local $sCity
Local $sDescription
Local $bMc_status
Local $bGapps_enabled
Local $sDomain_name
Local $bTranslation_enabled
Local $street
Local $sAlias
Local $sV_currency
Local $sId
Local $state
Local $sFax
Local $sEmployee_count
Local $sZip
Local $sWebsite
Local $sCurrency_symbol
Local $sMobile
Local $sCurrency_locale
Local $sPrimary_zuid
Local $sZia_portal_id
Local $sTime_zone
Local $sZgid
Local $sCountry_code
Local $sPaid_expiry
Local $iUsers_license_purchased
Local $sTrial_type
Local $sTrial_expiry
Local $bPaid
Local $sPaid_type
Local $sPhone
Local $sCompany_name
Local $bPrivacy_settings
Local $sPrimary_email
Local $sIso_code
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("org")
While $i < $iCount_i
$oJResp.I = $i
$sCountry = $oJResp.StringOf("org[i].country")
$sV_Type = $oJResp.StringOf("org[i].hierarchy_preferences.type")
$sPhoto_id = $oJResp.StringOf("org[i].photo_id")
$sCity = $oJResp.StringOf("org[i].city")
$sDescription = $oJResp.StringOf("org[i].description")
$bMc_status = $oJResp.BoolOf("org[i].mc_status")
$bGapps_enabled = $oJResp.BoolOf("org[i].gapps_enabled")
$sDomain_name = $oJResp.StringOf("org[i].domain_name")
$bTranslation_enabled = $oJResp.BoolOf("org[i].translation_enabled")
$street = $oJResp.StringOf("org[i].street")
$sAlias = $oJResp.StringOf("org[i].alias")
$sV_currency = $oJResp.StringOf("org[i].currency")
$sId = $oJResp.StringOf("org[i].id")
$state = $oJResp.StringOf("org[i].state")
$sFax = $oJResp.StringOf("org[i].fax")
$sEmployee_count = $oJResp.StringOf("org[i].employee_count")
$sZip = $oJResp.StringOf("org[i].zip")
$sWebsite = $oJResp.StringOf("org[i].website")
$sCurrency_symbol = $oJResp.StringOf("org[i].currency_symbol")
$sMobile = $oJResp.StringOf("org[i].mobile")
$sCurrency_locale = $oJResp.StringOf("org[i].currency_locale")
$sPrimary_zuid = $oJResp.StringOf("org[i].primary_zuid")
$sZia_portal_id = $oJResp.StringOf("org[i].zia_portal_id")
$sTime_zone = $oJResp.StringOf("org[i].time_zone")
$sZgid = $oJResp.StringOf("org[i].zgid")
$sCountry_code = $oJResp.StringOf("org[i].country_code")
$sPaid_expiry = $oJResp.StringOf("org[i].license_details.paid_expiry")
$iUsers_license_purchased = $oJResp.IntOf("org[i].license_details.users_license_purchased")
$sTrial_type = $oJResp.StringOf("org[i].license_details.trial_type")
$sTrial_expiry = $oJResp.StringOf("org[i].license_details.trial_expiry")
$bPaid = $oJResp.BoolOf("org[i].license_details.paid")
$sPaid_type = $oJResp.StringOf("org[i].license_details.paid_type")
$sPhone = $oJResp.StringOf("org[i].phone")
$sCompany_name = $oJResp.StringOf("org[i].company_name")
$bPrivacy_settings = $oJResp.BoolOf("org[i].privacy_settings")
$sPrimary_email = $oJResp.StringOf("org[i].primary_email")
$sIso_code = $oJResp.StringOf("org[i].iso_code")
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
https://domain.com/crm/v2.1/org
Postman Collection Item JSON
{
"name": "Organization Details",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
},
"description": "To get the organization data."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 13:41:05 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "847"
},
{
"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-04T14:40:46+00:00"
},
{
"key": "clientVersion",
"value": "4004813"
},
{
"key": "clientsubVersion",
"value": "fb33599b767b94d06d2bd2529079b386"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"org\": [\n {\n \"country\": null,\n \"hierarchy_preferences\": {\n \"type\": \"Role_Hierarchy\"\n },\n \"photo_id\": null,\n \"city\": null,\n \"description\": null,\n \"mc_status\": true,\n \"gapps_enabled\": false,\n \"domain_name\": \"org60036018\",\n \"translation_enabled\": true,\n \"street\": null,\n \"alias\": null,\n \"currency\": \"Indian Rupee\",\n \"id\": \"738964000000300043\",\n \"state\": null,\n \"fax\": null,\n \"employee_count\": null,\n \"zip\": null,\n \"website\": null,\n \"currency_symbol\": \"₹\",\n \"mobile\": null,\n \"currency_locale\": \"en_IN\",\n \"primary_zuid\": \"60034346\",\n \"zia_portal_id\": null,\n \"time_zone\": \"Asia/Kolkata\",\n \"zgid\": \"60036018\",\n \"country_code\": \"IN\",\n \"license_details\": {\n \"paid_expiry\": \"2021-10-20T00:00:00+00:00\",\n \"users_license_purchased\": 25,\n \"trial_type\": null,\n \"trial_expiry\": null,\n \"paid\": true,\n \"paid_type\": \"enterprise\"\n },\n \"phone\": \"312\",\n \"company_name\": \"Zylker\",\n \"privacy_settings\": false,\n \"primary_email\": \"patricia@zohocorp.com\",\n \"iso_code\": \"INR\"\n }\n ]\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 12:36:48 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": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 04 May 2021 13:37:11 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}"
}
]
}
