getRecordById methode
Inhoudsopgave
Doel
U kunt deze methode gebruiken voor het ophalen van individuele records op basis van record ID.
URL van het verzoek
XML-indeling:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=RecordID
JSON-indeling:
https://crm.zoho.com/crm/private/json/Leads/getRecordById?&authtoken=Auth Token&scope=crmapi&id=RecordID
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 |
| id* of idlist* | String | id: Voer de unieke ID van de record in. idlist: Voer een unieke set van ID’s (gescheiden door puntkomma) in. U kunt maximaal 100 ID’s invoeren wanneer u deze parameter gebruikt. |
| 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: (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.
Voorbeelden
Gebruik de onderstaande URL voor het ophalen van records op basis van ID:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&id=ID
Gebruik de onderstaande URL voor het ophalen van records op basis van ID List:
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=ID1;ID2;...;ID100
Opmerking:
- U kunt records ophalen met behulp van de id of idlist parameter. Gebruik de 'id' parameter om records op te halen van een unieke ID. Gebruik de 'idlist' parameter om records op te halen van gewenste ID’s.
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/getRecordById?authtoken=Auth Token&scope=crmapi&id=2000000022020&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 door het invullen van de idlist parameter
https://crm.zoho.com/crm/private/xml/Leads/getRecordById?authtoken=Auth Token&scope=crmapi&idlist=108490000014005;108490000020024
Dit zal een response terugsturen zoals hieronder getoond:
<Leads>
<row no="1">
<FL val="LEADID">108490000015005</FL>
<FL val="SMOWNERID">10849000015001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Zylker Inc.</FL>
<FL val="Last Name">James</FL>
<FL val="No of Employees">100</FL>
<FL val="SMCREATORID">10849000014001</FL>
<FL val="Created By">John</FL>
<FL val="MODIFIEDBY">10849000015001</FL>
<FL val="Modified By">John</FL>
<FL val="Created Time">2014-04-30 17:41:05</FL>
<FL val="Modified Time">2014-10-08 14:41:21</FL>
<FL val="Last Activity Time">2014-10-08 14:42:16</FL>
</row>
<row no="2">
<FL val="LEADID">108490000020024</FL>
<FL val="SMOWNERID">1081490000078001</FL>
<FL val="Lead Owner">John</FL>
<FL val="Company">Acme 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>
</row>
</Leads>
Testprogramma
U kunt het bijgevoegde programma gebruiken om de werking van de getRecordById 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