GetApplicantEducationByKey

Description

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

Parameters

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

Return Value:

Value	Type	Description
GetApplicantEducationByKeyResult	ApplicantEducation	An applicant education object.

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the applicant education object with an application key and sequence key value of "1". The school property of the specified applicant education object 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;
            ApplicantEducation applicantEducation;
            ApplicantKey applicantKey;
            SequenceKey sequenceKey;
            ApplicantSequenceKey applicantSequenceKey;

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

            // Retrieve the applicant education object
            applicantEducation = wsDynamicsGP.GetApplicantEducationByKey(applicantSequenceKey, context);

            // Display the school property of the specified applicant education object
            MessageBox.Show(applicantEducation.School);
        }
    }
}

** 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;
            ApplicantEducation applicantEducation;
            ApplicantKey applicantKey;
            SequenceKey sequenceKey;
            ApplicantSequenceKey applicantSequenceKey;

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

            // Retrieve the applicant education object
            applicantEducation = wsDynamicsGP.GetApplicantEducationByKey(applicantSequenceKey, context);

            // Display the school property of the specified applicant education object
            MessageBox.Show(applicantEducation.School);

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