Método getMyRecords

Tabla de contenido

Finalidad
URL de la solicitud
Parámetros de la solicitud
Códigos de error
Ejemplos
Programa de prueba

Finalidad

Puede utilizar el método getMyRecords para capturar datos según el propietario del token de autenticación especificado en la solicitud de API.

URL de la solicitud

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

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

Parámetros de la solicitud

Parámetro	Tipo de datos	Descripción
authtoken*	Cadena	Cadena alfanumérica encriptada para autenticar sus credenciales de Zoho.
scope*	Cadena	Especificar el valor como crmapi
selectColumns	Cadena	Para seleccionar los campos obligatorios en el módulo de CRM. Formato: Módulo (columnas opcionales) Ejemplo: Clientes potenciales (apellido, sitio web y correo electrónico) O Todos
fromIndex	Entero	Valor predeterminado: 1
toIndex	Entero	Valor predeterminado: 20 Valor máximo del rango: 200 [Maximum range value = toIndex - fromIndex]
sortColumnString	Cadena	Puede seleccionar uno de los campos en CRM para ordenar los datos. Ejemplo: sortColumnString=Company En este caso, los datos se ordenarán según el campo Empresa
sortOrderString	Cadena	Orden de clasificación: asc o desc Si utiliza el parámetro sortColumnString, de forma predeterminada, los datos se ordenarán en orden ascendente.
lastModifiedTime	aaaa-MM-dd HH:mm:ss	Valor predeterminado: null Si especifica el tiempo, los datos creados/modificados se capturarán después del tiempo configurado.
newFormat	Entero (1 o 2)	newFormat=1: para excluir campos con valores "null" mientras captura datos en su cuenta de CRM. newFormat=2: para incluir campos con valores "null" mientras captura datos en su cuenta de CRM.
versión	Entero	version = 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. La versión actual es 4.

* 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.

Códigos de error

Consulte Códigos de error.

Notas adicionales

Mientras recupera datos en su cuenta de Zoho CRM, se aplicará la seguridad basada en funciones (Funciones, Perfiles, Seguridad a nivel de campo y Reglas para compartir datos). Para obtener información sobre la configuración de seguridad basada en funciones, consulte Administración de seguridad.
fromIndex y toIndex son parámetros opcionales. De manera predeterminada, el valor de fromIndex es 1 y el de toIndex es 20.
sortColumnString y sortOrderString también son parámetros opcionales
El valor del parámetro lastModifiedTime debe estar en el formato aaaa-MM-dd HH:mm:ss

Ejemplos

Capturar datos de clientes potenciales en Zoho CRM

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

Para capturar datos de otros módulos, reemplace Clientes potenciales por Cuentas, Contactos, Potenciales, etc.

Capturar más de 200 registros

De manera predeterminada, puede capturar 20 registros por lote. Sin embargo, mediante el parámetro toIndex, puede capturar hasta 200 registros por lote. Si desea capturar más de 200 registros, siga los pasos indicados a continuación:

Iteration 1: fromIndex=1&toIndex=200
Iteration 2: fromIndex=201&toIndex=400

Capturar clientes potenciales con el nombre de "Empresa" en orden ascendente

sortColumnString=Company&sortOrderString=asc

Capturar clientes potenciales con el nombre de "Empresa" en orden descendente

sortColumnString=Company&sortOrderString=desc

Capturar clientes potenciales sin especificar el parámetro newFormat

Nota:

Cuando no haya ninguna especificación sobre el formato de respuesta, el valor predeterminado "1" se asignará al parámetro newFormat, es decir, newFormat = 1

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company,No of Employees,Annual Revenue,Created By,Created Time)

Esto arrojará una respuesta como la que se menciona a continuación:

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">10</FL>
<FL val="Annual Revenue">1000.0</FL>
<FL val="SMCREATORID">2000000016908</FL>
<FL val="Created By">John</FL>
<FL val="Created Time">2010-03-16 10:04:52</FL>
<FL val="Modified Time">2010-03-16 10:04:52</FL>
</row>
</Leads>

Capturar clientes potenciales con "newFormat=2"

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=Leads(Lead Owner,First Name,Last Name,Company,Designation,Email,Phone,Fax,Mobile,Website,Lead Source,Lead Status,No of Employees,Annual Revenue)

Esto arrojará una respuesta como la que se menciona a continuación:

<Leads>
<row no="1">
<FL val="LEADID">2000000022020</FL>
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zillium</FL>
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Designation">null</FL>
<FL val="Email">null</FL>
<FL val="Phone">null</FL>
<FL val="Fax">null</FL>
<FL val="Mobile">null</FL>
<FL val="Website">null</FL>
<FL val="Lead Source">null</FL>
<FL val="Lead Status">null</FL>
<FL val="No of Employees">0</FL>
<FL val="Annual Revenue">0.0</FL>
</row>
</Leads>

Capturar los primeros 25 clientes potenciales en Zoho CRM

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&fromIndex=1&toIndex=25

Capturar clientes potenciales con el parámetro "lastModifiedTime"

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=Leads(Lead Owner,First Name,Last Name,Email,Company)&lastModifiedTime=2010-04-21 11:09:23

Nota:

Si especifica el tiempo, los datos modificados se capturarán después del tiempo configurado.

Seleccionar todos los campos de clientes potenciales con el parámetro newFormat=1

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All

Nota:

Esto arrojará todos los campos que tengan valores.

Seleccionar todos los campos de clientes potenciales con newFormat=2

https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All

Nota:

Esto arrojará todos los campos, incluidos los campos con valor null.

Capturar clientes potenciales con los parámetros lastModifiedTime, fromIndex y toIndex

Programa de prueba

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

En el programa Java se incluye lo siguiente:

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

Was this article helpful? Yes, thanks!Not really

Share this post : FacebookTwitter

Top

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

Escríbenos: support@zohocrm.com