Método getRecordById
Índice
Finalidad
Puede utilizar este método para obtener registros individuales por ID de registro.
Dirección URL de la solicitud
Formato XML:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=RecordID
Formato JSON:
https://crm.zoho.com/crm/private/json/Leads/getRecordById?&authtoken=Auth Token&scope=crmapi&id=RecordID
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 |
| id* o idlist* | Cadena | id: Specify unique ID of the record. idlist: especifique el conjunto único de ID (separados por punto y coma). Puede especificar hasta 100 ID mediante este parámetro. |
| newFormat | Entero (1 o 2) | newFormat=1: para excluir campos con valores "null" durante la obtención de los datos de su cuenta de CRM. newFormat=2: para incluir los campos con valores "null" durante la obtención de los 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.
Ejemplos
Para capturar registros por ID, utilice la dirección URL indicada a continuación:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID
Para capturar registros por lista de ID, utilice la dirección URL indicada a continuación:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100
Nota:
- Puede capturar los registros utilizando el parámetro id o idlist. Utilice el parámetro "id" para obtener los registros de un ID único. Utilice el parámetro "idlist" para obtener registros de los ID deseados.
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
Responderá como se muestra a continuación:
Para capturar clientes potenciales especificando el parámetro idlist
Responderá como se muestra a continuación:
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 tokens de autenticación
- los parámetros y sus valores
- el uso real del método
Haga clic aquí para descargar el programa