GetEmployeeList

Description

Retrieves a list of employee summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the list of employee summary objects for the employees whose SupervisorID property is "SUPMGR". The total number of employees 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;
            EmployeeCriteria employeeCriteria;
            EmployeeSummary[] employeeSummaryList;
            LikeRestrictionOfString supervisorRestriction;

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

            // Be sure that default credentials are being 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
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Specify the criteria for the employee summaries to retrieve
            supervisorRestriction = new LikeRestrictionOfString();
            supervisorRestriction.Like = "%SUPMGR%";
            employeeCriteria = new EmployeeCriteria();
            employeeCriteria.SupervisorId = supervisorRestriction;

            // Retrieve the list of employee summaries
            employeeSummaryList = wsDynamicsGP.GetEmployeeList(employeeCriteria, context);

            // Display the number of employees matching the criteria
            MessageBox.Show("SUPMGR employees: " + employeeSummaryList.Length.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;
            EmployeeCriteria employeeCriteria;
            EmployeeSummary[] employeeSummaryList;
            LikeRestrictionOfstring supervisorRestriction;

            // 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
            context.OrganizationKey = (OrganizationKey)companyKey;

            // Specify the criteria for the employee summaries to retrieve
            supervisorRestriction = new LikeRestrictionOfstring();
            supervisorRestriction.Like = "%SUPMGR%";
            employeeCriteria = new EmployeeCriteria();
            employeeCriteria.SupervisorId = supervisorRestriction;

            // Retrieve the list of employee summaries
            employeeSummaryList = wsDynamicsGP.GetEmployeeList(employeeCriteria, context);

            // Display the number of employees matching the criteria
            MessageBox.Show("SUPMGR employees: " + employeeSummaryList.Length.ToString());

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