GetApplicantTestByKey

Description

Retrieves a single applicant test object based on the key value supplied.

Parameters

Parameter	Type	Description
key	ApplicantTestKey	The applicant test key object that specifies the applicant test object to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetApplicantTestByKeyResult	ApplicantTest	An applicant test object.

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the applicant test object with the specified applicant test key. The notes for the specified applicant test object are 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;
            ApplicantKey applicantKey;
            SequenceKey sequenceKey;
            ApplicantSequenceKey applicantSequenceKey;
            TestKey testKey;
            ApplicantTest applicantTest;
            ApplicantTestKey applicantTestKey;

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

            // Create an applicant key
            applicantKey = new ApplicantKey();
            applicantKey.Id = 1;

            // Create a sequence key
            sequenceKey = new SequenceKey();
            sequenceKey.Id = 1;

            // Create an applicant sequence key
            applicantSequenceKey = new ApplicantSequenceKey();
            applicantSequenceKey.ApplicantKey = applicantKey;
            applicantSequenceKey.SequenceKey = sequenceKey;

            // Create a test key
            testKey = new TestKey();
            testKey.Id = "TEST1";

            // Create an applicant test key
            applicantTestKey = new ApplicantTestKey();
            applicantTestKey.ApplicantSequenceKey = applicantSequenceKey;
            applicantTestKey.TestKey = testKey;

            // Retrieve the applicant test object
            applicantTest = wsDynamicsGP.GetApplicantTestByKey(applicantTestKey, context);

            // Display the notes property of the specified applicant test object
            MessageBox.Show(applicantTest.Notes);
        }
    }
}

** 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;
            ApplicantKey applicantKey;
            SequenceKey sequenceKey;
            ApplicantSequenceKey applicantSequenceKey;
            TestKey testKey;
            ApplicantTest applicantTest;
            ApplicantTestKey applicantTestKey;

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

            // Create an applicant key
            applicantKey = new ApplicantKey();
            applicantKey.Id = 1;

            // Create a sequence key
            sequenceKey = new SequenceKey();
            sequenceKey.Id = 1;

            // Create an applicant sequence key
            applicantSequenceKey = new ApplicantSequenceKey();
            applicantSequenceKey.ApplicantKey = applicantKey;
            applicantSequenceKey.SequenceKey = sequenceKey;

            // Create a test key
            testKey = new TestKey();
            testKey.Id = "TEST1";

            // Create an applicant test key
            applicantTestKey = new ApplicantTestKey();
            applicantTestKey.ApplicantSequenceKey = applicantSequenceKey;
            applicantTestKey.TestKey = testKey;

            // Retrieve the applicant test object
            applicantTest = wsDynamicsGP.GetApplicantTestByKey(applicantTestKey, context);

            // Display the notes property of the specified applicant test object
            MessageBox.Show(applicantTest.Notes);

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