unicodeC / Zoho CRM REST APIs / Using External Field's Value
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateString(queryParams,L"fields",L"External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal");
CkJsonObjectW_UpdateInt(queryParams,L"per_page",2);
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
CkHttpW_SetRequestHeader(http,L"X-EXTERNAL",L"Contacts.External_ID");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://domain.com/crm/v2/Contacts/externalcontact1",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
wprintf(L"%d\n",CkHttpResponseW_getStatusCode(resp));
wprintf(L"%s\n",CkHttpResponseW_bodyStr(resp));
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
}
Curl Command
curl -G -d "fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
-d "per_page=2"
-H "Authorization: Bearer <access_token>"
-H "X-EXTERNAL: Contacts.External_ID"
https://domain.com/crm/v2/Contacts/externalcontact1
Postman Collection Item JSON
{
"name": "Using External Field's Value",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "X-EXTERNAL",
"value": "Contacts.External_ID",
"type": "text"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/Contacts/externalcontact1?fields=External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal&per_page=2",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"Contacts",
"externalcontact1"
],
"query": [
{
"key": "fields",
"value": "External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal"
},
{
"key": "per_page",
"value": "2"
}
]
},
"description": "To fetch a record through the external field's value. In this example, Contacts is the base module's API name, External_Contact_ID is the API name of the external field, and externalcontact1 is the value of the external field in this module."
},
"response": [
]
}