GetBankList


Description

Retrieves a list of bank objects that match the specified criteria.

Parameters

Parameter

Type

Description

criteria

BankCriteria

The bank criteria object that specifies which bank objects to return.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetBankListResult

ArrayOfBank

The list of bank objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of all bank objects. A message box displays the name and the transit number of each bank 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 bankNameRestriction;
			BankCriteria bankCriteria;
			Bank[] bankList;

			// 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
			// Retrieve all available bank objects
			bankNameRestriction = new LikeRestrictionOfString();
			bankNameRestriction.Like = "%";

			// Create the bank criteria object
			bankCriteria = new BankCriteria();
			bankCriteria.Name = bankNameRestriction;

			// Retrieve the list of bank objects
			bankList = wsDynamicsGP.GetBankList(bankCriteria, context);

			// Display the ID and amount of each member of the object list
			StringBuilder summaryList = new StringBuilder();
			foreach (Bank a in bankList)
			{
				summaryList.AppendLine("Bank name: " + a.Name + "  Transit number: " +
				a.TransitNumber);
		}
			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 bankNameRestriction;
			BankCriteria bankCriteria;
			Bank[] bankList;

			// 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
			// Retrieve all available bank objects
			bankNameRestriction = new LikeRestrictionOfstring();
			bankNameRestriction.Like = "%";

			// Create the bank criteria object
			bankCriteria = new BankCriteria();
			bankCriteria.Name = bankNameRestriction;

			// Retrieve the list of bank objects
			bankList = wsDynamicsGP.GetBankList(bankCriteria, context);

			// Display the ID and amount of each member of the object list
			StringBuilder summaryList = new StringBuilder();
			foreach (Bank a in bankList)
			{
				summaryList.AppendLine("Bank name: " + a.Name + "  Transit number: " +
				a.TransitNumber);
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback