GetChangedInternetAddressKeyList

Description

Retrieves a list of changed Internet address key objects for the Internet addresses that have been acted on during the specified interval. An Internet address has been acted on if it has been created, updated, or deleted. Entity change tracking must be enabled for this method to return valid results.

Parameters

Return Value:

Interfaces

• Dynamics GP

Examples

The following C# example retrieves the list of the changed Internet address key objects that have been acted on during the last week. The list is restricted to Internet addresses for customers. A message box displays the number of each type of Internet address action that was performed.

 Legacy endpoint

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			InternetAddressKeyChangedCriteria internetAddressCriteria;
			ChangedInternetAddressKey[] changedInternetAddressKeyObjects;
			BetweenRestrictionOfNullableOfDateTime restriction;
			BetweenRestrictionOfString addressTypeRestriction;

			// Create an instance of the service
			DynamicsGP wsDynamicsGP = new DynamicsGP();

			// Be sure the default credentials are used
			wsDynamicsGP.UseDefaultCredentials = true;

			// Create a context with which to call the service
			context = new Context();

			// Specify which company to use (sample company)
			companyKey = new CompanyKey();
			companyKey.Id = (-1);

			// Set up the context object
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create the restriction that defines the interval examined for changes
			// The following restriction includes the last week
			restriction = new BetweenRestrictionOfNullableOfDateTime();
			restriction.From = DateTime.Today.Date.AddDays(-7);
			restriction.To = DateTime.Today.Date.AddDays(1);

			// Restrict to just the customers that had Internet address actions
			addressTypeRestriction = new BetweenRestrictionOfString();
			addressTypeRestriction.EqualValue = "CUS";

			// Create the criteria to return Internet address objects that changed
			internetAddressCriteria = new InternetAddressKeyChangedCriteria();
			internetAddressCriteria.LastModifiedDate = restriction;
			internetAddressCriteria.InternetAddressType = addressTypeRestriction;

			// Retrieve the changed Internet Address key objects
			changedInternetAddressKeyObjects = wsDynamicsGP.GetChangedInternetAddressKeyList(internetAddressCriteria, context); 	

			// Display the numbers of Internet addresses that were acted on this week
			int created = 0;
			int updated = 0;
			int deleted = 0;

			foreach (ChangedInternetAddressKey key in changedInternetAddressKeyObjects)
			{
				if (key.Action == DataModificationAction.Created)
					created++;

				if (key.Action == DataModificationAction.Updated)
					updated++;

				if (key.Action == DataModificationAction.Deleted)
					deleted++;
		}

			string message;
			message = "Internet address changes: \n";
			message = message + "Created: " + created.ToString() + "\n";
			message = message + "Updated: " + updated.ToString() + "\n";
			message = message + "Deleted: " + deleted.ToString() + "\n";

			MessageBox.Show(message);
	}
}
}

 Native endpoint

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			InternetAddressKeyChangedCriteria internetAddressCriteria;
			ChangedInternetAddressKey[] changedInternetAddressKeyObjects;
			BetweenRestrictionOfNullableOfdateTime restriction;
			BetweenRestrictionOfstring addressTypeRestriction;

			// Create an instance of the service
			DynamicsGPClient wsDynamicsGP = new DynamicsGPClient();

			// Create a context with which to call the service
			context = new Context();

			// Specify which company to use (sample company)
			companyKey = new CompanyKey();
			companyKey.Id = (-1);

			// Set up the context object
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create the restriction that defines the interval examined for changes
			// The following restriction includes the last week
			restriction = new BetweenRestrictionOfNullableOfdateTime();
			restriction.From = DateTime.Today.Date.AddDays(-7);
			restriction.To = DateTime.Today.Date.AddDays(1);

			// Restrict to just the customers that had Internet address actions
			addressTypeRestriction = new BetweenRestrictionOfstring();
			addressTypeRestriction.EqualValue = "CUS";

			// Create the criteria to return Internet address objects that changed
			internetAddressCriteria = new InternetAddressKeyChangedCriteria();
			internetAddressCriteria.LastModifiedDate = restriction;
			internetAddressCriteria.InternetAddressType = addressTypeRestriction;

			// Retrieve the changed Internet Address key objects
			changedInternetAddressKeyObjects = wsDynamicsGP.GetChangedInternetAddressKeyList(internetAddressCriteria, context); 	

			// Display the numbers of Internet addresses that were acted on this week
			int created = 0;
			int updated = 0;
			int deleted = 0;

			foreach (ChangedInternetAddressKey key in changedInternetAddressKeyObjects)
			{
				if (key.Action == DataModificationAction.Created)
					created++;

				if (key.Action == DataModificationAction.Updated)
					updated++;

				if (key.Action == DataModificationAction.Deleted)
					deleted++;
		}

			string message;
			message = "Internet address changes: \n";
			message = message + "Created: " + created.ToString() + "\n";
			message = message + "Updated: " + updated.ToString() + "\n";
			message = message + "Deleted: " + deleted.ToString() + "\n";

			MessageBox.Show(message);

			// Close the service
			if(wsDynamicsGP.State != CommunicationState.Faulted)
			{
				wsDynamicsGP.Close();
		}
	}
}
}

Documentation Feedback

---