Reacties en uitzonderingen
APIResponse, BulkAPIResponse en FileAPIResponse zijn wrapperobjecten voor de reacties van Zoho CRM API's. Alle API-aanroepmethoden retourneren een van deze twee objecten.
- Een methode die een enkele entiteit zoekt, retourneert een APIResponse-object, terwijl een methode die een lijst met entiteiten zoekt een BulkAPIResponse-object zou opleveren.
- FileAPIResponse wordt geretourneerd voor API's voor het downloaden van bestanden om een foto of bijlage te downloaden van een record of notitie, zoals record.DownloadPhoto, record.DownloadAttachment, enzovoort.
- Gebruik de instantievariabele "Data" of "BulkData" om de entiteitsgegevens alleen op te halen uit de objecten van de reactiewrapper. APIResponse.Data retourneert één Zoho CRM-entiteitsobject, terwijl BulkAPIResponse.BulkData een lijst met Zoho CRM-entiteitsobjecten retourneert.
- FileAPIResponse heeft twee gedefinieerde methoden, namelijk FileAPIResponse.GetFileName() waarmee de naam van het gedownloade bestand retourneert en FileAPIResponse.GetFileAsStream() waarmee de bestandsinhoud wordt doorgegeven als inputStream.
Let op:
- BulkAPIResponse is een algemene klasse. Daarom moet het bijbehorende type worden gebruikt om de records op te halen.
"ZCRMModule module = ZCRMModule.GetInstance("Contacts");
BulkAPIResponse<ZCRMRecord> response = module.GetRecords();
List<ZCRMRecord> records = response.BulkData;"
Behalve gegevens hebben deze reactiewrapperobjecten de volgende eigenschappen.
- ResponseHeaders – resterende API-tellingen voor de huidige dag/het huidige venster en de tijd die is verstreken voor het opnieuw instellen van het huidige venster. Deze zijn beschikbaar via:
response.GetResponseHeaders()
- ResponseInfo – alle andere informatie, indien geleverd door de API, naast de werkelijke gegevens.
response.Info
- List<EntityResponse> – status van afzonderlijke entiteiten in een bulk-API. In een invoegrecord kan API bijvoorbeeld gedeeltelijk mislukken vanwege een paar records. Dit woordenboek geeft de aanmaakstatus van de afzonderlijke records weer. Het is beschikbaar via:
response.BulkEntitiesResponse
Uitzonderingen controleren
Elke onverwachte werking, zoals foutieve API-reacties en SDK-afwijkingen, wordt door de SDK verwerkt en slechts als één uitzondering weergegeven – ZCRMException. Het is dus voldoende om alleen deze uitzondering op te sporen in de code van de clientapp.