GetApplicantList

Description

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

Parameters

Parameter	Type	Description
criteria	ApplicantCriteria	The applicant criteria object that specifies which applicant summary objects are returned.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetApplicantListResult	ArrayOfApplicantSummary	The list of applicant summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the list of applicant summary objects for the applicants whose FirstName property is "Test". The total number of applicants 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;
            ApplicantSummary[] applicants;
            ApplicantCriteria applicantCriteria;
            LikeRestrictionOfString nameRestriction;

            // 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);

            // Specify the criteria of the applicant summaries to retrieve
            nameRestriction = new LikeRestrictionOfString();
            nameRestriction.Like = "Test";
            applicantCriteria = new ApplicantCriteria();
            applicantCriteria.FirstName = nameRestriction;

            // Retrieve the list of applicant summaries
            applicants = wsDynamicsGP.GetApplicantList(applicantCriteria, context);

            // Display the number of applicants matching the criteria
            MessageBox.Show("Total applicants with First Name equal to Test:" + applicants.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;
            ApplicantSummary[] applicants;
            ApplicantCriteria applicantCriteria;
            LikeRestrictionOfstring nameRestriction;

            // 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);

            // Specify the criteria of the applicant summaries to retrieve
            nameRestriction = new LikeRestrictionOfstring();
            nameRestriction.Like = "Test";
            applicantCriteria = new ApplicantCriteria();
            applicantCriteria.FirstName = nameRestriction;

            // Retrieve the list of applicant summaries
            applicants = wsDynamicsGP.GetApplicantList(applicantCriteria, context);

            // Display the number of applicants matching the criteria
            MessageBox.Show("Total applicants with First Name equal to Test:" + applicants.Length.ToString());

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