Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sCountry
String sPhoto_id
String sCity
String sDescription
Boolean iMc_status
Boolean iGapps_enabled
String sDomain_name
Boolean iTranslation_enabled
String sStreet
String sAlias
String sV_currency
String sId
String sState
String sFax
String sEmployee_count
String sZip
String sWebsite
String sCurrency_symbol
String sMobile
String sCurrency_locale
String sPrimary_zuid
String sZia_portal_id
String sTime_zone
String sZgid
String sCountry_code
String sPaid_expiry
Integer iUsers_license_purchased
String sTrial_type
String sTrial_expiry
Boolean iPaid
String sPaid_type
String sPhone
String sCompany_name
Boolean iPrivacy_settings
String sPrimary_email
String sIso_code
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Send ComSetRequestHeader To hoHttp "Authorization" "{{authorization-token}}"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/crm/v2/org" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
End
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "org": [
// {
// "country": null,
// "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": true,
// "primary_email": "patricia@zylker.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
Move 0 To i
Get ComSizeOfArray Of hoJResp "org" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "org[i].country" To sCountry
Get ComStringOf Of hoJResp "org[i].photo_id" To sPhoto_id
Get ComStringOf Of hoJResp "org[i].city" To sCity
Get ComStringOf Of hoJResp "org[i].description" To sDescription
Get ComBoolOf Of hoJResp "org[i].mc_status" To iMc_status
Get ComBoolOf Of hoJResp "org[i].gapps_enabled" To iGapps_enabled
Get ComStringOf Of hoJResp "org[i].domain_name" To sDomain_name
Get ComBoolOf Of hoJResp "org[i].translation_enabled" To iTranslation_enabled
Get ComStringOf Of hoJResp "org[i].street" To sStreet
Get ComStringOf Of hoJResp "org[i].alias" To sAlias
Get ComStringOf Of hoJResp "org[i].currency" To sV_currency
Get ComStringOf Of hoJResp "org[i].id" To sId
Get ComStringOf Of hoJResp "org[i].state" To sState
Get ComStringOf Of hoJResp "org[i].fax" To sFax
Get ComStringOf Of hoJResp "org[i].employee_count" To sEmployee_count
Get ComStringOf Of hoJResp "org[i].zip" To sZip
Get ComStringOf Of hoJResp "org[i].website" To sWebsite
Get ComStringOf Of hoJResp "org[i].currency_symbol" To sCurrency_symbol
Get ComStringOf Of hoJResp "org[i].mobile" To sMobile
Get ComStringOf Of hoJResp "org[i].currency_locale" To sCurrency_locale
Get ComStringOf Of hoJResp "org[i].primary_zuid" To sPrimary_zuid
Get ComStringOf Of hoJResp "org[i].zia_portal_id" To sZia_portal_id
Get ComStringOf Of hoJResp "org[i].time_zone" To sTime_zone
Get ComStringOf Of hoJResp "org[i].zgid" To sZgid
Get ComStringOf Of hoJResp "org[i].country_code" To sCountry_code
Get ComStringOf Of hoJResp "org[i].license_details.paid_expiry" To sPaid_expiry
Get ComIntOf Of hoJResp "org[i].license_details.users_license_purchased" To iUsers_license_purchased
Get ComStringOf Of hoJResp "org[i].license_details.trial_type" To sTrial_type
Get ComStringOf Of hoJResp "org[i].license_details.trial_expiry" To sTrial_expiry
Get ComBoolOf Of hoJResp "org[i].license_details.paid" To iPaid
Get ComStringOf Of hoJResp "org[i].license_details.paid_type" To sPaid_type
Get ComStringOf Of hoJResp "org[i].phone" To sPhone
Get ComStringOf Of hoJResp "org[i].company_name" To sCompany_name
Get ComBoolOf Of hoJResp "org[i].privacy_settings" To iPrivacy_settings
Get ComStringOf Of hoJResp "org[i].primary_email" To sPrimary_email
Get ComStringOf Of hoJResp "org[i].iso_code" To sIso_code
Move (i + 1) To i
Loop
End_Procedure
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
https://domain.com/crm/v2/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/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"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/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 10:49:49 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "796"
},
{
"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-11T11:08:26+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"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 \"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\": true,\n \"primary_email\": \"patricia@zylker.com\",\n \"iso_code\": \"INR\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 10:50:28 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": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 10:52:27 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/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:31:49 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}"
}
]
}
