/// <summary>The method to create bulk write job</summary>
/// <param name="request">Instance of RequestWrapper</param>
/// <returns>Instance of APIResponse<ActionResponse></returns>
public APIResponse <ActionResponse> CreateBulkWriteJob(RequestWrapper request)
{
CommonAPIHandler handlerInstance = new CommonAPIHandler();
string apiPath = "";
apiPath = string.Concat(apiPath, "/crm/bulk/v2/write");
handlerInstance.APIPath = apiPath;
handlerInstance.HttpMethod = Constants.REQUEST_METHOD_POST;
handlerInstance.CategoryMethod = Constants.REQUEST_CATEGORY_CREATE;
handlerInstance.ContentType = "application/json";
handlerInstance.Request = request;
handlerInstance.MandatoryChecker = true;
return(handlerInstance.APICall <ActionResponse>(typeof(ActionResponse), "application/json"));
}
/// <summary>
/// This method is used to create a bulk write job.
/// </summary>
/// <param name="moduleAPIName">The API Name of the record's module.</param>
/// <param name="fileId">The ID of the uploaded file to create BulkWrite Job.</param>
public static void CreateBulkWriteJob(string moduleAPIName, string fileId)
{
//example
//string moduleAPIName = "Leads";
//string fileId = "34770616121001";
//Get instance of BulkWriteOperations Class
BulkWriteOperations bulkWriteOperations = new BulkWriteOperations();
//Get instance of RequestWrapper Class that will contain the request body
RequestWrapper requestWrapper = new RequestWrapper();
//Get instance of CallBack Class
CallBack callback = new CallBack();
// To set valid callback URL.
callback.Url = "https://www.example.com/callback";
//To set the HTTP method of the callback URL. The allowed value is post.
callback.Method = new Choice <string>("post");
//The Bulk Write Job's details are posted to this URL on successful completion of job or on failure of job.
requestWrapper.Callback = callback;
//To set the charset of the uploaded file
requestWrapper.CharacterEncoding = "UTF-8";
//To set the type of operation you want to perform on the bulk write job.
requestWrapper.Operation = new Choice <string>("update");
List <Resource> resource = new List <Resource>();
//Get instance of Resource Class
Resource resourceIns = new Resource();
// To set the type of module that you want to import. The value is data.
resourceIns.Type = new Choice <string>("data");
//To set API name of the module that you select for bulk write job.
resourceIns.Module = moduleAPIName;
//To set the file_id obtained from file upload API.
resourceIns.FileId = fileId;
//True - Ignores the empty values.The default value is false.
resourceIns.IgnoreEmpty = true;
// To set a field as a unique field or ID of a record.
resourceIns.FindBy = "Email";
List <FieldMapping> fieldMappings = new List <FieldMapping>();
FieldMapping fieldMapping;
//Get instance of FieldMapping Class
fieldMapping = new FieldMapping();
//To set API name of the field present in Zoho module object that you want to import.
fieldMapping.APIName = "Last_Name";
//To set the column index of the field you want to map to the CRM field.
fieldMapping.Index = 0;
fieldMappings.Add(fieldMapping);
fieldMapping = new FieldMapping();
fieldMapping.APIName = "Email";
fieldMapping.Index = 1;
fieldMappings.Add(fieldMapping);
fieldMapping = new FieldMapping();
fieldMapping.APIName = "Company";
fieldMapping.Index = 2;
fieldMappings.Add(fieldMapping);
fieldMapping = new FieldMapping();
fieldMapping.APIName = "Phone";
fieldMapping.Index = 3;
fieldMappings.Add(fieldMapping);
fieldMapping = new FieldMapping();
fieldMapping.APIName = "Website";
//fieldMapping.Format = "";
//fieldMapping.FindBy = "";
Dictionary <string, object> defaultValue = new Dictionary <string, object>();
defaultValue.Add("value", "https://www.zohoapis.com");
//To set the default value for an empty column in the uploaded file.
fieldMapping.DefaultValue = defaultValue;
fieldMappings.Add(fieldMapping);
resourceIns.FieldMappings = fieldMappings;
resource.Add(resourceIns);
requestWrapper.Resource = resource;
//Call CreateBulkWriteJob method that takes RequestWrapper instance as parameter
APIResponse <ActionResponse> response = bulkWriteOperations.CreateBulkWriteJob(requestWrapper);
if (response != null)
{
//Get the status code from response
Console.WriteLine("Status Code: " + response.StatusCode);
//Check if expected response is received
if (response.IsExpected)
{
//Get object from response
ActionResponse actionResponse = response.Object;
//Check if the request is successful
if (actionResponse is SuccessResponse)
{
//Get the received SuccessResponse instance
SuccessResponse successResponse = (SuccessResponse)actionResponse;
//Get the Status
Console.WriteLine("Status: " + successResponse.Status.Value);
//Get the Code
Console.WriteLine("Code: " + successResponse.Code.Value);
Console.WriteLine("Details: ");
//Get the details map
foreach (KeyValuePair <string, object> entry in successResponse.Details)
{
//Get each value in the map
Console.WriteLine(entry.Key + " : " + JsonConvert.SerializeObject(entry.Value));
}
//Get the Message
Console.WriteLine("Message: " + successResponse.Message.Value);
}
//Check if the request returned an exception
else if (actionResponse is APIException)
{
//Get the received APIException instance
APIException exception = (APIException)actionResponse;
//Get the Status
Console.WriteLine("Status: " + exception.Status.Value);
//Get the Code
Console.WriteLine("Code: " + exception.Code.Value);
Console.WriteLine("Details: ");
//Get the details map
foreach (KeyValuePair <string, object> entry in exception.Details)
{
//Get each value in the map
Console.WriteLine(entry.Key + " : " + JsonConvert.SerializeObject(entry.Value));
}
//Get the Message
Console.WriteLine("Message: " + exception.Message.Value);
}
}
else
{ //If response is not as expected
//Get model object from response
Model responseObject = response.Model;
//Get the response object's class
Type type = responseObject.GetType();
//Get all declared fields of the response class
Console.WriteLine("Type is: {0}", type.Name);
PropertyInfo[] props = type.GetProperties();
Console.WriteLine("Properties (N = {0}):", props.Length);
foreach (var prop in props)
{
if (prop.GetIndexParameters().Length == 0)
{
Console.WriteLine("{0} ({1}) : {2}", prop.Name, prop.PropertyType.Name, prop.GetValue(responseObject));
}
else
{
Console.WriteLine("{0} ({1}) : <Indexed>", prop.Name, prop.PropertyType.Name);
}
}
}
}
}