GetItemClassList

Description

Retrieves a list of inventory item class objects that meet the specified criteria.

Parameters

Parameter	Type	Description
criteria	ItemClassCriteria	The item class criteria object that specifies which item class objects to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetItemClassListResult	ArrayOfItemClass	A list of the item class objects that match the specified criteria.

Interfaces

• Dynamics GP
• Inventory

Examples

The following C# example retrieves the list of item classes with an item type equal to "SalesItem". A message box displays the item class description of each member of the list.

** 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;
            ListRestrictionOfNullableOfItemType itemTypeRestriction;
            ItemClassCriteria itemClassCriteria;
            ItemClass[] itemClasses;

            // 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 a restriction object
            // Retrieve item classes with an item type of 'SalesItem'
            itemTypeRestriction = new ListRestrictionOfNullableOfItemType();
            itemTypeRestriction.EqualValue = ItemType.SalesItem;

            // Create a item class criteria object
            itemClassCriteria = new ItemClassCriteria();
            itemClassCriteria.Type = itemTypeRestriction;

            // Retrieve the list of item class objects
            itemClasses = wsDynamicsGP.GetItemClassList(itemClassCriteria, context);

            // Display the item class description of each member of the object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ItemClass a in itemClasses)
            {
                summaryList.AppendLine("Item class: " + a.Description);
            }
            MessageBox.Show(summaryList.ToString());
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            ListRestrictionOfNullableOfItemType itemTypeRestriction;
            ItemClassCriteria itemClassCriteria;
            ItemClass[] itemClasses;

            // 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 restriction object
            // Retrieve item classes with an item type of 'SalesItem'
            itemTypeRestriction = new ListRestrictionOfNullableOfItemType();
            itemTypeRestriction.EqualValue = ItemType.SalesItem;

            // Create a item class criteria object
            itemClassCriteria = new ItemClassCriteria();
            itemClassCriteria.Type = itemTypeRestriction;

            // Retrieve the list of item class objects
            itemClasses = wsDynamicsGP.GetItemClassList(itemClassCriteria, context);

            // Display the item class description of each member of the object list
            StringBuilder summaryList = new StringBuilder();
            foreach (ItemClass a in itemClasses)
            {
                summaryList.AppendLine("Item class: " + a.Description);
            }
            MessageBox.Show(summaryList.ToString());

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