Antworten und Ausnahmen
APIResponse, BulkAPIResponse und FileAPIResponsesind die Wrapper-Objekte für die Antworten der Zoho CRM-APIs. Alle API-Aufrufmethoden geben eines dieser beiden Objekte zurück.
- Eine nach Methoden suchende Entität gibt das APIResponse-Objekt zurück, während eine nach Methoden suchende Entitätenliste das BulkAPIResponse-Objekt zurückgibt.
- FileAPIResponse wird für APIs zum Herunterladen von Dateien zurückgegeben, um ein Foto oder einen Anhang von einem Datensatz oder von einer Notiz herunterzuladen, darunter record.downloadPhoto,record.downloadAttachment usw.
- Verwenden Sie die Methode getData(), um nur die Entitätsdaten von den Antwort-Wrapper-Objekten herunterzuladen. APIResponse.getData() würde ein einzelnes Zoho CRM-Entitätsobjekt zurückgeben, während BulkAPIResponse.getData()eine Liste von Zoho CRM-Entitätsobjekten zurückgeben würde.
- FileAPIResponse weist zwei definierte Methoden auf:FileAPIResponse.getFileName() zum Zurückgeben des Namens der heruntergeladenen Datei und FileAPIResponse.getFileAsStream() zur Übergabe des Dateiinhalts als InputStream.
Neben den Daten weisen diese Antwort-Wrapper-Objekte folgende Eigenschaften auf:
- ResponseHeaders – Die verbleibende API ermittelt den aktuellen Tag/das Zeitfenster und die verstrichene Zeit für das Zurücksetzen des aktuellen Fensters.
- ResponseInfo – Alle anderen Informationen, sofern neben den eigentlichen Daten von der API bereitgestellt.
- List<EntityResponse> – Status der einzelnen Entitäten in der Bulk-API. Beispiel: Eine API zum Einfügen von Datensätzen kann aufgrund einiger Datensätze fehlschlagen. Dieses Array enthält den Erstellungsstatus der einzelnen Datensätze.
Die App starten
Das SDK erfordert den Aufruf der folgenden Codezeile bei jedem Starten der App.
ZCRMRestClient.initialize();
Diese Methode muss von der Hauptklasse Ihrer Java-Anwendung aufgerufen werden, um die Anwendung zu starten. Der Aufruf muss ohne Ausnahme erfolgen.
Ausnahmen prüfen
Unerwartetes Verhalten, darunter fehlerhafte API-Antworten und SDK-Anomalien, werden vom SDK gehandhabt und nur in Form einer einzigen Ausnahme ausgegeben: ZCRMException. Daher reicht es aus, nur diese Ausnahme im Code der Client-App abzufangen.