Export (0) Print
Expand All
Expand Minimize

GetApplicantWorkHistoryByKey

Description

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

Parameters

Parameter

Type

Description

key

ApplicantWorkHistoryKey

The applicant work history key object that specifies the applicant work history object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetApplicantWorkHistoryByKeyResult

ApplicantWorkHistory

An applicant work history object.


Interfaces

  • Dynamics GP
  • Human Resources/Payroll

Examples

The following C# example retrieves the applicant work history object with the specified applicant work history key. The years of experience for the specified applicant work history object is displayed in a message box.

Ff622647.LegacyEndpoint(en-us,MSDN.10).gif 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;
            ApplicantWorkHistoryKey applicantWorkHistoryKey;
            ApplicantWorkHistory applicantWorkHistory;

            // 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 an applicant work history key
            applicantWorkHistoryKey = new ApplicantWorkHistoryKey();
            applicantWorkHistoryKey.ApplicantSequenceKey = applicantSequenceKey;
            applicantWorkHistoryKey.Id  = "Previous employer";

            // Retrieve the applicant work history object
            applicantWorkHistory = wsDynamicsGP.GetApplicantWorkHistoryByKey(applicantWorkHistoryKey, context);

            // Display the notes property of the specified applicant work history object
            MessageBox.Show("Years of experience for the specified applicant: " +
                applicantWorkHistory.YearsOfExperience.ToString());
        }
    }
}

Ff622647.NativeEndpoint(en-us,MSDN.10).gif 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;
            ApplicantWorkHistoryKey applicantWorkHistoryKey;
            ApplicantWorkHistory applicantWorkHistory;

            // 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 an applicant work history key
            applicantWorkHistoryKey = new ApplicantWorkHistoryKey();
            applicantWorkHistoryKey.ApplicantSequenceKey = applicantSequenceKey;
            applicantWorkHistoryKey.Id  = "Previous employer";

            // Retrieve the applicant work history object
            applicantWorkHistory = wsDynamicsGP.GetApplicantWorkHistoryByKey(applicantWorkHistoryKey, context);

            // Display the notes property of the specified applicant work history object
            MessageBox.Show("Years of experience for the specified applicant: " +
                applicantWorkHistory.YearsOfExperience.ToString());

            // Close the service
            if(wsDynamicsGP.State != CommunicationState.Faulted)
            {
                wsDynamicsGP.Close();
            }
        }
    }
}
Show:
© 2015 Microsoft