GetApplicantTestList


Description

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

Parameters

Parameter

Type

Description

criteria

ApplicantTestCriteria

The applicant test criteria object that specifies which applicant test objects are returned.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetApplicantTestListResult

ArrayOfApplicantTest

The list of applicant test objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of applicant test objects for the applicant with the Id of “1”. The total number of applicant tests 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;
			ApplicantTest[] applicantTests;
			ApplicantTestCriteria applicantTestCriteria;
			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 test objects to retrieve
			applicantIdRestriction = new LikeRestrictionOfNullableOfInt32();
			applicantIdRestriction.EqualValue = 1;
			applicantTestCriteria = new ApplicantTestCriteria();
			applicantTestCriteria.ApplicantKeyId = applicantIdRestriction;

			// Retrieve the list of applicant test objects
			applicantTests = wsDynamicsGP.GetApplicantTestList(applicantTestCriteria, context);

			// Display the number of applicant test objects matching the criteria
			MessageBox.Show("The number of job tests associated with the applicant: " +
				applicantTests.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;
			ApplicantTest[] applicantTests;
			ApplicantTestCriteria applicantTestCriteria;
			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 test objects to retrieve
			applicantIdRestriction = new LikeRestrictionOfNullableOfint();
			applicantIdRestriction.EqualValue = 1;
			applicantTestCriteria = new ApplicantTestCriteria();
			applicantTestCriteria.ApplicantKeyId = applicantIdRestriction;

			// Retrieve the list of applicant test objects
			applicantTests = wsDynamicsGP.GetApplicantTestList(applicantTestCriteria, context);

			// Display the number of applicant test objects matching the criteria
			MessageBox.Show("The number of job tests associated with the applicant: " +
				applicantTests.Length.ToString());

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


Documentation Feedback