CreateApplicantReference

Description

This method creates a new applicant reference entry for a specified applicant.

Parameters

Parameter	Type	Description
businessObject	ApplicantReference	The applicant reference 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

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example creates a new applicant reference entry for an applicant. The ApplicantKey property of the ApplicantReferenceKey object specifies the applicant. Use the Id property of the ApplicantReferenceKey to uniquely identify the reference object.

** 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;
            ApplicantReference applicantReference;
            ApplicantKey applicantKey;
            ApplicantSequenceKey applicantSequenceKey;
            ApplicantReferenceKey applicantReferenceKey;
            Policy applicantReferenceCreatePolicy;

            // 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 and applicant key
            applicantKey = new ApplicantKey();
            applicantKey.Id = 1;

            // Create an applicant sequence key object
            applicantSequenceKey = new ApplicantSequenceKey();
            applicantSequenceKey.ApplicantKey = applicantKey;

            // Use the applicant reference key to specify an applicant reference object
            applicantReferenceKey = new ApplicantReferenceKey();
            applicantReferenceKey.ApplicantSequenceKey = applicantSequenceKey;
            applicantReferenceKey.Id = "Test reference";

            // Create an applicant reference object
            applicantReference = new ApplicantReference();

            // Populate the fields of the applicant reference object
            applicantReference.ApplicantReferenceKey = applicantReferenceKey;
            applicantReference.Relationship = "Coworker";

            // Get the create policy for application reference objects
            applicantReferenceCreatePolicy = wsDynamicsGP.GetPolicyByOperation(
                "CreateApplicantReference", context);

            // Create the applicant reference record
            wsDynamicsGP.CreateApplicantReference(applicantReference,
                context, applicantReferenceCreatePolicy);
        }
    }
}

** 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;
            ApplicantReference applicantReference;
            ApplicantKey applicantKey;
            ApplicantSequenceKey applicantSequenceKey;
            ApplicantReferenceKey applicantReferenceKey;
            Policy applicantReferenceCreatePolicy;

            // 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 and applicant key
            applicantKey = new ApplicantKey();
            applicantKey.Id = 1;

            // Create an applicant sequence key object
            applicantSequenceKey = new ApplicantSequenceKey();
            applicantSequenceKey.ApplicantKey = applicantKey;

            // Use the applicant reference key to specify an applicant reference object
            applicantReferenceKey = new ApplicantReferenceKey();
            applicantReferenceKey.ApplicantSequenceKey = applicantSequenceKey;
            applicantReferenceKey.Id = "Test reference";

            // Create an applicant reference object
            applicantReference = new ApplicantReference();

            // Populate the fields of the applicant reference object
            applicantReference.ApplicantReferenceKey = applicantReferenceKey;
            applicantReference.Relationship = "Coworker";

            // Get the create policy for application reference objects
            applicantReferenceCreatePolicy = wsDynamicsGP.GetPolicyByOperation(
                "CreateApplicantReference", context);

            // Create the applicant reference record
            wsDynamicsGP.CreateApplicantReference(applicantReference,
                context, applicantReferenceCreatePolicy);

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