Méthode getCVRecords
Table des matières
- Objectif
- URL de la requête
- Paramètres de la requête
- Codes d'erreur
- Exemples
- Pour récupérer tous les prospects ouverts depuis le module Leads (Prospects)
- 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
- Programme de test
Objectif
Vous pouvez utiliser la méthode getCVRecords pour récupérer des données concernant la vue personnalisée dans Zoho CRM.
Important : quelle que soit l'édition Zoho CRM, vous ne pouvez envoyer que 250 requêtes API/jour. Dans chaque requête, vous pouvez récupérer un maximum de 200 enregistrements.
URL de la requête
Format XML :
https://crm.zoho.com/crm/private/xml/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Name of Custom View
Format JSON :
https://crm.zoho.com/crm/private/json/Leads/getCVRecords?authtoken=Auth Token&scope=crmapi&cvName=Name of Custom View
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. |
| fromIndex | Nombre entier | Valeur par défaut - 1 |
| toIndex | Nombre entier | Valeur par défaut - 20 Valeur maximale - 200 |
| cvName* | Chaîne | Récupérez les données pour une vue personnalisée spécifiée. Exemple : cvName=All Open Leads |
| LastModifiedTime | DateTime | Default:null Si vous définissez l'heure, les données créé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 à partir de votre compte CRM. newFormat=2 : pour inclure les champs avec des valeurs « null » lors de l'insertion de données à partir de votre compte CRM. |
| version | Nombre entier | version = 1 : (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. La dernière version est 4. |
* - Paramètre obligatoire
Codes d'erreur
Veuillez consulter Codes d'erreur .
Exemples
Pour récupérer tous les prospects depuis le module Leads (Prospects)
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 :
La valeur pour l'e-mail est « null » et n'apparaît donc pas dans la réponse.
Pour récupérer avec newFormat=2
Cela renvoie une réponse de type :
Pour appeler avec fromIndex=1, toIndex=25
Remarque :
- Cela renverra les 25 premiers 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
Programme de test
Vous pouvez utiliser le programme joint pour exécuter et tester le fonctionnement de la méthode getCVRecords 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.