lerocha/sharpforce

Salesforce REST API client for .NET, Mono and Xamarin iOS/Android

Sharpforce - Salesforce REST API client for .NET, Xamarin.iOS and Xamarin.Android

It implements a simple client for the Salesforce REST API targeting multiple platforms (Portable Class Library).

Features

• Supported Platforms: .NET 4 or later, Xamarin iOS, Xamarin Android, Windows Phone 8, Windows 8, and Silverlight 5
• Supported Salesforce APIs: Query, CRUD, Versions, Describe
• Auto-generated C# classes (POCOs) for Salesforce objects

Usage

// Instantiate the client using a RefreshToken
var service = new SalesforceClient("ConsumerKey", "ConsumerSecret", "RefreshToken");

//-----------------------------------------------------------------------------
// Queries
//-----------------------------------------------------------------------------

// Execute a SOQL query
IList<Contact> contacts = service.Query<Contact>("SELECT id, name from Contact");

// Iterate through the records returned.
foreach (Contact account in contacts)
{
	Console.WriteLine(account.Name);
}

//-----------------------------------------------------------------------------
// CRUD Operations
//-----------------------------------------------------------------------------

// Add a new record using anonymous object
var id = service.Add<Contact>(new { FirstName = "John", LastName = "Smith" });

// Add a new record using POCO object
id = service.Add<Contact>(new Contact { FirstName = "John", LastName = "Smith" });

// Read a record
Contact contact = service.Get<Contact>(id);

// Update a record using POCO object (null values are not serialized)
contact = new Contact {Id = id, Email = "jsmith@gmail.com"};
service.Update<Contact>(contact);

// Update a record using anonymous object
service.Update<Contact>(new { Email = "jsmith@yahoo.com" }, id);

// Delete a record
service.Delete<Contact>(id);

//-----------------------------------------------------------------------------
// Error Handling
//-----------------------------------------------------------------------------

try
{
	service.Add<Contact>(new { Name = "Read-only property" });
}
catch (SalesforceException e)
{
	Console.WriteLine("ErrorCode={0}; StatusCode={1}; Message={2}", 
					   e.ErrorCode, e.StatusCode, e.Message);
	// Output:
	// ErrorCode=INVALID_FIELD_FOR_INSERT_UPDATE; 
	// StatusCode=BadRequest; 
	// Message=Unable to create/update fields: Name. Please check the security settings of this field
	//         and verify that it is read/write for your profile or permission set.
	
	// TODO: handle the exception
}