UpdateCustomerAddress


Description

Updates the specified customer address object, storing the current values in the database.

Parameters

Parameter

Type

Description

address

CustomerAddress

The customer address object that is being updated.

context

Context

Specifies information about how the method will be called.

policy

Policy

Specifies the set of behaviors and behavior options to be applied during the operation.


Interfaces

 

Examples

The following C# example retrieves and updates the customer address with the customer address key value of “WAREHOUSE” and a vendor key value of “AARONFIT0001”. The update sets the Line2 property to a value of “Receiving Dept.”. The UpdateCustomerAddress operation saves the new address value to the database.

 Legacy endpoint

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			CustomerKey customerKey;
			CustomerAddressKey customerAddressKey;
			CustomerAddress customerAddress;
			Policy customerAddressUpdatePolicy;

			// 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 a customer key to specify the customer
			customerKey = new CustomerKey();
			customerKey.Id = "AARONFIT0001";

			// Create a customer address key object
			customerAddressKey = new CustomerAddressKey();
			customerAddressKey.CustomerKey = customerKey;
			customerAddressKey.Id = "WAREHOUSE";

			// Retrieve the customer address object
			customerAddress = wsDynamicsGP.GetCustomerAddressByKey(customerAddressKey, context);

			// Populate the Line2 property with a new value
			customerAddress.Line2 = "Receiving Dept.";

			// Get the update policy for customer address
			customerAddressUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateCustomerAddress",
			context);

			// Update the customer address
			wsDynamicsGP.UpdateCustomerAddress(customerAddress, context, customerAddressUpdatePolicy);
	}
}
}

 Native endpoint

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			CustomerKey customerKey;
			CustomerAddressKey customerAddressKey;
			CustomerAddress customerAddress;
			Policy customerAddressUpdatePolicy;

			// 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 a customer key to specify the customer
			customerKey = new CustomerKey();
			customerKey.Id = "AARONFIT0001";

			// Create a customer address key object
			customerAddressKey = new CustomerAddressKey();
			customerAddressKey.CustomerKey = customerKey;
			customerAddressKey.Id = "WAREHOUSE";

			// Retrieve the customer address object
			customerAddress = wsDynamicsGP.GetCustomerAddressByKey(customerAddressKey, context);

			// Populate the Line2 property with a new value
			customerAddress.Line2 = "Receiving Dept.";

			// Get the update policy for customer address
			customerAddressUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateCustomerAddress",
			context);

			// Update the customer address
			wsDynamicsGP.UpdateCustomerAddress(customerAddress, context, customerAddressUpdatePolicy);

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


Documentation Feedback