GetItemWarehouseByKey


Description

Retrieves a single item warehouse object based on the item warehouse key value supplied.

Parameters

Parameter

Type

Description

key

ItemWarehouseKey

An item warehouse key object that specifies the item warehouse object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetItemWarehouseByKeyResult

ItemWarehouse

An item warehouse object.


Interfaces

 

Examples

The following C# example retrieves the item warehouse with an item key value of “128 SDRAM” and a warehouse key value of “North”. The requisitioned quantity value 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;
			ItemKey itemKey;
			WarehouseKey warehouseKey;
			ItemWarehouseKey itemWarehouseKey;
			ItemWarehouse itemWarehouse;

			// 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 item key to specify the item
			itemKey = new ItemKey();
			itemKey.Id = "128 SDRAM";

			// Create a warehouse key to specify the warehouse
			warehouseKey = new WarehouseKey();
			warehouseKey.Id = "North";

			// Create an item warehouse key
			itemWarehouseKey = new ItemWarehouseKey();
			itemWarehouseKey.ItemKey = itemKey;
			itemWarehouseKey.WarehouseKey = warehouseKey;

			// Retrieve the item warehouse object
			itemWarehouse = wsDynamicsGP.GetItemWarehouseByKey(itemWarehouseKey, context);

			// Display the requisitioned amount
			MessageBox.Show("Requisitioned quantity: " +
			itemWarehouse.RequisitionedQuantity.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;
			ItemKey itemKey;
			WarehouseKey warehouseKey;
			ItemWarehouseKey itemWarehouseKey;
			ItemWarehouse itemWarehouse;

			// 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 item key to specify the item
			itemKey = new ItemKey();
			itemKey.Id = "128 SDRAM";

			// Create a warehouse key to specify the warehouse
			warehouseKey = new WarehouseKey();
			warehouseKey.Id = "North";

			// Create an item warehouse key
			itemWarehouseKey = new ItemWarehouseKey();
			itemWarehouseKey.ItemKey = itemKey;
			itemWarehouseKey.WarehouseKey = warehouseKey;

			// Retrieve the item warehouse object
			itemWarehouse = wsDynamicsGP.GetItemWarehouseByKey(itemWarehouseKey, context);

			// Display the requisitioned amount
			MessageBox.Show("Requisitioned quantity: " +
			itemWarehouse.RequisitionedQuantity.Value.ToString()); 

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


Documentation Feedback