getMyRecords methode
Inhoudsopgave
- Doel
- URL van het verzoek
- Parameters van het verzoek
- Foutcodes
- Voorbeelden
- Lead-gegevens ophalen uit Zoho CRM
- Meer dan 200 records ophalen
- Leads met de bedrijfsnaam in oplopende volgorde ophalen
- Leads met de bedrijfsnaam in aflopende volgorde ophalen
- Leads ophalen zonder de newFormat parameter in te vullen
- Leads ophalen met 'newFormat=2"
- De eerste 25 leads ophalen uit Zoho CRM
- Leads ophalen met 'lastModifiedTime”-parameter
- Alle velden van leads selecteren met newFormat=1 parameter
- Alle velden van leads selecteren met newFormat=2
- Leads ophalen met lastModifiedTime, fromIndex en toIndex parameters
- Testprogramma
Doel
U kunt de getMyRecords methode gebruiken voor het ophalen van gegevens door de eigenaar van het verificatietokenzoals opgegeven in het API-verzoek.
URL van het verzoek
XML-indeling:
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi
JSON-indeling:
https://crm.zoho.com/crm/private/json/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi
Parameters van het verzoek
| Parameter | Gegevenstype | Beschrijving |
| authtoken* | String | Versleutelde alfanumerieke tekenreeks ter verificatie van uw Zoho inloggegevens. |
| scope* | String | Voer als waarde crmapi in |
| selectColumns | String | Voor het selecteren van de verplichte velden in de CRM-module. Indeling: Module(optionele kolommen) Voorbeeld: leads(Achternaam,website,e-mail) of All |
| fromIndex | Integer | Standaardwaarde - 1 |
| toIndex | Integer | Standaardwaarde - 20 Maximale bereikwaarde - 200 [Maximale bereikwaarde = toIndex - fromIndex] |
| sortColumnString | String | U kunt een van de velden in het CRM selecteren om de gegevens te sorteren. Ex: sortColumnString=Company In dit geval zullen de gegevens op basis van het Company veld worden gesorteerd |
| sortOrderString | String | Sorteervolgorde: oplopend of aflopend Als u de sortColumnString parameter gebruikt worden de gegevens standaard in oplopende volgorde gesorteerd. |
| lastModifiedTime | jjjj-mm-dd uu:mm:ss | Standaardwaarde: null Als u het tijdstip invoert, worden aangemaakte/gewijzigde gegevens opgehaald na het ingestelde tijdstip. |
| newFormat | Integer (1 of 2) | newFormat=1: Om velden met 'null'-waarden uit te sluiten wanneer u gegevens uit uw CRM-account ophaalt. newFormat=2: Om velden met 'null'-waarden op te nemen wanneer u gegevens uit uw CRM-account ophaalt. |
| version | Integer | version = 1:(standaard waarde) Hiermee worden responses opgehaald op basis van de eerdere API-implementatie, d.w.z. van vóór de doorgevoerde verbeteringen. Huidige versie is 4. |
* - Verplichte parameter
Opmerking:
- Raadpleeg de Releaseopmerkingen voor meer informatie over doorgevoerde verbeteringen in de API-implementatie.
Foutcodes
Raadpleeg de Foutcodes.
Aanvullende opmerkingen
- Tijdens het ophalen van gegevens uit uw Zoho CRM-account wordt beveiliging op basis van rollen (rollen, profielen, beveiliging op veldniveau en regels voor het delen van gegevens) toegepast. Voor beveiliging op basis van rollen, zie Beveiligingsbeheer.
- fromIndex en toIndex zijn optionele parameters. Standaard is de fromIndex 1 en de toIndex 20.
- sortColumnString en sortOrderString zijn ook optionele parameters
- De waarde van de lastModifiedTime parameter moet de volgende indeling hebben: jjjj-mm-dd uu:mm:ss
Voorbeelden
Lead-gegevens ophalen uit Zoho CRM
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?newFormat=1&authtoken=Auth Token&scope=crmapi
Om gegevens op te halen uit andere modules, vervangt u Leads door Accounts, Contacts, Potentials, etc.
Meer dan 200 records ophalen
U kunt standaard 20 records per batch ophalen. Met behulp van de toIndex parameter kunt u echter maximaal 200 records per batch ophalen. Om meer dan 200 records op te halen, dient u de onderstaande stappen te volgen:
Iteratie 1: fromIndex=1&toIndex=200
Iteratie 2: fromIndex=201&toIndex=400
Leads met de bedrijfsnaam in oplopende volgorde ophalen
sortColumnString=Company&sortOrderString=asc
Leads met de bedrijfsnaam in aflopende volgorde ophalen
sortColumnString=Company&sortOrderString=desc
Leads ophalen zonder de newFormat parameter in te vullen
Opmerking:
- Wanneer de response-indeling niet wordt gespecificeerd, wordt de standaardwaarde '1' toegewezen aan de newFormat parameter, d.w.z. 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)
Dit zal een response terugsturen zoals hieronder getoond:
<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>
Leads ophalen met '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)
Dit zal een response terugsturen zoals hieronder getoond:
<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>
De eerste 25 leads ophalen uit 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
Leads ophalen met 'lastModifiedTime”-parameter
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
Opmerking:
- Als u het tijdstip invoert worden gewijzigde gegevens na het ingestelde tijdstip opgehaald.
Alle velden van leads selecteren met newFormat=1 parameter
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=1&selectColumns=All
Opmerking:
- Hiermee worden alle velden die een waarde hebben teruggestuurd.
Alle velden van leads selecteren met newFormat=2
https://crm.zoho.com/crm/private/xml/Leads/getMyRecords?authtoken=Auth Token&scope=crmapi&newFormat=2&selectColumns=All
Opmerking:
- Hiermee worden alle velden teruggestuurd, inclusief null-waarde velden.
Leads ophalen met lastModifiedTime, fromIndex en toIndex parameters
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 &fromIndex=1&toIndex=25
Testprogramma
U kunt het bijgevoegde programma gebruiken om de werking van de getMyRecords 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