GetPaymentCardTypeList


Description

Retrieves a list of payment card type objects that match the specified criteria.

Parameters

Parameter

Type

Description

criteria

PaymentCardTypeCriteria

A payment type card criteria object that specifies which payment card type objects are returned.

context

Context

Specifies information about how the method will be called.


Return Value:

Value

Type

Description

GetPaymentCardTypeListResult

ArrayOfPaymentCardType

The list of payment card type objects that match the specified criteria.


Interfaces

 

Examples

The following C# example retrieves the list of payment card type objects whose Id property ends with “Credit”. The Id property from each payment card type 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 idRestriction;
			PaymentCardTypeCriteria cardCriteria;
			PaymentCardType[] paymentCardTypes;

			// 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 restriction object
			// Retrieve all types that end in 'Credit'
			idRestriction = new LikeRestrictionOfString();
			idRestriction.Like = "%Credit";

			// Create a payment card type criteria object
			cardCriteria = new PaymentCardTypeCriteria();
			cardCriteria.Id = idRestriction;

			// Retrieve the list of payment card types
			paymentCardTypes = wsDynamicsGP.GetPaymentCardTypeList(cardCriteria, context);

			// Display the ID of each member of the object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PaymentCardType a in paymentCardTypes)
			{
				summaryList.AppendLine("Card type: " + a.Key.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 idRestriction;
			PaymentCardTypeCriteria cardCriteria;
			PaymentCardType[] paymentCardTypes;

			// 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 restriction object
			// Retrieve all types that end in 'Credit'
			idRestriction = new LikeRestrictionOfstring();
			idRestriction.Like = "%Credit";

			// Create a payment card type criteria object
			cardCriteria = new PaymentCardTypeCriteria();
			cardCriteria.Id = idRestriction;

			// Retrieve the list of payment card types
			paymentCardTypes = wsDynamicsGP.GetPaymentCardTypeList(cardCriteria, context);

			// Display the ID of each member of the object list
			StringBuilder summaryList = new StringBuilder();
			foreach (PaymentCardType a in paymentCardTypes)
			{
				summaryList.AppendLine("Card type: " + a.Key.Id);
		}
			MessageBox.Show(summaryList.ToString());

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


Documentation Feedback