DeleteEmployeeAddress


Description

Deletes an employee address based on the key value supplied.

Parameters

Parameter

Type

Description

key

EmployeeAddressKey

The employee address key object that specifies the employee address to delete.

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 deletes the address information for the employee “ACKE0001” where the employee address key Id value is “Test address”.

 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;
			EmployeeKey employeeKey;
			EmployeeAddressKey employeeAddressKey;
			Policy employeeAddressDeletePolicy;

			// 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 an employee key
			employeeKey = new EmployeeKey();
			employeeKey.Id = "ACKE0001";

			// Create an employee address key
			employeeAddressKey = new EmployeeAddressKey();
			employeeAddressKey.EmployeeKey = employeeKey;
			employeeAddressKey.Id = "Test address";

			// Get the delete policy for employee address objects
			employeeAddressDeletePolicy = wsDynamicsGP.GetPolicyByOperation(
				"DeleteEmployeeAddress", context);

			// Delete the specified employee address object
			wsDynamicsGP.DeleteEmployeeAddress(employeeAddressKey, context, employeeAddressDeletePolicy);
	}
}
}

 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;
			EmployeeKey employeeKey;
			EmployeeAddressKey employeeAddressKey;
			Policy employeeAddressDeletePolicy;

			// 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 an employee key
			employeeKey = new EmployeeKey();
			employeeKey.Id = "ACKE0001";

			// Create an employee address key
			employeeAddressKey = new EmployeeAddressKey();
			employeeAddressKey.EmployeeKey = employeeKey;
			employeeAddressKey.Id = "Test address";

			// Get the delete policy for employee address objects
			employeeAddressDeletePolicy = wsDynamicsGP.GetPolicyByOperation(
				"DeleteEmployeeAddress", context);

			// Delete the specified employee address object
			wsDynamicsGP.DeleteEmployeeAddress(employeeAddressKey, context, employeeAddressDeletePolicy);

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


Documentation Feedback