GetBatchList

Description

Retrieves a list of batch objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves the list of batch objects with an ID property that begins with "P". A message box displays the batch name and frequency for each batch in 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;
            LikeRestrictionOfString batchIdRestriction;
            BatchCriteria batchCriteria;
            Batch[] batchList;

            // 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 the restriction object
            // Specify batch objects where the ID property begins with 'P'
            batchIdRestriction = new LikeRestrictionOfString();
            batchIdRestriction.Like = "P%";

            // Create the batch criteria object
            batchCriteria = new BatchCriteria();
            batchCriteria.Id = batchIdRestriction;

            // Retrieve the list of batch objects
            batchList = wsDynamicsGP.GetBatchList(batchCriteria, context); ;

            // Display the batch name and frequency for each member of the object list
            StringBuilder summaryList = new StringBuilder();
            foreach (Batch a in batchList)
            {
                summaryList.AppendLine("Batch: " + a.Key.Id + "  Frequency: " + a.Frequency.ToString());
            }
            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;
            LikeRestrictionOfstring batchIdRestriction;
            BatchCriteria batchCriteria;
            Batch[] batchList;

            // 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 the restriction object
            // Specify batch objects where the ID property begins with 'P'
            batchIdRestriction = new LikeRestrictionOfstring();
            batchIdRestriction.Like = "P%";

            // Create the batch criteria object
            batchCriteria = new BatchCriteria();
            batchCriteria.Id = batchIdRestriction;

            // Retrieve the list of batch objects
            batchList = wsDynamicsGP.GetBatchList(batchCriteria, context); ;

            // Display the batch name and frequency for each member of the object list
            StringBuilder summaryList = new StringBuilder();
            foreach (Batch a in batchList)
            {
                summaryList.AppendLine("Batch: " + a.Key.Id + "  Frequency: " + a.Frequency.ToString());
            }
            MessageBox.Show(summaryList.ToString());

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