GetCustomerByKey


Description

Retrieves a single customer object based on the key value supplied. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter

Type

Description

key

CustomerKey

The customer key object that specifies the customer to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetCustomerByKeyResult

Customer

A customer object.


Interfaces

 

Examples

The following C# example retrieves the customer with the key value “AARONFIT0001”. The name of the customer 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;
			Customer customer;
			CustomerKey customerKey;

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

			// Be sure that default credentials are being 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
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create a customer key
			customerKey = new CustomerKey();
			customerKey.Id = "AARONFIT0001";

			// Retrieve the customer object
			customer = wsDynamicsGP.GetCustomerByKey(customerKey, context);

			MessageBox.Show(customer.Name);
	}
}
}

 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;
			Customer customer;
			CustomerKey customerKey;

			// 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
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create a customer key
			customerKey = new CustomerKey();
			customerKey.Id = "AARONFIT0001";

			// Retrieve the customer object
			customer = wsDynamicsGP.GetCustomerByKey(customerKey, context);

			MessageBox.Show(customer.Name);

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


Documentation Feedback