DeleteVendorAddress


Description

Deletes a vendor address based on the key value supplied.

Parameters

Parameter

Type

Description

key

VendorAddressKey

The vendor address key that specifies the vendor 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 vendor address for the vendor "ACETRAVE0001"and the vendor address Id of “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;
			VendorKey vendorKey;
			VendorAddressKey vendorAddressKey;
			Policy vendorAddressDeletePolicy;

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

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

			// Create a vendor key and specify the vendor
			vendorKey = new VendorKey();
			vendorKey.Id = "ACETRAVE0001";

			// Create the vendor address key object
			vendorAddressKey = new VendorAddressKey();
			vendorAddressKey.VendorKey = vendorKey;
			vendorAddressKey.Id = "TEST ADDRESS";

			// Get the delete policy for vendor address objects
			vendorAddressDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteVendorAddress", context);

			// Delete the vendor address object
			wsDynamicsGP.DeleteVendorAddress(vendorAddressKey, context, vendorAddressDeletePolicy);
	}
}
}

 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;
			VendorKey vendorKey;
			VendorAddressKey vendorAddressKey;
			Policy vendorAddressDeletePolicy;

			// 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 vendor key and specify the vendor
			vendorKey = new VendorKey();
			vendorKey.Id = "ACETRAVE0001";

			// Create the vendor address key object
			vendorAddressKey = new VendorAddressKey();
			vendorAddressKey.VendorKey = vendorKey;
			vendorAddressKey.Id = "TEST ADDRESS";

			// Get the delete policy for vendor address objects
			vendorAddressDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteVendorAddress", context);

			// Delete the vendor address object
			wsDynamicsGP.DeleteVendorAddress(vendorAddressKey, context, vendorAddressDeletePolicy);

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


Documentation Feedback