GetHRRequisitionList


Description

Retrieves a list of HR requisition summary objects that meet the specified criteria.

Parameters

Parameter

Type

Description

criteria

HRRequisitionCriteria

The HR requisition criteria object that specifies which HR requisition summaries are to be retrieved.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetHRRequisitionListResult

ArrayOfHRRequisitionSummary

A list of the HR requisition summary objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of HR requsitions with status other than “Closed”. A message box displays the number of requisition summary objects in the list.

 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;
			ListRestrictionOfNullableOfHRRequisitionStatus statusRestriction;
			HRRequisitionCriteria requisitionCriteria;
			HRRequisitionSummary[] requisitionList;

			// 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 criteria object
			statusRestriction = new ListRestrictionOfNullableOfHRRequisitionStatus();
			statusRestriction.NotEqualValue = HRRequisitionStatus.Closed;
			requisitionCriteria = new HRRequisitionCriteria();
			requisitionCriteria.Status = statusRestriction;

			// Get the list of requisition summary objects
			requisitionList = wsDynamicsGP.GetHRRequisitionList(requisitionCriteria, context);

			// Display the number of requisitions that are not closed
			MessageBox.Show("Number of requisiton with status other than Closed: " + 
				requisitionList.Length.ToString());
	}
}
}

 Native endpoint

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

namespace DynamicsGPWebServiceSample
{
	class Program
	{
		static void Main(string[] args)
		{
			CompanyKey companyKey;
			Context context;
			ListRestrictionOfNullableOfHRRequisitionStatus statusRestriction;
			HRRequisitionCriteria requisitionCriteria;
			HRRequisitionSummary[] requisitionList;

			// 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 criteria object
			statusRestriction = new ListRestrictionOfNullableOfHRRequisitionStatus();
			statusRestriction.NotEqualValue = HRRequisitionStatus.Closed;
			requisitionCriteria = new HRRequisitionCriteria();
			requisitionCriteria.Status = statusRestriction;

			// Get the list of requisition summary objects
			requisitionList = wsDynamicsGP.GetHRRequisitionList(requisitionCriteria, context);

			// Display the number of requisitions that are not closed
			MessageBox.Show("Number of requisiton with status other than Closed: " + 
				requisitionList.Length.ToString());

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


Documentation Feedback