Méthode getRecords
Table des matières
- Objectif
- URL de la requête
- Paramètres de la requête
- Erreurs de capture
- Exemples
- Pour récupérer tous les comptes au format JSON triés par nom de compte (par ordre décroissant) de 20 à 200
- Pour récupérer tous les comptes au format XML modifiés/créés après le 27-05-2008 à 00:00:00
- Pour récupérer les prospects avec version = 1
- Pour récupérer les prospects avec version = 2
- Pour récupérer des prospects sans spécifier le paramètre newFormat
- Pour récupérer avec newFormat=2
- Pour appeler avec fromIndex=1, toIndex=25
- Pour appeler avec lastModifiedTime
- Pour sélectionner tous les champs à partir de prospects avec newFormat=1
- Pour sélectionner tous les champs à partir de prospects avec newFormat=2
- Pour appeler avec lastModifiedTime, fromIndex et toIndex
- Pour appeler avec lastModifiedTime, fromIndex et toIndex (pour le module Accounts [Comptes])
- Programme de test
Objectif
Vous pouvez utiliser la méthode getRecords pour récupérer toutes les données des utilisateurs définies dans la requête API.
URL de la requête
Format XML :
https://crm.zoho.com/crm/private/xml/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Format JSON :
https://crm.zoho.com/crm/private/json/Leads/getRecords?authtoken=Auth Token&scope=crmapi
Paramètres de la requête
| Paramètre | Type de données | Description |
| authtoken* | Chaîne | Chaîne alphanumérique chiffrée utilisée pour l'authentification de vos identifiants Zoho. |
| scope* | Chaîne | Spécifiez la valeur comme crmapi. |
| selectColumns | Chaîne | Module(colonnes en option), c'est-à-dire leads(Last Name,Website,Email) OU All |
| fromIndex | Nombre entier | Valeur par défaut - 1 |
| toIndex | Nombre entier | Valeur par défaut - 20 Valeur de plage maximale - 200 [Valeur de plage maximale = toIndex - fromIndex] |
| sortColumnString | Chaîne | Si vous utilisez le paramètre sortColumnString, par défaut les données sont triées par ordre croissant. |
| sortOrderString | Chaîne | Valeur par défaut : asc Si vous voulez trier en ordre décroissant, vous devez transmettre sortOrderString= desc. |
| LastModifiedTime | DateTime | Valeur par défaut : null Si vous spécifiez l'heure, les données modifiées seront récupérées après l'heure configurée. |
| newFormat | Nombre entier | newFormat=1 : pour exclure les champs avec des valeurs « null » lors de l'insertion de données depuis votre compte CRM. newFormat=2 : pour inclure les champs avec des valeurs « null » lors de l'insertion de données depuis votre compte CRM. |
| version | Nombre entier | version = 1 : (valeur par défaut) Cela permettra de récupérer les réponses en fonction de l'API mise en œuvre précédemment, c'est-à-dire avant les améliorations apportées. version = 2 : Cela permettra de récupérer les réponses en fonction de la mise en œuvre de l'API la plus récente. |
* - Paramètre obligatoire
Remarque :
- Consultez la page Notes de publication pour en savoir plus sur les améliorations apportées à la mise en œuvre de l'API.
Erreurs de capture
L'API CRM fournit des codes d'erreur uniques pour résoudre facilement les problèmes dans votre programme, tout en synchronisant les données entre le CRM et votre application. Pour en savoir plus sur les différents codes d'erreur et les définitions correspondantes, veuillez consulter les Codes d'erreur.
Notes supplémentaires
- Lors de la récupération des données depuis votre compte Zoho CRM, les paramètres de sécurité au niveau des champs sont appliqués. Par conséquent, pour récupérer toutes les données utilisateur, utilisez l'ID d'utilisateur avec le rôle le plus élevé (ex. : PDG) et le profil le plus important (ex. : administrateur).
- fromIndex et toIndex sont des paramètres facultatifs. Par défaut, fromIndex est 1 et toIndex est 20.
- sortColumnString et sortOrderString sont également des paramètres facultatifs
- La valeur du paramètre lastModifiedTime doit être au format aaaa-MM-jj HH:mm:ss.
Exemples
Pour récupérer tous les comptes au format JSON triés par nom de compte (par ordre décroissant) de 20 à 200
Format de l'URL :
Pour récupérer tous les comptes au format XML modifiés/créés après le 27-05-2008 à 00:00:00
Format de l'URL :
Pour récupérer les prospects avec version = 1
Pour récupérer les prospects avec version = 2
Cela renvoie une réponse de type :
Pour récupérer des prospects sans spécifier le paramètre newFormat
Remarque :
- Lorsqu'il n'y a pas de spécification sur le format de réponse, la valeur par défaut « 1 » est attribuée au paramètre newFormat, c'est-à-dire newFormat = 1.
Cela renvoie une réponse de type :
Pour récupérer avec newFormat=2
Pour appeler avec fromIndex=1, toIndex=25
Remarque :
- Cela renverra 1 à 25 enregistrements.
Pour appeler avec lastModifiedTime
Remarque :
- Si vous définissez l'heure, les données modifiées seront récupérées après l'heure configurée.
Pour sélectionner tous les champs à partir de prospects avec newFormat=1
Remarque :
- Cela renverra tous les champs ayant des valeurs.
Pour sélectionner tous les champs à partir de prospects avec newFormat=2
Remarque :
- Cela renverra tous les champs, y compris les champs de valeur « null ».
Pour appeler avec lastModifiedTime, fromIndex et toIndex
Pour appeler avec lastModifiedTime, fromIndex et toIndex (pour le module Accounts [Comptes])
Programme de test
Vous pouvez utiliser le programme joint pour exécuter et tester le fonctionnement de la méthode getRecords dans votre environnement Java.
Le programme Java contient les éléments suivants :
- Format de génération de jeton
- Paramètres et leurs valeurs
- Utilisation réelle de la méthode
Cliquez ici pour télécharger le programme.