Método getRecords
Índice
- Finalidad
- Dirección URL de la solicitud
- Parámetros de la solicitud
- Errores de captura
- Ejemplos
- Para capturar todas las cuentas en formato JSON ordenadas por nombre de cuenta (en orden descendente) a partir de 20 a 200
- Para capturar todas las cuentas en formato XML modificadas o creadas después del 2008-05-27 00:00:00
- Para capturar los clientes potenciales con version = 1
- Para capturar los clientes potenciales con version = 2
- Para capturar clientes potenciales sin especificar el parámetro newFormat
- Para capturar con newFormat=2
- Para llamar con fromIndex=1,toIndex=25
- Para llamar con lastModifiedTime
- Para seleccionar todos los campos a partir de clientes potenciales con newFormat=1
- Para seleccionar todos los campos a partir de clientes potenciales con newFormat=2
- Para llamar con lastModifiedTime, fromIndex y toIndex
- Para llamar con lastModifiedTime, fromIndex y toIndex (para el módulo de cuentas)
- Programa de prueba
Finalidad
Puede utilizar el método getRecords para capturar todos los datos de los usuarios especificados en la solicitud de la API.
Dirección URL de la solicitud
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Parámetros de la solicitud
| Parámetro | Tipo de datos | Descripción |
| authtoken* | Cadena | Cadena alfanumérica cifrada para autenticar sus credenciales de Zoho. |
| scope* | Cadena | Especifique el valor como crmapi |
| selectColumns | Cadena | Módulo (columnas opcionales), es decir, clientes potenciales (apellido, sitio web, correo electrónico) O todos |
| fromIndex | Entero | Valor predeterminado: 1 |
| toIndex | Entero | Valor predeterminado: 20 Valor de rango máximo: 200 [Valor de rango máximo = toIndex - fromIndex] |
| sortColumnString | Cadena | Si utiliza el parámetro sortColumnString, de manera predeterminada se ordenarán los datos de forma ascendente. |
| sortOrderString | Cadena | Valor predeterminado: asc Si desea ordenarlos en forma descendente, deberá ingresar sortOrderString=desc. |
| lastModifiedTime | DateTime | Valor predeterminado: null Si especifica la hora, los datos modificados se capturarán después de la hora configurada. |
| newFormat | Entero | newFormat=1: para excluir campos con valores "null" durante el ingreso datos de su cuenta de CRM. newFormat=2: para incluir los campos con valores "null" durante el ingreso de datos de su cuenta de CRM. |
| version | Entero | version = 1: (valor predeterminado) Se capturarán las respuestas en función de la implementación anterior de la API, es decir, antes de las mejoras realizadas. version = 2: se capturarán las respuestas en función de la implementación de la API más reciente. |
*: parámetro obligatorio
Nota:
- Consulte la página de las Notas de la versión para obtener más información acerca de las mejoras realizadas en la implementación de la API.
Errores de captura
La API de CRM proporciona códigos de error únicos para que pueda solucionar los problemas fácilmente en su programa durante la sincronización de los datos entre CRM y su aplicación. Para obtener más información acerca de los varios códigos de error y la definición correspondiente, consulte los Códigos de error.
Notas adicionales
- Mientras obtiene los datos desde su cuenta de Zoho CRM, se aplicará la seguridad a nivel de campo del usuario. Por lo tanto, para capturar todos los datos de los usuarios, debe utilizar el ID del usuario con la función (p. ej., director general) y el perfil (p. ej., administrador) más elevados.
- fromIndex y toIndex son parámetros opcionales. Por defecto, el parámetro fromIndex es 1 y 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
Para capturar todas las cuentas en formato JSON ordenadas por nombre de cuenta (en orden descendente) a partir de 20 a 200
Formato de la dirección URL:
Para capturar todas las cuentas en formato XML modificadas o creadas después del 2008-05-27 00:00:00
Formato de la dirección URL:
Para capturar los clientes potenciales con version = 1
Para capturar los clientes potenciales con version = 2
Esto generará una respuesta como la que se muestra a continuación:
Para capturar clientes potenciales sin especificar el parámetro newFormat
Nota:
- Cuando no se especifique el formato de la respuesta, se asignará predeterminadamente el valor "1" al parámetro newFormat, es decir, newFormat = 1
Esto generará una respuesta como la que se muestra a continuación:
Para capturar con newFormat=2
Para llamar con fromIndex=1, toIndex=25
Nota:
- Esto restablecerá de 1 a 25 registros.
Para llamar con lastModifiedTime
Nota:
- Si especifica la hora, se capturarán los datos modificados después de la hora configurada.
Para seleccionar todos los campos de los clientes potenciales con newFormat=1
Nota:
- Esto restablecerá todos los campos con valores.
Para seleccionar todos los campos de los clientes potenciales con newFormat=2
Nota:
- Esto restablecerá todos los campos, incluidos los campos con valor null.
Para llamar con lastModifiedTime, fromIndex y toIndex
Para llamar con lastModifiedTime, fromIndex y toIndex (para el módulo de cuentas)
Programa de prueba
Puede utilizar el programa adjunto para ejecutar y probar el funcionamiento del método getRecordById en su entorno de Java.
El programa Java contiene los siguientes elementos:
- el formato de generación de ticket
- los parámetros y sus valores
- el uso real del método
Haga clic aquí para descargar el programa