Aide CRM

Méthode getSearchRecordsByPDC

Objectif

Vous pouvez utiliser cette méthode pour rechercher les valeurs en fonction de champs de recherche et de colonnes personnalisés.

URL de demande

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

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

Paramètres de demande

ParamètreType de donnéesDescription
authotoken*ChaîneChaîne alphanumérique chiffrée utilisée pour l'authentification de vos identifiants Zoho.
scope*ChaîneIndiquez crmapi pour l'étendue
selectColumns*ChaîneALL ou module(field 1,field 2,field 3, field n...)
Exemple : leads(Last Name,Website,Email)
fromIndexEntierValeur par défaut - 1
toIndexEntierValeur par défaut - 20
Valeur maximale de la plage - 200
[Valeur maximale de la plage = toIndex - fromIndex]
searchColumn*Chaîne

Précisez la colonne de recherche prédéfinie (reportez-vous àColonnes prédéfinies par défaut ci-dessous).

Remarque : vous pouvez également rechercher des valeurs en fonction de champs de recherche personnalisée.

searchValue*ChaînePrécisez la valeur à rechercher
newFormatEntiernewFormat=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 des champs avec des valeurs « null » lors de l'insertion de données à partir de votre compte CRM.
versionEntierversion = 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.

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

Colonnes prédéfinies par défaut

ModuleChamps
Leads
  • email
Comptes
  • accountid
  • accountname
Contacts
  • contactid
  • accountid
  • vendorid
  • email
Clients potentiels
  • potentialid
  • accountid
  • campaignid
  • contactid
  • potentialname
Campagnes
  • campaignid
  • campaignname
Dossiers
  • caseid
  • productid
  • accountid
  • potentialid
Solutions
  • solutionid
  • productid
Produits
  • productid
  • vendorid
  • productname
Commande fournisseur
  • purchaseorderid
  • contactid
  • vendorid
Devis
  • quoteid
  • potentialid
  • accountid
  • contactid
Commandes clients
  • salesorderid
  • potentialid
  • accountid
  • contactid
  • quoteid
Factures
  • invoiceid
  • accountid
  • salesorderid
  • contactid
Fournisseurs
  • vendorid
  • vendorname
Tâches
  • taskid
Événements
  • eventid
Remarques
  • notesid

Exemples

Leads avec colonne email de 20 à 200

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi&fromIndex=20&toIndex=200&selectColumns=leads(Last Name,Website,Email)&searchColumn=email &searchValue=abc@testingdomain.com

Leads avec colonne email

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=email
&searchValue=test@test.com

Leads avec colonne campaignid

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=campaignid
&searchValue=2000000017011

Contacts avec colonne vendorid

https://crm.zoho.com/crm/private/xml/Contacts/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Contacts(Contact Owner,Lead Source,First Name,Last Name,Account Name)
&searchColumn=vendorid
&searchValue=2000000017022

Produits avec colonne vendorid

https://crm.zoho.com/crm/private/xml/Products/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Products(Product Owner,Product Name,Product Code,Manufacturer,Product Category,Unit Price)
&searchColumn=vendorid
&searchValue=2000000017022

Commandes fournisseurs avec colonne accountid

https://crm.zoho.com/crm/private/xml/SalesOrders/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=SalesOrders(SO Number,Subject,Due Date,Carrier,Status)
&searchColumn=accountid
&searchValue=2000000017003

Rechercher des enregistrements en utilisant les champs de recherche personnalisée

https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&searchColumn=ProductLookup_ID
&searchValue=108149000062016

Ceci renvoie une réponse de type :

<Leads>
<row no="1">
<FL val="LEADID">108490000020024</FL>
<FL val="SMOWNERID">1081490000078001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zylker Inc.</FL>
<FL val="Last Name">Scott</FL>
<FL val="SMCREATORID">1081490000078001</FL>
<FL val="Created By">John</FL>
<FL val="MODIFIEDBY">1081490000078001</FL>
<FL val="Modified By">John</FL>
<FL val="Created Time">2014-10-27 15:18:11</FL>
<FL val="Modified Time">2014-11-26 12:53:13</FL>
<FL val="Last Activity Time">2014-11-26 12:53:13</FL>
<FL val="ProductLookup_ID">108149000062016</FL>
<FL val="ProductLookup">CPU</FL>
</row>
</Leads>

Programme de test

Vous pouvez utiliser le programme ci-joint pour exécuter et tester le fonctionnement de la méthode getSearchRecordsByPDC 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

Cliquez ici pour télécharger le programme

Share this post : FacebookTwitter

Vous ne trouvez toujours pas ce que vous cherchez?

Écrivez-nous: support@zohocrm.com