Java SDK Samples - Roles Operations

              Copy to Clipboard
              
package samples.src.com.zoho.crm.api.role;

import java.util.Arrays;

import java.util.List;

import java.util.Map;

import com.zoho.crm.api.roles.APIException;

import com.zoho.crm.api.roles.ResponseHandler;

import com.zoho.crm.api.roles.ResponseWrapper;

import com.zoho.crm.api.roles.RolesOperations;

import com.zoho.crm.api.util.APIResponse;

import com.zoho.crm.api.util.Model;

public class Role
{
    /**
     * Get Roles
     * This method is used to retrieve the data of roles through an API request and print the response.
     * @throws Exception
     */
    public static void getRoles() throws Exception
    {
        //Get instance of RolesOperations Class
        RolesOperations rolesOperations = new RolesOperations();
        
        //Call getRoles method
        APIResponse response = rolesOperations.getRoles();
        
        if(response != null)
        {
            //Get the status code from response
            System.out.println("Status Code: " + response.getStatusCode());
            
            if(Arrays.asList(204,304).contains(response.getStatusCode()))
            {
                System.out.println(response.getStatusCode() == 204? "No Content" : "Not Modified");
                return;
            }
            
            //Check if expected response is received
            if(response.isExpected())
            {
                //Get object from response
                ResponseHandler responseHandler = response.getObject();
                
                if(responseHandler instanceof ResponseWrapper)
                {
                    //Get the received ResponseWrapper instance
                    ResponseWrapper responseWrapper = (ResponseWrapper) responseHandler;
                    
                    //Get the list of obtained Role instances
                    List roles = responseWrapper.getRoles();
                
                    for(com.zoho.crm.api.roles.Role role : roles)
                    {
                        //Get the DisplayLabel of each Role
                        System.out.println("Role DisplayLabel: " + role.getDisplayLabel());
                        
                        //Get the forecastManager User instance of each Role
                        com.zoho.crm.api.users.User forecastManager = role.getForecastManager();
                        
                        //Check if forecastManager is not null
                        if(forecastManager != null)
                        {
                            //Get the ID of the forecast Manager
                            System.out.println("Role Forecast Manager User-ID: " + forecastManager.getId());
                            
                            //Get the name of the forecast Manager
                            System.out.println("Role Forecast Manager User-Name: " + forecastManager.getName());
                        }
                        
                        //Get the ShareWithPeers of each Role
                        System.out.println("Role ShareWithPeers: " + role.getShareWithPeers().toString());
                        
                        //Get the Name of each Role
                        System.out.println("Role Name: " + role.getName());
                        
                        //Get the Description of each Role
                        System.out.println("Role Description: " + role.getDescription());
                        
                        //Get the Id of each Role
                        System.out.println("Role ID: " + role.getId());
                        
                        //Get the reportingTo User instance of each Role
                        com.zoho.crm.api.users.User reportingTo = role.getReportingTo();
                        
                        //Check if reportingTo is not null
                        if(reportingTo != null)
                        {
                            //Get the ID of the reportingTo User
                            System.out.println("Role ReportingTo User-ID: " + reportingTo.getId());
                            
                            //Get the name of the reportingTo User
                            System.out.println("Role ReportingTo User-Name: " + reportingTo.getName());
                        }
                        
                        //Get the AdminUser of each Role
                        System.out.println("Role AdminUser: " + role.getAdminUser().toString());
                    }
                }
                //Check if the request returned an exception
                else if(responseHandler instanceof APIException)
                {
                    //Get the received APIException instance
                    APIException exception = (APIException) responseHandler;
                    
                    //Get the Status
                    System.out.println("Status: " + exception.getStatus().getValue());
                    
                    //Get the Code
                    System.out.println("Code: " + exception.getCode().getValue());
                    
                    System.out.println("Details: " );
                    
                    //Get the details map
                    for(Map.Entry entry : exception.getDetails().entrySet())
                    {
                        //Get each value in the map
                        System.out.println(entry.getKey() + ": " + entry.getValue());
                    }
                    
                    //Get the Message
                    System.out.println("Message: " + exception.getMessage().getValue());
                }
            }
            else
            {//If response is not as expected
                
                //Get model object from response
                Model responseObject = response.getModel();
                
                //Get the response object's class
                Class extends Model> clas = responseObject.getClass();
                
                //Get all declared fields of the response class
                java.lang.reflect.Field[] fields = clas.getDeclaredFields();
                
                for(java.lang.reflect.Field field : fields)
                {
                    //Get each value
                    System.out.println(field.getName() + ":" + field.get(responseObject));
                }
            }
        }
    }
}

              Copy to Clipboard
              
package samples.src.com.zoho.crm.api.role;

import java.util.Arrays;

import java.util.List;

import java.util.Map;

import com.zoho.crm.api.roles.APIException;

import com.zoho.crm.api.roles.ResponseHandler;

import com.zoho.crm.api.roles.ResponseWrapper;

import com.zoho.crm.api.roles.RolesOperations;

import com.zoho.crm.api.util.APIResponse;

import com.zoho.crm.api.util.Model;

public class Role
{   
    /**
     * Get Role
     * This method is used to retrieve the data of single role through an API request and print the response.
     * @param roleId The ID of the Role to be obtained
     * @throws Exception
     */
    public static void getRole(Long roleId) throws Exception
    {
        //example
        //Long roleId = 34770613881;
        
        //Get instance of RolesOperations Class
        RolesOperations rolesOperations = new RolesOperations();
        
        //Call getRole method that takes roleId as parameter
        APIResponse response = rolesOperations.getRole(roleId);
        
        if(response != null)
        {
            //Get the status code from response
            System.out.println("Status Code: " + response.getStatusCode());
            
            if(Arrays.asList(204,304).contains(response.getStatusCode()))
            {
                System.out.println(response.getStatusCode() == 204? "No Content" : "Not Modified");
                return;
            }
            
            //Check if expected response is received
            if(response.isExpected())
            {
                //Get object from response
                ResponseHandler responseHandler = response.getObject();
                
                if(responseHandler instanceof ResponseWrapper)
                {
                    //Get the received ResponseWrapper instance
                    ResponseWrapper responseWrapper = (ResponseWrapper) responseHandler;
                    
                    //Get the list of obtained Role instances
                    List roles = responseWrapper.getRoles();
                
                    for(com.zoho.crm.api.roles.Role role : roles)
                    {
                        //Get the DisplayLabel of each Role
                        System.out.println("Role DisplayLabel: " + role.getDisplayLabel());
                        
                        //Get the forecastManager User instance of each Role
                        com.zoho.crm.api.users.User forecastManager = role.getForecastManager();
                        
                        //Check if forecastManager is not null
                        if(forecastManager != null)
                        {
                            //Get the ID of the forecast Manager
                            System.out.println("Role Forecast Manager User-ID: " + forecastManager.getId());
                            
                            //Get the name of the forecast Manager
                            System.out.println("Role Forecast Manager User-Name: " + forecastManager.getName());
                        }
                        
                        //Get the ShareWithPeers of each Role
                        System.out.println("Role ShareWithPeers: " + role.getShareWithPeers().toString());
                        
                        //Get the Name of each Role
                        System.out.println("Role Name: " + role.getName());
                        
                        //Get the Description of each Role
                        System.out.println("Role Description: " + role.getDescription());
                        
                        //Get the Id of each Role
                        System.out.println("Role ID: " + role.getId());
                        
                        //Get the reportingTo User instance of each Role
                        com.zoho.crm.api.users.User reportingTo = role.getReportingTo();
                        
                        //Check if reportingTo is not null
                        if(reportingTo != null)
                        {
                            //Get the ID of the reportingTo User
                            System.out.println("Role ReportingTo User-ID: " + reportingTo.getId());
                            
                            //Get the name of the reportingTo User
                            System.out.println("Role ReportingTo User-Name: " + reportingTo.getName());
                        }
                        
                        //Get the AdminUser of each Role
                        System.out.println("Role AdminUser: " + role.getAdminUser().toString());
                    }
                }
                //Check if the request returned an exception
                else if(responseHandler instanceof APIException)
                {
                    //Get the received APIException instance
                    APIException exception = (APIException) responseHandler;
                    
                    //Get the Status
                    System.out.println("Status: " + exception.getStatus().getValue());
                    
                    //Get the Code
                    System.out.println("Code: " + exception.getCode().getValue());
                    
                    System.out.println("Details: " );
                    
                    //Get the details map
                    for(Map.Entry entry : exception.getDetails().entrySet())
                    {
                        //Get each value in the map
                        System.out.println(entry.getKey() + ": " + entry.getValue());
                    }
                    
                    //Get the Message
                    System.out.println("Message: " + exception.getMessage().getValue());
                }
            }
            else
            {//If response is not as expected
                
                //Get model object from response
                Model responseObject = response.getModel();
                
                //Get the response object's class
                Class extends Model> clas = responseObject.getClass();
                
                //Get all declared fields of the response class
                java.lang.reflect.Field[] fields = clas.getDeclaredFields();
                
                for(java.lang.reflect.Field field : fields)
                {
                    //Get each value
                    System.out.println(field.getName() + ":" + field.get(responseObject));
                }
            }
        }
    }
}