GetSalesTerritoryList


Description

Retrieves a list of sales territory summary objects that match the specified criteria.

Parameters

Parameter

Type

Description

criteria

SalesTerritoryCriteria

A sales territory criteria object that specifies which sales territory summary objects are returned.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetSalesTerritoryListResult

ArrayOfSalesTerritorySummary

The list of sales territory summary objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of all sales territory summary objects. A message box displays the description and the sales manager for each sales territory.

 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;
			SalesTerritoryCriteria territoryCriteria;
			SalesTerritorySummary[] territorySummaries;

			// 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 the restriction object
			LikeRestrictionOfString idRestriction = new LikeRestrictionOfString();
			idRestriction.Like = "%";

			// Create the sales territory criteria object
			territoryCriteria = new SalesTerritoryCriteria();
			territoryCriteria.Id = idRestriction;

			// Retrieve the list of sales territory objects
			territorySummaries = wsDynamicsGP.GetSalesTerritoryList(territoryCriteria, context);

			// Display the territory and sales manager for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesTerritorySummary a in territorySummaries)
			{
				summaryList.AppendLine("Territory: " + a.Description + "   Sales manager: " +
				a.SalesManagerFirstName + " " + a.SalesManagerLastName);
		}
			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;
			SalesTerritoryCriteria territoryCriteria;
			SalesTerritorySummary[] territorySummaries;

			// 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 the restriction object
			LikeRestrictionOfstring idRestriction = new LikeRestrictionOfstring();
			idRestriction.Like = "%";

			// Create the sales territory criteria object
			territoryCriteria = new SalesTerritoryCriteria();
			territoryCriteria.Id = idRestriction;

			// Retrieve the list of sales territory objects
			territorySummaries = wsDynamicsGP.GetSalesTerritoryList(territoryCriteria, context);

			// Display the territory and sales manager for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (SalesTerritorySummary a in territorySummaries)
			{
				summaryList.AppendLine("Territory: " + a.Description + "   Sales manager: " +
				a.SalesManagerFirstName + " " + a.SalesManagerLastName);
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback