GetCountryRegionCodeList


Description

Retrieves a list of country region code objects that match the specified criteria.

Parameters

Parameter

Type

Description

criteria

CountryRegionCodeCriteria

The country region code criteria object that specifies which country region code objects to return.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetCountryRegionCodeListResult

ArrayOfCountryRegionCode

The list of country region code objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of all country region code objects. The example needs Intrastat tracking enabled and one or more country region codes to be entered. A message box displays the country region code and the description for each object 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;
			LikeRestrictionOfString idRestriction;
			CountryRegionCodeCriteria countryRegionCodeCriteria;
			CountryRegionCode[] countryRegionCodeList;

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

			// Create the country region code criteria object
			countryRegionCodeCriteria = new CountryRegionCodeCriteria();
			countryRegionCodeCriteria.Id = idRestriction;

			// Retrieve the list of country region code objects that match the criteria
			countryRegionCodeList = wsDynamicsGP.GetCountryRegionCodeList(
			countryRegionCodeCriteria, context);

			// Display the country region code and description for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (CountryRegionCode a in countryRegionCodeList)
			{
				summaryList.AppendLine("Country region code: " + a.Key.Id + "  Description: " +
				a.Description);
		}
			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 idRestriction;
			CountryRegionCodeCriteria countryRegionCodeCriteria;
			CountryRegionCode[] countryRegionCodeList;

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

			// Create the country region code criteria object
			countryRegionCodeCriteria = new CountryRegionCodeCriteria();
			countryRegionCodeCriteria.Id = idRestriction;

			// Retrieve the list of country region code objects that match the criteria
			countryRegionCodeList = wsDynamicsGP.GetCountryRegionCodeList(
			countryRegionCodeCriteria, context);

			// Display the country region code and description for each member of the summary object list
			StringBuilder summaryList = new StringBuilder();
			foreach (CountryRegionCode a in countryRegionCodeList)
			{
				summaryList.AppendLine("Country region code: " + a.Key.Id + "  Description: " +
				a.Description);
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback