Chilkat Online Tools

Android / Zoho CRM REST APIs / Using External Field's Value

Back to Collection Items

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkHttp http = new CkHttp();
    boolean success;

    CkJsonObject queryParams = new CkJsonObject();
    queryParams.UpdateString("fields","External_Contact_ID,Last_Name,First_Name,Full_Name,Account_Name,OrgExternal");
    queryParams.UpdateInt("per_page",2);

    // Adds the "Authorization: Bearer <access_token>" header.
    http.put_AuthToken("<access_token>");
    http.SetRequestHeader("X-EXTERNAL","Contacts.External_ID");

    CkHttpResponse resp = http.QuickRequestParams("GET","https://domain.com/crm/v2/Contacts/externalcontact1",queryParams);
    if (http.get_LastMethodSuccess() == false) {
        Log.i(TAG, http.lastErrorText());
        return;
        }

    Log.i(TAG, String.valueOf(resp.get_StatusCode()));
    Log.i(TAG, resp.bodyStr());


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}

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": [
  ]
}