DeleteApplicantTest


Description

Deletes applicant test information based on the key value supplied.

Parameters

Parameter

Type

Description

businessObjectKey

ApplicantTestKey

The applicant test key object that specifies the applicant test object to delete.

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 deletes the specified applicant test object. To identify the test object, the applicant test key specifies the applicant, a sequence number, and a test key value of “TEST1”.

 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;
			TestKey testKey;
			ApplicantTestKey applicantTestKey;
			Policy applicantTestDeletePolicy;

			// 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 a test key
			testKey = new TestKey();
			testKey.Id = "NEWTES";

			// Create an applicant test key
			applicantTestKey = new ApplicantTestKey();
			applicantTestKey.ApplicantSequenceKey = applicantSequenceKey;
			applicantTestKey.TestKey = testKey;

			// Get the update policy for applicant test objects
			applicantTestDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteApplicantTest", context);

			// Update the applicant test information
			wsDynamicsGP.DeleteApplicantTest(applicantTestKey, context, applicantTestDeletePolicy);
	}
}
}

 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;
			TestKey testKey;
			ApplicantTestKey applicantTestKey;
			Policy applicantTestDeletePolicy;

			// 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 a test key
			testKey = new TestKey();
			testKey.Id = "NEWTES";

			// Create an applicant test key
			applicantTestKey = new ApplicantTestKey();
			applicantTestKey.ApplicantSequenceKey = applicantSequenceKey;
			applicantTestKey.TestKey = testKey;

			// Get the update policy for applicant test objects
			applicantTestDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteApplicantTest", context);

			// Update the applicant test information
			wsDynamicsGP.DeleteApplicantTest(applicantTestKey, context, applicantTestDeletePolicy);

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


Documentation Feedback