GetCustomerAddressByKey

Description

Retrieves a single customer address object based on the specified customer address key.

Parameters

Parameter	Type	Description
key	CustomerAddressKey	The customer address key object that specifies the customer address to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetCustomerAddressByKeyResult	CustomerAddress	A customer address object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves the primary address for the customer with the key value "AARONFIT0001". The city from the customer's address is displayed in a message box.

** 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;
            CustomerKey customerKey;
            CustomerAddressKey customerAddressKey;
            CustomerAddress customerAddress;

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

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

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

            // Display the location information for the customer
            MessageBox.Show("City: " + customerAddress.City);
        }
    }
}

** Native endpoint **

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

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

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

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

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

            // Display the location information for the customer
            MessageBox.Show("City: " + customerAddress.City);

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