CreateApplicant


Description

This method creates a new job applicant.

Parameters

Parameter

Type

Description

businessObject

Applicant

The applicant object being created.

context

Context

Specifies information about how the method will be called.

policy

Policy

Specifies the set of behaviors and behavior options to be applied during the operation.


Interfaces

 

Examples

The following C# example creates a new applicant. The FirstName, LastName, DateApplied, and Applications properties are set. All other properties are left as default values.

 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;
			Applicant applicant;
			ApplicantApplication applicantApplication;
			Policy applicantCreatePolicy;

			// 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 object
			applicant = new Applicant();

			// Populate the required fields of the applicant object
			applicant.FirstName = "Test";
			applicant.LastName = "Applicant";
			applicant.DateApplied = DateTime.Today;

			// Create an applicant application object
			applicantApplication = new ApplicantApplication();

			// Populate the required fields of the applicant application object
			applicantApplication.DateApplied = DateTime.Today;

			// Add the application object to the applicant object
			ApplicantApplication[] applications = {applicantApplication};
			applicant.Applications = applications;

			// Get the create policy for applicants
			applicantCreatePolicy = wsDynamicsGP.GetPolicyByOperation("CreateApplicant", context);

			// Create the applicant
			wsDynamicsGP.CreateApplicant(applicant, context, applicantCreatePolicy);
	}
}
}

 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;
			Applicant applicant;
			ApplicantApplication applicantApplication;
			Policy applicantCreatePolicy;

			// 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 object
			applicant = new Applicant();

			// Populate the required fields of the applicant object
			applicant.FirstName = "Test";
			applicant.LastName = "Applicant";
			applicant.DateApplied = DateTime.Today;

			// Create an applicant application object
			applicantApplication = new ApplicantApplication();

			// Populate the required fields of the applicant application object
			applicantApplication.DateApplied = DateTime.Today;

			// Add the application object to the applicant object
			ApplicantApplication[] applications = {applicantApplication};
			applicant.Applications = applications;

			// Get the create policy for applicants
			applicantCreatePolicy = wsDynamicsGP.GetPolicyByOperation("CreateApplicant", context);

			// Create the applicant
			wsDynamicsGP.CreateApplicant(applicant, context, applicantCreatePolicy);

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


Documentation Feedback