CRM Help

Método getSearchRecords

Tabla de contenido

Finalidad

Puede utilizar este método para buscar registros según expresiones de las columnas seleccionadas.

URL de la solicitud

Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi

Nota:

  • Independientemente de la edición de Zoho CRM, puede enviar solo 250 solicitudes de API/día. En cada llamada puede capturar un máximo de 200 registros.

Parámetros de la solicitud

ParámetroTipo de datosDescripción
authtoken*CadenaCadena alfanumérica encriptada para autenticar sus credenciales de Zoho.
scope*CadenaEspecificar crmapi como alcance
selectColumns*CadenaMódulo (columnas opcionales), es decir, Clientes potenciales (apellido, sitio web y correo electrónico) O Todos
searchCondition*Cadena(Created By|=|username)
newFormatEnteronewFormat=1: para excluir campos con valores "null" mientras inserta datos de su cuenta de CRM.
newFormat=2: para incluir campos con valores "null" mientras inserta datos en su cuenta de CRM.
fromIndexEnteroValor predeterminado: 1
toIndexEnteroValor predeterminado: 20
Valor máximo: 200
versiónEnteroversion = 1 (valor predeterminado): mediante este valor, se capturarán respuestas basadas en la implementación de una API anterior, es decir, previa a las mejoras realizadas.
version = 2: mediante este valor, se capturarán respuestas basadas en la implementación de la API más reciente.

* Parámetro obligatorio

Nota:

  • Consulte la página Notas de la versión para obtener más información sobre las mejoras realizadas en la implementación de la API.

Expresiones regulares

Mientras utilice este método, asegúrese de que los parámetros selectColumns y searchCondition estén establecidos como obligatorios. Puede especificar las siguientes expresiones en la solicitud de API:

  • is OR =
  • isn't OR <>
  • contains(*srcString*)
  • starts with(srcString*)
  • ends with(*srcString)
  • doesn't contain
  • < OR is before
  • > OR is after
  • <=
  • =>

Ejemplos

Ejemplo 1

Si desea seleccionar Nombre del cliente potencial, Empresa, Correo electrónico, Móvil y Sitio web en Clientes potenciales y El correo electrónico debe contener "@sample.com", la solicitud de API de búsqueda se debe ingresar como se indica a continuación:

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Company,Email,Mobile,Website)&searchCondition=(Email|contains|*@sample.com*)

Ejemplo 2

Si desea seleccionar Empresa, Correo electrónico y Sitio web en Clientes potenciales y La cantidad de empleados debe ser mayor que 100, la solicitud de API de búsqueda se debe ingresar como se indica a continuación:

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Company,Email,Website)&searchCondition=(No of Employees|>|100)

Ejemplo 3

Si desea seleccionar Nombre del cliente potencial y Correo electrónico en Clientes potenciales y La empresa debe comenzar con "Zoho", la solicitud de API de búsqueda se debe ingresar como se indica a continuación:

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Name,Email)&searchCondition=(Company|starts with|Zoho*)

Ejemplo con equal(=)

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)&searchCondition=(Email|=|test@test.com)

Ejemplo con greater than(>)

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Annual Revenue|>|1000)

Ejemplo con less than(<)

Nota:

  • Reemplace los campos de enteros de valor null por "0". Los campos de enteros sin valor no se incluirán en la búsqueda.

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(customfield1|<|1000)

Ejemplo con contains

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|contains|*oho*)

Ejemplo con starts with

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|starts with|zoho*)

Ejemplo con ends with

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(First Name,Last Name,Email,Company)
&searchCondition=(Company|ends with|*zoho)

Ejemplo con equal(=) and selectColumns=All

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecords?authtoken=Auth Token&scope=crmapi
&selectColumns=All
&searchCondition=(Email|=|test@test.com)

Programa de prueba

Puede utilizar el programa vinculado para ejecutar y probar el funcionamiento del método getSearchRecords en el entorno Java.

En el programa Java se incluye lo siguiente:

  • el formato de generación del authtoken
  • los parámetros y sus valores
  • el uso real del método

Haga clic aquí para descargar el programa

Share this post : FacebookTwitter

Todavía no puede encontrar lo que está buscando?

Escríbenos: support@zohocrm.com