Responses & Exceptions - Java SDK

Responses & Exceptions - Java SDK

APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these three objects.
  • A method-seeking entity would return APIResponse object, whereas a method-seeking list of entities would return BulkAPIResponse object.
  • FileAPIResponse will be returned for file download APIs to download a photo or an attachment from a record or note such as record.downloadPhoto, record.downloadAttachment etc.
  • Use the getData() method to get the entity data alone from the response wrapper objects. APIResponse.getData() would return a single Zoho CRM entity object, while BulkAPIResponse.getData() would return a list of Zoho CRM entity objects.
  • FileAPIResponse has two defined methods namely FileAPIResponse.getFileName() which returns the name of the file that is downloaded and FileAPIResponse.getFileAsStream() that gives the file content as InputStream.
Other than data, these response wrapper objects have the following properties:
  1. ResponseHeaders - remaining API counts for the present day/window and time elapsed for the present window reset.
  2. ResponseInfo - any other information, if provided by the API, in addition to the actual data.
  3. List<EntityResponse> - status of individual entities in a bulk API. For example: an insert records API may partially fail because of a few records. This array gives the individual records’ creation status.

Start the App

The SDK requires the following line of code being invoked every time your app gets started.
  1. ZCRMRestClient.initialize();
This method should be called from the main class of your java application to start the application. It needs to be invoked without any exception.

Check Exceptions

All unexpected behaviors like faulty API responses, SDK anomalies are handled by the SDK and are thrown only as a single exception — ZCRMException. Hence, it's enough to catch this exception alone in the client app code.

    • Related Articles

    • Responses & Exceptions - PHP SDK

      APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these two objects. A method-seeking entity would return APIResponse object, whereas a method-seeking ...

    • Responses & Exceptions - C# SDK

      APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these two objects. A method-seeking entity would return APIResponse object, whereas a method-seeking ...

    • Responses & Exceptions - Python SDK

      APIResponse, BulkAPIResponse and FileAPIResponse are the wrapper objects for Zoho CRM APIs’ responses. All API calling methods would return one of these three objects. A method-seeking entity would return APIResponse object, whereas a method-seeking ...

    • Java SDK - Overview

      Java SDK offers a way to create client java applications that can be integrated with Zoho CRM. This SDK makes the access and use of necessary CRM APIs with ease. In other words, it serves as a wrapper for the REST APIs, making it easier to use the ...

    • Create the first Java Application

      Let us quickly walk through the sequence of steps to use Java SDK.       1. Register a Zoho client as described in the page link.       2. Create the File hierarchy in your eclipse project as shown below:                  3. Create a folder ...