Retrieves a list of shipping method objects that match the specified criteria.
Parameter |
Type |
Description |
---|---|---|
criteria |
A shipping method criteria object that specifies which shipping method objects are returned. |
|
context |
Specifies information about how the method will be called. |
Value |
Type |
Description |
---|---|---|
GetShippingMethodListResult |
The list of shipping method objects that match the specified criteria. |
The following C# example retrieves the list of shipping method objects whose Id property ends with “DAY”. The Description and Carrier properties from each shipping method 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 shippingMethodRestriction; ShippingMethodCriteria shippingMethodCriteria; ShippingMethod[] shippingMethods; // 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 shipping methods ending with DAY shippingMethodRestriction = new LikeRestrictionOfString(); shippingMethodRestriction.Like = "%DAY"; // Create a shipping method criteria object shippingMethodCriteria = new ShippingMethodCriteria(); shippingMethodCriteria.Id = shippingMethodRestriction; // Retrieve the shipping method objects shippingMethods = wsDynamicsGP.GetShippingMethodList(shippingMethodCriteria, context); // Display the description and carrier of each member of the object list StringBuilder summaryList = new StringBuilder(); foreach (ShippingMethod a in shippingMethods) { summaryList.AppendLine("Shipping method: " + a.Description + " Carrier: " + a.Carrier); } 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 shippingMethodRestriction; ShippingMethodCriteria shippingMethodCriteria; ShippingMethod[] shippingMethods; // 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 shipping methods ending with DAY shippingMethodRestriction = new LikeRestrictionOfstring(); shippingMethodRestriction.Like = "%DAY"; // Create a shipping method criteria object shippingMethodCriteria = new ShippingMethodCriteria(); shippingMethodCriteria.Id = shippingMethodRestriction; // Retrieve the shipping method objects shippingMethods = wsDynamicsGP.GetShippingMethodList(shippingMethodCriteria, context); // Display the description and carrier of each member of the object list StringBuilder summaryList = new StringBuilder(); foreach (ShippingMethod a in shippingMethods) { summaryList.AppendLine("Shipping method: " + a.Description + " Carrier: " + a.Carrier); } MessageBox.Show(summaryList.ToString()); // Close the service if(wsDynamicsGP.State != CommunicationState.Faulted) { wsDynamicsGP.Close(); } } } }