GetVendorPlannedOrderByKey


Description

Retrieves a single vendor planned order object based on the specified planned order key.

Parameters

Parameter

Type

Description

key

PlannedOrderKey

The planned order key object that specifies the vendor planned order object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetVendorPlannedOrderByKeyResult

VendorPlannedOrder

A vendor planned order object.


Interfaces

 

Examples

The following C# example retrieves a vendor planned order object with the key value “PO0001”. A message box displays the quantity to order information for the specified vendor planned order object.

 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;
			PlannedOrder vendorPlannedOrder;
			PlannedOrderKey plannedOrderKey;

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

			// Be sure that 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 vemdor planned order key
			plannedOrderKey = new PlannedOrderKey();
			plannedOrderKey.Id = "PO0001";

			// Get the vendor planned order object
			vendorPlannedOrder = wsDynamicsGP.GetVendorPlannedOrderByKey(plannedOrderKey, context);

			// Display the quantity to order from the vendor planned order
			MessageBox.Show("Quantity to order: " + vendorPlannedOrder.QuantityToOrder.Value.ToString());
	}
}
}

 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;
			PlannedOrder vendorPlannedOrder;
			PlannedOrderKey plannedOrderKey;

			// 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 vemdor planned order key
			plannedOrderKey = new PlannedOrderKey();
			plannedOrderKey.Id = "PO0001";

			// Get the vendor planned order object
			vendorPlannedOrder = wsDynamicsGP.GetVendorPlannedOrderByKey(plannedOrderKey, context);

			// Display the quantity to order from the vendor planned order
			MessageBox.Show("Quantity to order: " + vendorPlannedOrder.QuantityToOrder.Value.ToString());

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


Documentation Feedback