GetApplicantReferenceList

Description

Retrieves a list of applicant reference 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 applicant reference objects with a Relationship property of “Coworker”. The total number of applicant reference objects 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;
			ApplicantReferenceSummary[] applicantReferences;
			ApplicantReferenceCriteria applicantReferenceCriteria;
			LikeRestrictionOfString relationshipRestriction;

			// 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 reference objects to retrieve
			relationshipRestriction = new LikeRestrictionOfString();
			relationshipRestriction.Like = "Coworker";
			applicantReferenceCriteria = new ApplicantReferenceCriteria();
			applicantReferenceCriteria.Relationship = relationshipRestriction;

			// Retrieve the list of applicant reference objects
			applicantReferences = wsDynamicsGP.GetApplicantReferenceList(applicantReferenceCriteria, context);

			// Display the number of applicant reference objects matching the criteria
			MessageBox.Show("Total applicants references:" +
				applicantReferences.Length.ToString());
	}
}
}

 Native endpoint

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			ApplicantReferenceSummary[] applicantReferences;
			ApplicantReferenceCriteria applicantReferenceCriteria;
			LikeRestrictionOfstring relationshipRestriction;

			// 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 reference objects to retrieve
			relationshipRestriction = new LikeRestrictionOfstring();
			relationshipRestriction.Like = "Coworker";
			applicantReferenceCriteria = new ApplicantReferenceCriteria();
			applicantReferenceCriteria.Relationship = relationshipRestriction;

			// Retrieve the list of applicant reference objects
			applicantReferences = wsDynamicsGP.GetApplicantReferenceList(applicantReferenceCriteria, context);

			// Display the number of applicant reference objects matching the criteria
			MessageBox.Show("Total applicants references:" +
				applicantReferences.Length.ToString());

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

Documentation Feedback

---