DeleteApplicantReference

Description

Deletes applicant reference information based on the key value supplied.

Parameters

Parameter	Type	Description
businessObjectKey	ApplicantReferenceKey	The applicant reference key object that specifies the applicant reference 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

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example deletes the applicant reference object with a key that has an applicant key value of "1", a sequence key value of "2", and an applicant reference key Id of "Test reference".

** 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;
            ApplicantReferenceKey applicantReferenceKey;
            Policy applicantReferenceDeletePolicy;

            // 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";

            // Get the delete policy for the applicant reference objects
            applicantReferenceDeletePolicy = wsDynamicsGP.GetPolicyByOperation(
                "DeleteApplicantReference", context);

            // Delete the applicant reference object
            wsDynamicsGP.DeleteApplicantReference(applicantReferenceKey,
            context, applicantReferenceDeletePolicy);
        }
    }
}

** 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;
            SequenceKey sequenceKey;
            ApplicantSequenceKey applicantSequenceKey;
            ApplicantReferenceKey applicantReferenceKey;
            Policy applicantReferenceDeletePolicy;

            // 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";

            // Get the delete policy for the applicant reference objects
            applicantReferenceDeletePolicy = wsDynamicsGP.GetPolicyByOperation(
                "DeleteApplicantReference", context);

            // Delete the applicant reference object
            wsDynamicsGP.DeleteApplicantReference(applicantReferenceKey,
            context, applicantReferenceDeletePolicy);

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