NAME

com::zoho::crm::api::util::CommonAPIHandler - This class is to process the API request and its response. Construct the objects that are to be sent as parameters or in the request body with the API. The Request parameter, header and body objects are constructed here. Process the response JSON and converts it to relevant objects in the library.

DESCRIPTION

METHODS

new

Creates instance for CommonAPIHandler.

set_api_path

This is a setter method to set the API request URL.

Param api_path : A String containing the API request URL.

add_param

This method is to add an API request parameter.

Param key : A String containing the API request parameter name.

Param value : A String containing the API request parameter value.

add_header

This method to add an API request header.

Param key : A String containing the API request header name.

Param value : A String containing the API request header value.

set_http_method

This is a setter method to set the HTTP method.

param http_method : A String containing http_method.

set_content_type

This is a setter method to set an API request content type.

param content_type A String containing the API request content type.

set_request

This is a setter method to set the API request body object.

Param request : A Object containing the API request body object.

set_module_api_name

This is a setter method to set the Zoho CRM module API name.

Param module_api_name : A String containing the Zoho CRM module API name.

api_call

This method is used in constructing API request and response details. To make the Zoho CRM API calls.

Param encode_type : A String containing the expected API response content type.

Param class_name : A Class containing the method return type.

getConverterClassInstance

This method is used to get a Converter class instance.

Param encode_type : A String containing the API response content type.

Returns A Converter class instance.