Méthode getMyRecords

Table des matières

Objectif
URL de la demande
Paramètres de la demande
Codes d'erreur
Exemples
Programme de test

Objectif

Vous pouvez utiliser la méthode getMyRecords pour récupérer des données par propriétaire du jeton d'authentification défini dans la demande d'API.

URL de demande

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

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

Paramètres de demande

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	Entrez la valeur crmapi
selectColumns	Chaîne	Pour sélectionner les champs requis du module CRM. Format : Module(colonnes facultatives) Exemple : leads(nom,site Web,e-mail) OU All
fromIndex	Entier	Valeur par défaut - 1
toIndex	Entier	Valeur par défaut - 20 Valeur maximale de la plage - 200 [Valeur maximale de la plage = toIndex - fromIndex]
sortColumnString	Chaîne	Vous pouvez sélectionner l'un des champs dans le CRM pour trier les données. Ex. : sortColumnString=Société Dans ce cas, le tri des données s'effectuera en fonction du champ Société
sortOrderString	Chaîne	Ordre de tri : croissant ou décroissant Si vous utilisez le paramètre sortColumnString, les données sont triées par défaut par ordre croissant.
lastModifiedTime	aaaa-mm-jj hh:mn:ss	Valeur par défaut : « null » Si vous définissez l'heure, les données créées ou modifiées sont récupérées après l'heure configurée.
newFormat	Entier (1 ou 2)	newFormat=1 : pour exclure les champs avec des valeurs « null » lors de la récupération des données de votre compte CRM. newFormat=2 : pour inclure des champs avec des valeurs « null » lors de la récupération des données de votre compte CRM.
version	Entier	version = 1 : (valeur par défaut) permet de récupérer les réponses en fonction de la version d'API mise en œuvre précédemment, c.-à-d. avant les améliorations apportées. version = 2 : permet de récupérer les réponses en fonction de l'API la plus récente. La dernière version est 4.

* - Paramètre obligatoire

Remarque :

consultez la page des Notes de mise à jour pour en savoir plus sur les améliorations apportées à la mise en œuvre de l'API.

Codes d'erreur

Reportez-vous à la rubrique Codes d'erreur.

Notes supplémentaires

Lors de l'extraction des données de votre compte Zoho CRM, la sécurité fondée sur les rôles (rôles, profils, sécurité au niveau des champs de données et règles de partage des données) est appliquée. Pour les paramètres de sécurité fondée sur les rôles, reportez-vous à Administration de la sécurité.
fromIndex et toIndex sont des paramètres facultatifs. Par défaut, le paramètre fromIndex est 1 et le paramètre toIndex est 20.
sortColumnString et sortOrderString sont également des paramètres optionnels.
La valeur du paramètre lastModifiedTime doit être définie au format aaaa-mm-jj hh:mm:ss.

Exemples

Pour récupérer les données de leads à partir de Zoho CRM

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

Pour récupérer des données à partir d'autres modules, remplacer Leads par Comptes, Contacts, Clients potentiels, etc.

Pour récupérer plus de 200 enregistrements

Par défaut, vous pouvez récupérer 20 enregistrements par lot. Cependant, en utilisant le paramètre toIndex, vous pouvez récupérer jusqu'à 200 enregistrements par lot. Si vous souhaitez récupérer plus de 200 enregistrements, suivez les étapes ci-dessous :

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

Pour récupérer des leads avec le nom de « société » dans un ordre croissant

sortColumnString=Company&sortOrderString=asc

Pour récupérer des leads avec le nom de « société » dans un ordre décroissant

sortColumnString=Company&sortOrderString=desc

Pour récupérer des leads sans définir le paramètre newFormat

Remarque :

Lorsqu'il n'y a pas de précision sur le format de réponse, la valeur par défaut « 1 » est attribuée au paramètre newFormat, c.-à-d. 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)

Ceci renvoie une réponse de type :

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

Pour récupérer des leads avec le paramètre « 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)

Ceci renvoie une réponse de type :

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

Pour récupérer les 25 premiers leads à partir de 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

Pour récupérer des leads avec le paramètre « 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

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 des leads avec le paramètre newFormat=1

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

Remarque :

Ceci renverra tous les champs dotés de valeurs.

Pour sélectionner tous les champs des leads avec newFormat=2

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

Remarque :

Ceci renverra tous les champs, y compris les champs de valeur « null ».

Pour récupérer des leads avec les paramètres lastModifiedTime, fromIndex and toIndex

Programme de test

Vous pouvez utiliser le programme joint pour exécuter et tester le fonctionnement de la méthode getMyRecords dans votre environnement Java.

Le programme Java contient les éléments suivants :

format de génération du jeton d'authentification
paramètres et leurs valeurs
utilisation réelle de la méthode

Was this article helpful? Yes, thanks!Not really

Share this post : FacebookTwitter

Top

Vous ne trouvez toujours pas ce que vous cherchez?

Écrivez-nous: support@zohocrm.com