Developer API Help

getSearchRecordsByPDC Method

Purpose

You can use this method to search the values based on predefined columns.

Request URL

XML Format:
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi

JSON Format:
https://crm.zoho.com/crm/private/json/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi

Request Parameters

Parameter Data Type Description
authotoken* String Encrypted alphanumeric string to authenticate your Zoho credentials.
scope* String Specify crmapi as the scope
selectColumns* String All or module(field 1,field 2,field 3, field n...)
Example: leads(Last Name,Website,Email)
searchColumn* String Specify the predefined search column
searchValue* String Specify the value to be searched
newFormat Integer newFormat=1: To exclude fields with "null" values while inserting data from your CRM account.
newFormat=2: To include fields with "null" values while inserting data from your CRM account.
version Integer version = 1:(Default value) This will fetch responses based on the earlier API implementation i.e prior to the enhancements made.
version = 2: This will fetch responses based on the latest API implementation.

* - Mandatory parameter

Note:

  • Refer the Release Notes page to learn more about enhancements made in the API implementation.

Default Predefined Columns

Module Fields
Leads
  • email
Accounts
  • accountid
  • accountname
Contacts
  • contactid
  • accountid
  • vendorid
  • email
Potentials
  • potentialid
  • accountid
  • campaignid
  • contactid
  • potentialname
Campaigns
  • campaignid
  • campaignname
Cases
  • caseid
  • productid
  • accountid
  • potentialid
Solutions
  • solutionid
  • productid
Products
  • productid
  • vendorid
  • productname
Purchase Order
  • purchaseorderid
  • contactid
  • vendorid
Quotes
  • quoteid
  • potentialid
  • accountid
  • contactid
Sales Orders
  • salesorderid
  • potentialid
  • accountid
  • contactid
  • quoteid
Invoices
  • invoiceid
  • accountid
  • salesorderid
  • contactid
Vendors
  • vendorid
  • vendorname
Tasks
  • taskid
Events
  • eventid
Notes
  • notesid

Examples

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi &selectColumns=leads(Last Name,Website,Email)&searchColumn=email &searchValue=abc@testingdomain.com

Leads with email column

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=email
&searchValue=test@test.com

Leads with campaignid column

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=campaignid
&searchValue=2000000017011

Contacts with vendorid column

https://crm.zoho.com/crm/private/xml/Contacts/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Contacts(Contact Owner,Lead Source,First Name,Last Name,Account Name)
&searchColumn=vendorid
&searchValue=2000000017022

Products with vendorid column

https://crm.zoho.com/crm/private/xml/Products/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Products(Product Owner,Product Name,Product Code,Manufacturer,Product Category,Unit Price)
&searchColumn=vendorid
&searchValue=2000000017022

SalesOrders with accountid column

https://crm.zoho.com/crm/private/xml/SalesOrders/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=SalesOrders(SO Number,Subject,Due Date,Carrier,Status)
&searchColumn=accountid
&searchValue=2000000017003

Test Program

You can use the attached program to run and test the working of the getSearchRecordsByPDC method in your Java Environment.
The Java Program contains the following:

  • the authtoken generation format
  • the parameters and their values
  • actual usage of the method

Click here to download the program

Top