Description
Deletes an applicant based on the key value supplied.
Parameters
Parameter |
Type |
Description |
|---|---|---|
businessObjectKey |
The applicant key object that specifies the applicant to delete. |
|
context |
Specifies information about how the method will be called. |
|
policy |
Specifies the set of behaviors and behavior options to be applied during the operation. |
Interfaces
- Dynamics GP
- Human Resources/Payroll
Examples
The following C# example deletes the applicant with the key value "1".
** 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;
Policy applicantDeletePolicy;
// 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;
// Get the delete policy for the applicant
applicantDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteApplicant", context);
// Delete the applicant
wsDynamicsGP.DeleteApplicant(applicantKey, context, applicantDeletePolicy);
}
}
}
** Native endpoint **
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using DynamicsGPWebServiceSample.DynamicsGPService;
namespace DynamicsGPWebServiceSample
{
class Program
{
static void Main(string[] args)
{
CompanyKey companyKey;
Context context;
ApplicantKey applicantKey;
Policy applicantDeletePolicy;
// 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;
// Get the delete policy for the applicant
applicantDeletePolicy = wsDynamicsGP.GetPolicyByOperation("DeleteApplicant", context);
// Delete the applicant
wsDynamicsGP.DeleteApplicant(applicantKey, context, applicantDeletePolicy);
// Close the service
if(wsDynamicsGP.State != CommunicationState.Faulted)
{
wsDynamicsGP.Close();
}
}
}
}