GetServiceEquipmentList

Description

Retrieves a list of service equipment summary objects that match the specified criteria.

Parameters

Return Value:

Interfaces

• Dynamics GP
• Field Service

Examples

The following C# example retrieves the list of service equipment summary objects with a status of “RETURN”. The customer Id and status properties from each service equipment summary object is 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;
			LikeRestrictionOfString statusRestriction;
			ServiceEquipmentCriteria serviceEquipmentCriteria;
			ServiceEquipmentSummary[] serviceEquipmentSummary;

			// 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 restriction object
			// Retrieve service equipment summaries with status of 'RETURN'
			statusRestriction = new LikeRestrictionOfString();
			statusRestriction.EqualValue = "RETURN";

			// Create a service equipment criteria object
			// Retrieve service call summaries with the specified status
			serviceEquipmentCriteria = new ServiceEquipmentCriteria();
			serviceEquipmentCriteria.StatusId = statusRestriction;

			// Retrieve the service equipment summaries specified by the criteria object
			serviceEquipmentSummary = wsDynamicsGP.GetServiceEquipmentList
				(serviceEquipmentCriteria, context);

			// Display the customer Id and status of each member of the object list
			StringBuilder summaryList = new StringBuilder();
			foreach (ServiceEquipmentSummary a in serviceEquipmentSummary)
			{
				summaryList.AppendLine("Customer Id: " + a.CustomerKey.Id + "	Status: " + a.StatusKey.Id);
		}
			MessageBox.Show(summaryList.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;
			LikeRestrictionOfstring statusRestriction;
			ServiceEquipmentCriteria serviceEquipmentCriteria;
			ServiceEquipmentSummary[] serviceEquipmentSummary;

			// 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 restriction object
			// Retrieve service equipment summaries with status of 'RETURN'
			statusRestriction = new LikeRestrictionOfstring();
			statusRestriction.EqualValue = "RETURN";

			// Create a service equipment criteria object
			// Retrieve service call summaries with the specified status
			serviceEquipmentCriteria = new ServiceEquipmentCriteria();
			serviceEquipmentCriteria.StatusId = statusRestriction;

			// Retrieve the service equipment summaries specified by the criteria object
			serviceEquipmentSummary = wsDynamicsGP.GetServiceEquipmentList
				(serviceEquipmentCriteria, context);

			// Display the customer Id and status of each member of the object list
			StringBuilder summaryList = new StringBuilder();
			foreach (ServiceEquipmentSummary a in serviceEquipmentSummary)
			{
				summaryList.AppendLine("Customer Id: " + a.CustomerKey.Id + "	Status: " + a.StatusKey.Id);
		}
			MessageBox.Show(summaryList.ToString());

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

Documentation Feedback

---