UpdateApplicantReference

Description

Updates the specified applicant reference object, storing the current values in the database.

Parameters

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the applicant reference object with the specified applicant refernece key. The example updates the value of the company name property. The UpdateApplicantReference operation saves the change.

 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;
			ApplicantReference applicantReference;
			ApplicantKey applicantKey;
			SequenceKey sequenceKey;
			ApplicantSequenceKey applicantSequenceKey;
			ApplicantReferenceKey applicantReferenceKey;
			Policy applicantReferenceUpdatePolicy;

			// 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 DynamicsGPService.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 = 2;

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

			//Create an applicant reference key
			applicantReferenceKey = new ApplicantReferenceKey();
			applicantReferenceKey.ApplicantSequenceKey = applicantSequenceKey;
			applicantReferenceKey.Id = "Test reference";

			// Retrieve the specified applicant reference object
			applicantReference = wsDynamicsGP.GetApplicantReferenceByKey(applicantReferenceKey, context);

			// Change the value of the cmpany name property
			applicantReference.CompanyName = "Company Name";

			// Get the update policy for applicant references
			applicantReferenceUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateApplicantReference", context);

			// Update the applicant reference information
			wsDynamicsGP.UpdateApplicantReference(applicantReference, context, applicantReferenceUpdatePolicy);
	}
}
}

 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;
			ApplicantReference applicantReference;
			ApplicantKey applicantKey;
			SequenceKey sequenceKey;
			ApplicantSequenceKey applicantSequenceKey;
			ApplicantReferenceKey applicantReferenceKey;
			Policy applicantReferenceUpdatePolicy;

			// 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 DynamicsGPService.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 = 2;

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

			//Create an applicant reference key
			applicantReferenceKey = new ApplicantReferenceKey();
			applicantReferenceKey.ApplicantSequenceKey = applicantSequenceKey;
			applicantReferenceKey.Id = "Test reference";

			// Retrieve the specified applicant reference object
			applicantReference = wsDynamicsGP.GetApplicantReferenceByKey(applicantReferenceKey, context);

			// Change the value of the cmpany name property
			applicantReference.CompanyName = "Company Name";

			// Get the update policy for applicant references
			applicantReferenceUpdatePolicy = wsDynamicsGP.GetPolicyByOperation("UpdateApplicantReference", context);

			// Update the applicant reference information
			wsDynamicsGP.UpdateApplicantReference(applicantReference, context, applicantReferenceUpdatePolicy);

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

Documentation Feedback

---