GetSalesProcessHoldSetupByKey

Description

Retrieves a single sales process hold setup object based on the specified sales process hold setup key.

Parameters

Parameter	Type	Description
key	SalesProcessHoldSetupKey	The sales process hold setup key object that specifies the sales process hold setup to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetSalesProcessHoldSetupByKeyResult	SalesProcessHoldSetup	A sales process hold setup object.

Interfaces

• Dynamics GP
• Sales

Examples

The following C# example retrieves a sales process hold setup object with the key value "ADDRESS". A message box displays the sales process hold setup description property.

** 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;
            SalesProcessHoldSetupKey salesProcessHoldSetupKey;
            SalesProcessHoldSetup salesProcessHoldSetup;

            // 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 sales process hold setup key object
            salesProcessHoldSetupKey = new SalesProcessHoldSetupKey();
            salesProcessHoldSetupKey.Id = "ADDRESS";

            // Retrieve the sales process setup hold object
            salesProcessHoldSetup = wsDynamicsGP.GetSalesProcessHoldSetupByKey(
            salesProcessHoldSetupKey, context);

            // Display the sales process hold setup description
            MessageBox.Show("Description: " + salesProcessHoldSetup.Description);
        }
    }
}

** Native endpoint **

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Windows.Forms;
using DynamicsGPWebServiceSample.DynamicsGPService;

namespace DynamicsGPWebServiceSample
{
    class Program
    {
        static void Main(string[] args)
        {
            CompanyKey companyKey;
            Context context;
            SalesProcessHoldSetupKey salesProcessHoldSetupKey;
            SalesProcessHoldSetup salesProcessHoldSetup;

            // 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 sales process hold setup key object
            salesProcessHoldSetupKey = new SalesProcessHoldSetupKey();
            salesProcessHoldSetupKey.Id = "ADDRESS";

            // Retrieve the sales process setup hold object
            salesProcessHoldSetup = wsDynamicsGP.GetSalesProcessHoldSetupByKey(
            salesProcessHoldSetupKey, context);

            // Display the sales process hold setup description
            MessageBox.Show("Description: " + salesProcessHoldSetup.Description);

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