Klassenhiërarchie

Alle Zoho CRM-entiteiten worden gemodelleerd als modules met klassen, methoden en instantievariabelen die van toepassing zijn op die specifieke entiteit. ZCRMRestClient is de basisklasse van de C# SDK. ZCRMRestClient beschikt over methoden om exemplaren van verschillende andere Zoho CRM-entiteiten op te halen. Deze bevindt zich in de RestClient-module.

• ZCRMRestClient is de basisklasse van de SDK.
• Deze klasse heeft methoden om exemplaren van verschillende andere Zoho CRM-entiteiten op te halen.
• De klassenrelaties en -hiërarchie van de SDK volgen de entiteitshiërarchie in Zoho CRM.
• Elke klassenentiteit heeft functies om zijn eigen eigenschappen op te halen en gegevens van zijn directe onderliggende entiteiten op te halen via een API-aanroep. Bijvoorbeeld: een Zoho CRM-module-object (ZCRMModule) heeft lidfuncties om de eigenschappen van een module op te halen, zoals weergavenaam, module-id, enzovoort, en heeft ook functies om alle onderliggende objecten op te halen (zoals ZCRMLayout).

De klassenrelaties en -hiërarchie van de SDK volgen de entiteitshiërarchie in Zoho CRM. Hieronder vindt u de klassenhiërarchie van verschillende Zoho CRM-entiteiten.

Net als in de hiërarchie heeft elke entiteitsklasse instantievariabelen om zijn eigen eigenschappen op te halen en gegevens van zijn directe onderliggende entiteiten op te halen via een API-aanroep.

Instantieobjecten

Het is niet altijd effectief om de volledige klassenhiërarchie van bovenaf te volgen om de gegevens van een entiteit op een lager niveau op te halen, aangezien dit API-aanroepen op elk niveau zou omvatten. Om dit af te handelen, heeft elke entiteitsklasse een GetInstance()-methode om een eigen dummyobject en instantievariabelen te verkrijgen voor het ophalen van dummyobjecten van de onderliggende entiteiten.

Samengevat:

• ZCRMRestClient.getInstance().GetModule("Contacts") retourneert de module Contactpersonen, waarin alle eigenschappen van de module Contactpersonen zijn ingevuld via een API-aanroep.
• ZCRMRestClient.GetModuleInstance("Contacts") retourneert een dummy ZCRMModule-object dat verwijst naar de module Contactpersonen, zonder dat er eigenschappen zijn ingevuld, omdat er dan geen API-aanroep wordt gedaan.

Om records van een module op te halen, hoeft u dus niet helemaal te starten vanaf ZCRMRestClient. In plaats daarvan kunt u een ZCRMModule-exemplaar verkrijgen met ZCRMModule.getInstance(module_api_name) en vervolgens de niet-statische methode get_records() aanroepen vanuit het gemaakte exemplaar. Hierdoor wordt de API-aanroep voorkomen die zou zijn geactiveerd om het ZCRMModule-object te vullen.

Recordeigenschappen openen

Omdat recordeigenschappen dynamisch zijn in verschillende modules, hebben we alleen de gemeenschappelijke velden zoals CreatedTime, CreatedBy, Owner, enzovoort, opgegeven als standaardleden van ZCRMRecord. Alle andere recordeigenschappen zijn beschikbaar als een toewijzing in het ZCRMRecord-object.

Gebruik de beschikbare getter- en settermethoden om de afzonderlijke veldwaarden van een record te openen. De sleutels van de toewijzing van recordeigenschappen zijn de API-namen van de velden van de module. API-namen van alle velden van alle modules zijn beschikbaar onder

Instellingen → Marketplace → API's → CRM API → API-namen.

• Als u een veldwaarde wilt ophalen, gebruikt u record.GetFieldValue(field_api_name);
• Als u een veldwaarde wilt instellen, gebruikt u record.SetFieldValue(field_api_name, new_value).
  Zorg er bij het instellen van een veldwaarde voor dat de ingestelde waarde hetzelfde gegevenstype heeft als het veld waarop u deze wilt instellen.