GetApplicantApplicationList

Description

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

Parameters

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

Return Value:

Value	Type	Description
GetApplicantApplicationListResult	ArrayOfApplicantApplicationSummary	The list of applicant application summary objects that match the specified criteria.

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the list of applicant application summary objects for the applicant with an applicant Id value of "1". The total number of applications for the specified applicant 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;
            ApplicantApplicationSummary[] applicantApplicationList;
            ApplicantApplicationCriteria applicantApplicationCriteria;
            LikeRestrictionOfNullableOfInt32 applicantIdRestriction;

            // 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 application objects to retrieve
            applicantIdRestriction = new LikeRestrictionOfNullableOfInt32();
            applicantIdRestriction.EqualValue = 1;
            applicantApplicationCriteria = new ApplicantApplicationCriteria();
            applicantApplicationCriteria.ApplicantKeyId = applicantIdRestriction;

            // Retrieve the list of applications for the specified applicant
            applicantApplicationList = wsDynamicsGP.GetApplicantApplicationList(
                applicantApplicationCriteria, context);

            // Display the number of applications for the applicant
            MessageBox.Show("Total number of applications: " + applicantApplicationList.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;
            ApplicantApplicationSummary[] applicantApplicationList;
            ApplicantApplicationCriteria applicantApplicationCriteria;
            LikeRestrictionOfNullableOfint applicantIdRestriction;

            // 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 application objects to retrieve
            applicantIdRestriction = new LikeRestrictionOfNullableOfint();
            applicantIdRestriction.EqualValue = 1;
            applicantApplicationCriteria = new ApplicantApplicationCriteria();
            applicantApplicationCriteria.ApplicantKeyId = applicantIdRestriction;

            // Retrieve the list of applications for the specified applicant
            applicantApplicationList = wsDynamicsGP.GetApplicantApplicationList(
                applicantApplicationCriteria, context);

            // Display the number of applications for the applicant
            MessageBox.Show("Total number of applications: " + applicantApplicationList.Length.ToString());

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