DeleteApplicantWorkHistory

Description

Deletes applicant work history information based on a specified key value.

Parameters

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example deletes the specified applicant work history object. To identify the work history object, the applicant work history key specifies the applicant, the sequence number, and the Id value of “Previous employer”.

 Legacy endpoint

using System;
using System.Collections.Generic;
using System.Text;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			ApplicantKey applicantKey;
			SequenceKey sequenceKey;
			ApplicantSequenceKey applicantSequenceKey;
			ApplicantWorkHistoryKey applicantWorkHistoryKey;
			Policy applicantWorkHistoryDeletePolicy;

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

			// Get the update policy for applicant work history objects
			applicantWorkHistoryDeletePolicy = wsDynamicsGP.GetPolicyByOperation(
				"DeleteApplicantWorkHistory", context);

			// Delete the work history object for the specified applicant
			wsDynamicsGP.DeleteApplicantWorkHistory(applicantWorkHistoryKey, 
				context, applicantWorkHistoryDeletePolicy);
	}
}
}

 Native endpoint

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			ApplicantKey applicantKey;
			SequenceKey sequenceKey;
			ApplicantSequenceKey applicantSequenceKey;
			ApplicantWorkHistoryKey applicantWorkHistoryKey;
			Policy applicantWorkHistoryDeletePolicy;

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

			// Get the update policy for applicant work history objects
			applicantWorkHistoryDeletePolicy = wsDynamicsGP.GetPolicyByOperation(
				"DeleteApplicantWorkHistory", context);

			// Delete the work history object for the specified applicant
			wsDynamicsGP.DeleteApplicantWorkHistory(applicantWorkHistoryKey, 
				context, applicantWorkHistoryDeletePolicy);

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

Documentation Feedback

---