/// <summary>
/// This method is used to download a file.
/// </summary>
/// <param name="id">The ID of the uploaded File.</param>
/// <param name="destinationFolder">The absolute path of the destination folder to store the File</param>
public static void GetFile(string id, string destinationFolder)
{
//example
//string id = "ae9c7cefa418aec1d6a5cc2d7d5e00a54b7563c0dd42b";
//string destinationFolder = "/Users/user_name/Desktop"
//Get instance of FileOperations Class
FileOperations fileOperations = new FileOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.Add(GetFileParam.ID, id);
//Call getFile method that takes paramInstance as parameters
APIResponse <ResponseHandler> response = fileOperations.GetFile(paramInstance);
if (response != null)
{
//Get the status code from response
Console.WriteLine("Status Code: " + response.StatusCode);
if (new List <int>()
{
204, 304
}.Contains(response.StatusCode))
{
Console.WriteLine(response.StatusCode == 204? "No Content" : "Not Modified");
return;
}
//Check if expected response is received
if (response.IsExpected)
{
//Get object from response
ResponseHandler responseHandler = response.Object;
if (responseHandler is FileBodyWrapper)
{
//Get object from response
FileBodyWrapper fileBodyWrapper = (FileBodyWrapper)responseHandler;
//Get StreamWrapper instance from the returned FileBodyWrapper instance
StreamWrapper streamWrapper = fileBodyWrapper.File;
Stream file = streamWrapper.Stream;
string fullFilePath = Path.Combine(destinationFolder, streamWrapper.Name);
using (FileStream outputFileStream = new FileStream(fullFilePath, FileMode.Create))
{
file.CopyTo(outputFileStream);
}
}
//Check if the request returned an exception
else if (responseHandler is APIException)
{
//Get the received APIException instance
APIException exception = (APIException)responseHandler;
//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;
if (responseObject != null)
{
//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);
}
}
}
}
}
}
/// <summary>
/// This method is used to upload the brand logo or image of the organization and print the response.
/// </summary>
/// <param name="absoluteFilePath">The absolute file path of the file to be attached</param>
public static void UploadOrganizationPhoto(string absoluteFilePath)
{
//example
//string absoluteFilePath = "/Users/user_name/Desktop/download.png";
//Get instance of OrgOperations Class
OrgOperations orgOperations = new OrgOperations();
//Get instance of FileBodyWrapper class that will contain the request file
FileBodyWrapper fileBodyWrapper = new FileBodyWrapper();
//Get instance of StreamWrapper class that takes absolute path of the file to be attached as parameter
StreamWrapper streamWrapper = new StreamWrapper(absoluteFilePath);
//Set file to the FileBodyWrapper instance
fileBodyWrapper.File = streamWrapper;
//Call uploadOrganizationPhoto method that takes FileBodyWrapper instance
APIResponse <ActionResponse> response = orgOperations.UploadOrganizationPhoto(fileBodyWrapper);
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: ");
if (successResponse.Details != null)
{
//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: ");
if (exception.Details != null)
{
//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);
}
}
}
}
}
/// <summary>
/// This method is used to upload a CSV file in ZIP format for bulk write API. The response contains the file_id.
/// Use this ID while making the bulk write request.
/// </summary>
/// <param name="orgID">The unique ID (zgid) of your organization obtained through the Organization API.</param>
/// <param name="absoluteFilePath">The absoluteFilePath of the zip file you want to upload.</param>
public static void UploadFile(string orgID, string absoluteFilePath)
{
//example
//string absoluteFilePath = "/Users/user_name/Documents/Leads.zip";
//string orgID = "673573045";
//Get instance of BulkWriteOperations Class
BulkWriteOperations bulkWriteOperations = new BulkWriteOperations();
//Get instance of FileBodyWrapper class that will contain the request file
FileBodyWrapper fileBodyWrapper = new FileBodyWrapper();
//Get instance of StreamWrapper class that takes absolute path of the file to be attached as parameter
StreamWrapper streamWrapper = new StreamWrapper(absoluteFilePath);
//FileInfo fileInfo = new FileInfo(absoluteFilePath);
//Get instance of StreamWrapper class that takes file name and stream of the file to be attached as parameter
//StreamWrapper streamWrapper = new StreamWrapper(fileInfo.Name, fileInfo.OpenRead());
//Set file to the FileBodyWrapper instance
fileBodyWrapper.File = streamWrapper;
//Get instance of HeaderMap Class
HeaderMap headerInstance = new HeaderMap();
//To indicate that this a bulk write operation
headerInstance.Add(UploadFileHeader.FEATURE, "bulk-write");
headerInstance.Add(UploadFileHeader.X_CRM_ORG, orgID);
//Call uploadFile method that takes FileBodyWrapper instance and headerInstance as parameter
APIResponse <ActionResponse> response = bulkWriteOperations.UploadFile(fileBodyWrapper, headerInstance);
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;
if (exception.Status != null)
{
//Get the Status
Console.WriteLine("Status: " + exception.Status.Value);
}
if (exception.Code != null)
{
//Get the Code
Console.WriteLine("Code: " + exception.Code.Value);
}
if (exception.Message != null)
{
//Get the Message
Console.WriteLine("Message: " + exception.Message.Value);
}
Console.WriteLine("Details: ");
if (exception.Details != null)
{
//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));
}
}
if (exception.ErrorMessage != null)
{
//Get the ErrorMessage
Console.WriteLine("ErrorMessage: " + exception.ErrorMessage.Value);
}
//Get the ErrorCode
Console.WriteLine("ErrorCode: " + exception.ErrorCode);
if (exception.XError != null)
{
//Get the XError
Console.WriteLine("XError: " + exception.XError.Value);
}
if (exception.Info != null)
{
//Get the Info
Console.WriteLine("Info: " + exception.Info.Value);
}
if (exception.XInfo != null)
{
//Get the XInfo
Console.WriteLine("XInfo: " + exception.XInfo.Value);
}
//Get the HttpStatus
Console.WriteLine("HttpStatus: " + exception.HttpStatus);
}
}
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);
}
}
}
}
}
/// <summary>
/// This method is used to download the result of the bulk write job as a CSV file.
/// </summary>
/// <param name="downloadUrl">The URL present in the download_url parameter in the response of Get Bulk Write Job Details.</param>
/// <param name="destinationFolder">The absolute path where downloaded file has to be stored.</param>
public static void DownloadBulkWriteResult(string downloadUrl, string destinationFolder)
{
//example
//string downloadUrl = "https://download-accl.zoho.com/v2/crm/6735/bulk-write/347706122009/347706122009.zip";
//string destinationFolder = "/Users/user_name/Documents";
//Get instance of BulkWriteOperations Class
BulkWriteOperations bulkWriteOperations = new BulkWriteOperations();
//Call DownloadBulkWriteResult method that takes downloadUrl as parameter
APIResponse <ResponseHandler> response = bulkWriteOperations.DownloadBulkWriteResult(downloadUrl);
if (response != null)
{
//Get the status code from response
Console.WriteLine("Status Code: " + response.StatusCode);
if (new List <int>()
{
204, 304
}.Contains(response.StatusCode))
{
Console.WriteLine(response.StatusCode == 204? "No Content" : "Not Modified");
return;
}
//Check if expected response is received
if (response.IsExpected)
{
//Get object from response
ResponseHandler responseHandler = response.Object;
if (responseHandler is FileBodyWrapper)
{
//Get object from response
FileBodyWrapper fileBodyWrapper = (FileBodyWrapper)responseHandler;
//Get StreamWrapper instance from the returned FileBodyWrapper instance
StreamWrapper streamWrapper = fileBodyWrapper.File;
Stream file = streamWrapper.Stream;
string fullFilePath = Path.Combine(destinationFolder, streamWrapper.Name);
using (FileStream outputFileStream = new FileStream(fullFilePath, FileMode.Create))
{
file.CopyTo(outputFileStream);
}
}
//Check if the request returned an exception
else if (responseHandler is APIException)
{
//Get the received APIException instance
APIException exception = (APIException)responseHandler;
if (exception.Status != null)
{
//Get the Status
Console.WriteLine("Status: " + exception.Status.Value);
}
if (exception.Code != null)
{
//Get the Code
Console.WriteLine("Code: " + exception.Code.Value);
}
if (exception.Details != null)
{
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));
}
}
if (exception.Message != null)
{
//Get the Message
Console.WriteLine("Message: " + exception.Message.Value);
}
if (exception.XError != null)
{
//Get the Message
Console.WriteLine("XError: " + exception.XError.Value);
}
if (exception.XInfo != null)
{
//Get the Message
Console.WriteLine("XInfo: " + exception.XInfo.Value);
}
if (exception.HttpStatus != null)
{
//Get the Message
Console.WriteLine("Message: " + exception.HttpStatus);
}
}
}
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);
}
}
}
}
}
public static void GetFieldAttachments(string moduleAPIName, long recordId, long fieldsAttachmentId, string destinationFolder)
{
//example
//string moduleAPIName = "Leads";
//long recordId = 34770615177002;
//long attachmentId = 34770615177023;
//string destinationFolder = "/Users/user_name/Desktop";
//Get instance of FieldAttachmentsOperations Class that takes moduleAPIName and recordId and fieldsAttachmentId as parameter
FieldAttachmentsOperations fieldAttachmentsOperations = new FieldAttachmentsOperations(moduleAPIName, recordId, fieldsAttachmentId);
//Call DownloadAttachment method that takes attachmentId as parameters
APIResponse <ResponseHandler> response = fieldAttachmentsOperations.GetFieldAttachments();
if (response != null)
{
//Get the status code from response
Console.WriteLine("Status Code : " + response.StatusCode);
if (response.StatusCode == 204)
{
Console.WriteLine("No Content");
return;
}
//Check if expected response is received
if (response.IsExpected)
{
//Get object from response
ResponseHandler responseHandler = response.Object;
if (responseHandler is FileBodyWrapper)
{
//Get the received FileBodyWrapper instance
FileBodyWrapper fileBodyWrapper = (FileBodyWrapper)responseHandler;
//Get StreamWrapper instance from the returned FileBodyWrapper instance
StreamWrapper streamWrapper = fileBodyWrapper.File;
//Get Stream from the response
Stream file = streamWrapper.Stream;
string fullFilePath = Path.Combine(destinationFolder, streamWrapper.Name);
using (FileStream outputFileStream = new FileStream(fullFilePath, FileMode.Create))
{
file.CopyTo(outputFileStream);
}
}
//Check if the request returned an exception
else if (responseHandler is API.Attachments.APIException)
{
//Get the received APIException instance
API.Attachments.APIException exception = (API.Attachments.APIException)responseHandler;
//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);
}
}
}
}
}