GetApplicantByKey


Description

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

Parameters

Parameter

Type

Description

key

ApplicantKey

The applicant key object that specifies the applicant to retrieve.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetApplicantByKeyResult

Applicant

An applicant object.


Interfaces

 

Examples

The following C# example retrieves the applicant with the key value “1”. The name of the applicant 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;
			Applicant applicant;
			ApplicantKey applicantKey;

			// Create an instance of the service
			DynamicsGP wsDynamicsGP = new DynamicsGP();

			// Be sure the default credentials are 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 object
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create an applicant key
			applicantKey = new ApplicantKey();
			applicantKey.Id = 1;

			// Retrieve the specified applicant
			applicant = wsDynamicsGP.GetApplicantByKey(applicantKey, context);

			// Display the applicant name
			MessageBox.Show("The name of the specified applicant: " + 
				applicant.FirstName + " " + applicant.LastName);
	}
}
}

 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;
			Applicant applicant;
			ApplicantKey applicantKey;

			// 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 object
			context.OrganizationKey = (OrganizationKey)companyKey;

			// Create an applicant key
			applicantKey = new ApplicantKey();
			applicantKey.Id = 1;

			// Retrieve the specified applicant
			applicant = wsDynamicsGP.GetApplicantByKey(applicantKey, context);

			// Display the applicant name
			MessageBox.Show("The name of the specified applicant: " + 
				applicant.FirstName + " " + applicant.LastName);

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


Documentation Feedback