GetSalespersonList

Description

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

Parameters

Parameter	Type	Description
criteria	SalespersonCriteria	A salesperson criteria object that specifies which salesperson summary objects to return.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetSalespersonListResult	ArrayOfSalespersonSummary	The list of salesperson summary objects that match the specified criteria.

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 salesperson summary objects that have a last name property that begins with "M". The salesperson name and sales territory properties from each salesperson summary object are 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;
            SalespersonCriteria salesPersonCriteria;
            SalespersonSummary[] salesPersonSummaries;

            // 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 sales person objects with last name that begins with 'M'
            LikeRestrictionOfString nameRestriction = new LikeRestrictionOfString();
            nameRestriction.Like = "M%";

            // Create the criteria object
            salesPersonCriteria = new SalespersonCriteria();
            salesPersonCriteria.LastName = nameRestriction;

            // Retrieve the list of sales person objects
            salesPersonSummaries = wsDynamicsGP.GetSalespersonList(salesPersonCriteria, context);

            // Display the sales person name and territory for each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (SalespersonSummary a in salesPersonSummaries)
            {
                summaryList.AppendLine("Sales Person: " + a.FirstName + " " + a.LastName
                + "  Sales Territory: " + a.SalesTerritoryKey.Id);
            }
            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;
            SalespersonCriteria salesPersonCriteria;
            SalespersonSummary[] salesPersonSummaries;

            // 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 sales person objects with last name that begins with 'M'
            LikeRestrictionOfstring nameRestriction = new LikeRestrictionOfstring();
            nameRestriction.Like = "M%";

            // Create the criteria object
            salesPersonCriteria = new SalespersonCriteria();
            salesPersonCriteria.LastName = nameRestriction;

            // Retrieve the list of sales person objects
            salesPersonSummaries = wsDynamicsGP.GetSalespersonList(salesPersonCriteria, context);

            // Display the sales person name and territory for each member of the summary object list
            StringBuilder summaryList = new StringBuilder();
            foreach (SalespersonSummary a in salesPersonSummaries)
            {
                summaryList.AppendLine("Sales Person: " + a.FirstName + " " + a.LastName
                + "  Sales Territory: " + a.SalesTerritoryKey.Id);
            }
            MessageBox.Show(summaryList.ToString());

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