getSearchRecordsByPDC methode
Inhoudsopgave
Doel
U kunt deze methode gebruiken voor het doorzoeken van waarden op basis van vooraf gedefinieerde kolommen en aangepaste zoekvelden.
URL van het verzoek
XML-indeling:
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi
JSON-indeling:
https://crm.zoho.com/crm/private/json/Leads/getSearchRecordsByPDC?newFormat=1&authtoken=Auth Token&scope=crmapi
Parameters van het verzoek
Parameter | Gegevenstype | Beschrijving |
authotoken* | String | Versleutelde alfanumerieke tekenreeks ter verificatie van uw Zoho inloggegevens. |
scope* | String | Voer crmapi in als de scope |
selectColumns* | String | All of module(field 1,field 2,field 3, field n...) Voorbeeld: leads(Last Name,Website,Email) |
fromIndex | Integer | Standaardwaarde - 1 |
toIndex | Integer | Standaardwaarde - 20 Maximale bereikwaarde - 200 [Maximale bereikwaarde = toIndex - fromIndex] |
searchColumn* | String | Voer de vooraf gedefinieerde zoekkolom in (raadpleeg de Standaard vooraf gedefinieerde kolommen hieronder). Opmerking: u kunt ook waarden zoeken op basis van aangepaste zoekvelden. |
searchValue* | String | Voer de te zoeken waarde in |
newFormat | Integer | newFormat=1: Om velden met 'null'-waarden uit te sluiten wanneer u gegevens uit uw CRM-account invoegt. newFormat=2: Om velden met 'null'-waarden op te nemen wanneer u gegevens uit uw CRM-account invoegt. |
version | Integer | version = 1 (standaardwaarde) Hiermee worden responses opgehaald op basis van de eerdere API-implementatie, d.w.z. van vóór de doorgevoerde verbeteringen. version = 2: Hiermee worden responses opgehaald op basis van de meest recente API-implementatie. |
* - Verplichte parameter
Opmerking:
- Raadpleeg de Releaseopmerkingen voor meer informatie over doorgevoerde verbeteringen in de API-implementatie.
Standaard vooraf gedefinieerde kolommen
Module | Velden |
Leads | |
Accounts |
|
Contacts |
|
Potentials |
|
Campaigns |
|
Cases |
|
Solutions |
|
Products |
|
Purchase Order |
|
Quotes |
|
Sales Orders |
|
Invoices |
|
Vendors |
|
Tasks |
|
Events |
|
Opmerkingen |
|
Voorbeelden
Leads met email-kolom beginnend vanaf 20 tot 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 met email-kolom
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 met campaignid-kolom
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&selectColumns=Leads(Last Name,Website,Email)
&searchColumn=campaignid
&searchValue=2000000017011
Contacten met vendorid-kolom
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
Producten met vendorid-kolom
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
SalesOrders met accountid-kolom
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
Records doorzoeken met gebruik van aangepaste zoekvelden
https://crm.zoho.com/crm/private/xml/Leads/getSearchRecordsByPDC?authtoken=Auth Token&scope=crmapi
&searchColumn=ProductLookup_ID
&searchValue=108149000062016
Dit zal een response terugsturen zoals hieronder getoond:
<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>
Testprogramma
U kunt het bijgevoegde programma gebruiken om de werking van de getSearchRecordsByPDC methode in uw Java-omgeving uit te voeren en te testen.
Het Java-programma bevat het volgende:
- de indeling van het genereren van het verificatietoken
- de parameters en hun waarden
- het werkelijke gebruik van de methode
Klik hier om het programma downloaden