GetApplicantReferenceByKey


Description

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

Parameters

Parameter

Type

Description

key

ApplicantReferenceKey

The applicant reference key object that specifies the applicant reference object to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetApplicantReferenceByKeyResult

ApplicantReference

An applicant reference object.


Interfaces

 

Examples

The following C# example retrieves the applicant reference object with the specifed application reference key. The relationship of the applicant reference 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;
			ApplicantReference applicantReference;
			ApplicantKey applicantKey;
			SequenceKey sequenceKey;
			ApplicantSequenceKey applicantSequenceKey;
			ApplicantReferenceKey applicantReferenceKey;

			// 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 = 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 applicant reference object
			applicantReference = wsDynamicsGP.GetApplicantReferenceByKey(applicantReferenceKey, context);

			// Display the relationship property of the specified applicant reference object
			MessageBox.Show(applicantReference.Relationship);
	}
}
}

 Native endpoint

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows.Forms;
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;

			// 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 = 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 applicant reference object
			applicantReference = wsDynamicsGP.GetApplicantReferenceByKey(applicantReferenceKey, context);

			// Display the relationship property of the specified applicant reference object
			MessageBox.Show(applicantReference.Relationship);

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


Documentation Feedback