Retrieves a single vendor object based on the specified vendor key. The value returned by this method can be affected by entity ID filtering.
Parameter |
Type |
Description |
---|---|---|
key |
The vendor key object that specifies the vendor to retrieve. |
|
context |
Specifies information about how the method will be called. |
Value |
Type |
Description |
---|---|---|
GetVendorByKeyResult |
A vendor object. |
The following C# example retrieves a vendor with the key value “ACETRAVE0001”. A message box displays the vendor’s name.
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; Vendor vendor; VendorKey vendorKey; // Create an instance of the service DynamicsGP wsDynamicsGP = new DynamicsGP(); // Be sure the default credentials are used wsDynamicsGP.UseDefaultCredentials = true; // Create a context object 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 vendor key vendorKey = new VendorKey(); vendorKey.Id = "ACETRAVE0001"; // Retrieve the vendor object vendor = wsDynamicsGP.GetVendorByKey(vendorKey, context); // Display vendor name MessageBox.Show("Vendor: " + vendor.Name); } } }
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; Vendor vendor; VendorKey vendorKey; // Create an instance of the service DynamicsGPClient wsDynamicsGP = new DynamicsGPClient(); // Create a context object 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 vendor key vendorKey = new VendorKey(); vendorKey.Id = "ACETRAVE0001"; // Retrieve the vendor object vendor = wsDynamicsGP.GetVendorByKey(vendorKey, context); // Display vendor name MessageBox.Show("Vendor: " + vendor.Name); // Close the service if(wsDynamicsGP.State != CommunicationState.Faulted) { wsDynamicsGP.Close(); } } } }