GetHRRequisitionByKey

Description

Retrieves a single HR requisition object based on the key value supplied.

Parameters

Parameter	Type	Description
key	HRRequisitionNumberKey	A HR requisition number key object that specifies the requisition object to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetHRRequisitionByKeyResult	HRRequisition	An HR requisition object.

Interfaces

• Dynamics GP
• Human Resources/Payroll

Examples

The following C# example retrieves the HR requisition with the key value "1". The department and status for the requisition are displayed in a message box.

** Legacy endpoint**

using System;
using System.Collections.Generic;
using System.Text;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            HRRequisitionNumberKey requisitionNumberKey;
            HRRequisition requisition;

            // 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 a requisition number key
            requisitionNumberKey = new HRRequisitionNumberKey();
            requisitionNumberKey.Id = "1";

            // Get the specified requisition object
            requisition = wsDynamicsGP.GetHRRequisitionByKey(requisitionNumberKey, context);

            // Display the status of the requisition
            MessageBox.Show("Department: " + requisition.DepartmentKey.Id + "   Status: " + requisition.Status);
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            HRRequisitionNumberKey requisitionNumberKey;
            HRRequisition requisition;

            // 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 a requisition number key
            requisitionNumberKey = new HRRequisitionNumberKey();
            requisitionNumberKey.Id = "1";

            // Get the specified requisition object
            requisition = wsDynamicsGP.GetHRRequisitionByKey(requisitionNumberKey, context);

            // Display the status of the requisition
            MessageBox.Show("Department: " + requisition.DepartmentKey.Id + "   Status: " + requisition.Status);

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