private static void Sample_UpdateUser(ApxWS.ApxWS apxWS)
{
ApxWS.UserQueryOptions qOptions = new ApxWS.UserQueryOptions();
ApxWS.UserQueryResult qResult;
ApxWS.Status qStatus = apxWS.User_GetByLoginName(ref qOptions, "pm", out qResult);
if (qStatus.StatusCode == ApxWS.StatusCodes.Success && qResult.UserList != null && qResult.UserList.Length != 0)
{
ApxWS.User user = qResult.UserList[0];
ApxWS.UserPutOptions pOptions = new ApxWS.UserPutOptions();
user._DBAction = ApxWS.DBAction.Update;
user._UpdatedFields = new ApxWS.UserUpdatedFields();
user._UpdatedFields.EmailAddress = true;
user.EmailAddressIsNull = false;
user.EmailAddress = string.Empty;
ApxWS.UserPutResult pResult;
var status = apxWS.User_Put(ref pOptions, user, out pResult);
user.EmailAddress = "*****@*****.**";
status = apxWS.User_Put(ref pOptions, user, out pResult);
}
}
private static void Sample_Contact(ApxWS.ApxWS apxWS)
{
ApxWS.ContactQueryOptions queryOptions = new ApxWS.ContactQueryOptions();
ApxWS.ContactQueryResult queryResult;
// You must already setup a contact with code "C1"
ApxWS.Status status = apxWS.Contact_GetByContactCode(ref queryOptions, "D0U0100012", out queryResult);
ApxWS.Contact contact = queryResult.ContactList[0];
contact._DBAction = ApxWS.DBAction.Update;
contact._UpdatedFields = new ApxWS.ContactUpdatedFields();
// To clear a string field, set it to an empty string.
contact.LastNameIsNull = false;
contact._UpdatedFields.LastName = true;
contact.LastName = contact.LastName;
ApxWS.ContactPutOptions putOps = new ApxWS.ContactPutOptions();
ApxWS.ContactPutResult putRlt = new ApxWS.ContactPutResult();
status = apxWS.Contact_Put(ref putOps, contact, out putRlt);
if (!status.Success)
{
Console.WriteLine(status.ExceptionText);
}
}
/// <summary>
/// This sample shows how to create a new user
/// </summary>
/// <param name="apxWS"></param>
private static void Sample_CreateNewUser(ApxWS.ApxWS apxWS)
{
string random = string.Format("Test{0}", new Random().Next());
ApxWS.UserQueryOptions queryOptions = new ApxWS.UserQueryOptions();
ApxWS.UserQueryResult queryResult;
ApxWS.Status status = apxWS.User_GetAll(ref queryOptions, out queryResult);
ApxWS.UserPutOptions putOps = new ApxWS.UserPutOptions();
ApxWS.UserPutResult putRlt;
ApxWS.User user = new ApxWS.User();
user._DBAction = ApxWS.DBAction.Insert;
user._UpdatedFields = new ApxWS.UserUpdatedFields();
#region updated fields
user._UpdatedFields.LastName = true;
user.LastNameIsNull = false;
user.LastName = random;
user._UpdatedFields.LoginName = true;
user.LoginNameIsNull = false;
user.LoginName = random;
user._UpdatedFields.IsActive = true;
user.IsActive = true;
user._UpdatedFields.IsOSLogin = true;
user.IsOSLogin = false;
user.IsOSLoginIsNull = false;
user._UpdatedFields.AccessAllUserGroups = true;
user.AccessAllUserGroups = true;
user._UpdatedFields.AccessAllUsersRoleID = true;
user.AccessAllUsersRoleID = "Portfolio Manager";
user.AccessAllUsersRoleIDIsNull = false;
user._UpdatedFields.CanAccessAllUsersPrivateData = true;
user.CanAccessAllUsersPrivateData = true;
user.CanAccessAllUsersPrivateDataIsNull = false;
user._UpdatedFields.DefaultRoleID = true;
user.DefaultRoleID = "Portfolio Manager";
user._UpdatedFields.PrivateDataRoleId = true;
user.PrivateDataRoleId = "Portfolio Manager";
user.PrivateDataRoleIdIsNull = false;
#endregion
status = apxWS.User_Put(ref putOps, user, out putRlt);
user._UpdatedFields.EmailAddress = true;
user.EmailAddressIsNull = false;
user.EmailAddress = random + "@advent.com";
status = apxWS.User_Put(ref putOps, user, out putRlt);
}
/// <summary>
/// This sample shows how to create a new activity
/// </summary>
/// <param name="apxWS"></param>
private static void Sample_CreateNewActivity(ApxWS.ApxWS apxWS)
{
ApxWS.Activity email = new ApxWS.Activity();
email._DBAction = ApxWS.DBAction.Insert;
email._UpdatedFields = new ApxWS.ActivityUpdatedFields();
email.ActivityTypeID = "Email";
email._UpdatedFields.ActivityTypeID = true;
email.OwnerCode = "api";
email.OwnerCodeIsNull = false;
email._UpdatedFields.OwnerCode = true;
email.EmailSenderAddress = "*****@*****.**";
email.EmailSenderAddressIsNull = false;
email._UpdatedFields.EmailSenderAddress = true;
email.EmailRecipientListTo = "[email protected];[email protected]";
email.EmailRecipientListToIsNull = false;
email._UpdatedFields.EmailRecipientListTo = true;
email.EmailRecipientListCC = "[email protected];[email protected]";
email.EmailRecipientListCCIsNull = false;
email._UpdatedFields.EmailRecipientListCC = true;
email.EmailRecipientListBCC = "[email protected];[email protected]";
email.EmailRecipientListBCCIsNull = false;
email._UpdatedFields.EmailRecipientListBCC = true;
email.EmailSubject = "subject";
email.EmailSubjectIsNull = false;
email._UpdatedFields.EmailSubject = true;
email.EmailBodyText = "body text";
email.EmailBodyTextIsNull = false;
email._UpdatedFields.EmailBodyText = true;
email.EmailSentTime = "2015-12-10 18:00:00Z";
email.EmailSentTimeIsNull = false;
email._UpdatedFields.EmailSentTime = true;
email.EmailReceivedTime = "2015-12-10 18:01:00Z";
email.EmailReceivedTimeIsNull = false;
email._UpdatedFields.EmailReceivedTime = true;
ApxWS.ActivityPutOptions ops = new ApxWS.ActivityPutOptions();
ApxWS.ActivityPutResult pResult;
ApxWS.Status status = apxWS.Activity_Put(ref ops, email, out pResult);
}
private static void Sample_DeleteUser(ApxWS.ApxWS apxWS)
{
ApxWS.UserQueryOptions qOptions = new ApxWS.UserQueryOptions();
ApxWS.UserQueryResult qResult;
ApxWS.Status qStatus = apxWS.User_GetByLoginName(ref qOptions, "test", out qResult);
if (qStatus.StatusCode == ApxWS.StatusCodes.Success && qResult.UserList != null && qResult.UserList.Length != 0)
{
ApxWS.User user = qResult.UserList[0];
ApxWS.UserPutOptions pOptions = new ApxWS.UserPutOptions();
user._DBAction = ApxWS.DBAction.Delete;
ApxWS.UserPutResult pResult;
apxWS.User_Put(ref pOptions, user, out pResult);
}
}
/// <summary>
/// Create an instance of ApxWS based on existing login session
/// </summary>
/// <param name="authenticate">AuthenticateWS instance with login session</param>
/// <returns>ApxWS instance</returns>
private ApxWS.ApxWS CreateApxWSInstance(AuthenticateWS.AuthenticateWS authenticateWS)
{
ApxWS.ApxWS apxws = null;
if (authenticateWS.Login())
{
apxws = new ApxWS.ApxWS();
apxws.UseDefaultCredentials = authenticateWS.UseDefaultCredentials;
apxws.CookieContainer = authenticateWS.CookieContainer;
this.ResolveServiceUrl(apxws);
}
else
{
throw new Exception("Autentication Falis.");
}
return(apxws);
}
/// <summary>
/// This sample shows how to add a new interested party to contact
/// </summary>
/// <param name="apxWS"></param>
private static void Sample_AddNewInterestedParty(ApxWS.ApxWS apxWS)
{
ApxWS.ContactQueryOptions queryOptions = new ApxWS.ContactQueryOptions();
queryOptions.IncludeInterestedPartyList = true;
ApxWS.ContactQueryResult queryResult;
// You must already setup a contact with code "C1"
ApxWS.Status status = apxWS.Contact_GetByContactCode(ref queryOptions, "C1", out queryResult);
ApxWS.Contact contact = queryResult.ContactList[0];
ApxWS.ContactPutOptions putOptions = new ApxWS.ContactPutOptions();
ApxWS.ContactPutResult putResult;
contact._DBAction = ApxWS.DBAction.Update;
contact._UpdatedFields = new ApxWS.ContactUpdatedFields();
// Create a list of InterestedParty and copy all existing interested parities to the list.
ApxWS.InterestedParty[] ipList = new ApxWS.InterestedParty[contact.InterestedPartyList.Length + 1];
for (int i = 0; i < contact.InterestedPartyList.Length; i++)
{
ipList[i] = contact.InterestedPartyList[i];
}
// Create a new interested party.
ApxWS.InterestedParty ip = new ApxWS.InterestedParty();
ip._DBAction = ApxWS.DBAction.Merge;
// You must already setup the portfolio with code "P1"
ip.PortfolioCode = "P1";
// Contact code must be same as what you used above.
ip.ContactCode = "C1";
// Add the new interested party to the end of list.
ipList[ipList.Length - 1] = ip;
contact._IncludesInterestedPartyList = true;
contact.InterestedPartyList = ipList;
status = apxWS.Contact_Put(ref putOptions, contact, out putResult);
}
/// <summary>
/// This sample include 3 cases for Salentica
/// Case 1: Change default address from Home to Business
/// Case 2: Update Home address line 2 to a new value "abc"
/// Case 3: Clear Business address line 3
/// </summary>
/// <param name="apxWS"></param>
private static void Sample_ContactAddress(ApxWS.ApxWS apxWS)
{
ApxWS.ContactQueryOptions queryOptions = new ApxWS.ContactQueryOptions();
// To return addresses along with contact, you must set this field to true
queryOptions.IncludeContactAddressList = true;
ApxWS.ContactQueryResult queryResult;
// Get a contact by contact code
ApxWS.Status status = apxWS.Contact_GetByContactCode(ref queryOptions, "C1", out queryResult);
if (status.Success)
{
ApxWS.Contact contact = queryResult.ContactList[0];
contact._DBAction = ApxWS.DBAction.Update;
contact._UpdatedFields = new ApxWS.ContactUpdatedFields();
foreach (ApxWS.ContactAddress address in contact.ContactAddressList)
{
#region Case 1: Change default address from Home to Business
// Assumption: default address was Home address
if (address.AddressLabel == "Home")
{
// this is to indicate that Home address is to be updated
address._DBAction = ApxWS.DBAction.Update;
// this is to indicate that IsDefaultAddress is not null
address.IsDefaultAddressIsNull = false;
// this is to indicate that IsDefaultAddress is to be updated
address._UpdatedFields.IsDefaultAddress = true;
// this is to set IsDefault Address to false
address.IsDefaultAddress = false;
#region Case 2: Update Home address line 2 to a new value "abc"
// this is to set new value to AddressLine2
address.AddressLine2 = "abc";
// this is to indicate that AddressLine2 is to be updated
address._UpdatedFields.AddressLine2 = true;
#endregion
}
//Assumption: new default address is Business address
if (address.AddressLabel == "Business")
{
// this is to indicate that Business address is to be updated
address._DBAction = ApxWS.DBAction.Update;
// this is to indicate that IsDefaultAddress is not null
address.IsDefaultAddressIsNull = false;
// this is to indicate that IsDefaultAddress is to be updated
address._UpdatedFields.IsDefaultAddress = true;
// this is to set IsDefault Address to true
address.IsDefaultAddress = true;
#region Case 3: Clear Business address line 3
// this is to set new value to AddressLine2
address.AddressLine3 = string.Empty;
// this is to indicate that AddressLine2 is to be updated
address._UpdatedFields.AddressLine3 = true;
#endregion
}
#endregion
}
ApxWS.ContactPutOptions putOps = new ApxWS.ContactPutOptions();
ApxWS.ContactPutResult putRlt = new ApxWS.ContactPutResult();
status = apxWS.Contact_Put(ref putOps, contact, out putRlt);
if (!status.Success)
{
Console.WriteLine(status.ExceptionText);
}
}
}
/// <summary>
/// This sample shows how to clear fields
/// </summary>
/// <param name="apxWS"></param>
private static void Sample_ClearContactFields(ApxWS.ApxWS apxWS)
{
ApxWS.ContactQueryOptions queryOptions = new ApxWS.ContactQueryOptions();
ApxWS.ContactQueryResult queryResult;
// You must already setup a contact with code "C1"
ApxWS.Status status = apxWS.Contact_GetByContactCode(ref queryOptions, "C1", out queryResult);
ApxWS.Contact contact = queryResult.ContactList[0];
contact._DBAction = ApxWS.DBAction.Update;
contact._UpdatedFields = new ApxWS.ContactUpdatedFields();
// To clear a string field, set it to an empty string.
contact.LastNameIsNull = false;
contact._UpdatedFields.LastName = true;
contact.LastName = ""; // Or contact.LastName = String.Empty
// To clear a date field, set it to the specific date "1/1/1753".
contact.BirthdateIsNull = false;
contact._UpdatedFields.Birthdate = true;
contact.Birthdate = "1/1/1753 08:00:00Z"; // You must use UTC time here.
// To clear a numeric field, set it to an invalid value.
// For example, CallInterval must be a positive number between 0 and 32767, then -1 is invalid.
contact.CallIntervalIsNull = false;
contact._UpdatedFields.CallInterval = true;
contact.CallInterval = -1;
// To clear a numeric field that allows both positive and nagative values, set it to 0 will clear this field.
contact.TaxBracketIsNull = false;
contact._UpdatedFields.TaxBracket = true;
contact.TaxBracket = 0;
foreach (ApxWS.ApiCustomField field in contact.ContactCustomFields)
{
// You must already setup and activate a custom field in Date type
if (string.Equals(field.Tag, "DateField", StringComparison.CurrentCultureIgnoreCase))
{
// To clear a custom date field, set it to the specific date "1/1/1753".
field.UpdatedField = true;
field.ValueIsNull = false;
field.Value = "1/1/1753 08:00:00z"; // You must use UTC time here.
}
// You must already setup and activate a custom field in Text type
if (string.Equals(field.Tag, "TextField", StringComparison.CurrentCultureIgnoreCase))
{
// To clear a custom string field, set it to an empty string.
field.UpdatedField = true;
field.ValueIsNull = false;
field.Value = ""; // // Or field.Value = String.Empty
}
// You must already setup and activate a custom field in Numeric type
if (string.Equals(field.Tag, "numField", StringComparison.CurrentCultureIgnoreCase))
{
Console.WriteLine("numField: {0}", field.Value);
// To clear a custom numeric field, set it to -1.0E300.
field.UpdatedField = true;
field.ValueIsNull = false;
field.Value = "-1.0E300"; // clear Numeric field
}
}
ApxWS.ContactPutOptions putOps = new ApxWS.ContactPutOptions();
ApxWS.ContactPutResult putRlt = new ApxWS.ContactPutResult();
status = apxWS.Contact_Put(ref putOps, contact, out putRlt);
if (!status.Success)
{
Console.WriteLine(status.ExceptionText);
}
}
