GetSalespersonByKey

Description

Retrieves a single salesperson object based on the specified salesperson key. The value returned by this method can be affected by entity ID filtering.

Parameters

Parameter	Type	Description
key	SalespersonKey	The salesperson key object that specifies the salesperson to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetSalespersonByKeyResult	Salesperson	A salesperson object.

Interfaces

• Dynamics GP
• Common
• Field Service
• Financials
• Human Resources/Payroll
• Inventory
• Manufacturing
• Project Accounting
• Purchasing
• Sales

Examples

The following C# example retrieves a salesperson object with the key value "SANDRA M.". A message box displays the salesperson 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;
            SalespersonKey salesPersonKey;
            Salesperson salesPerson;

            // 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 person key object to specify the sales person
            salesPersonKey = new SalespersonKey();
            salesPersonKey.Id = "SANDRA M.";

            // Retrieve the sales person object
            salesPerson = wsDynamicsGP.GetSalespersonByKey(salesPersonKey, context);

            // Display the name of the sales person
            MessageBox.Show("Sales person: " + salesPerson.FirstName + " " + salesPerson.LastName);
        }
    }
}

** 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;
            SalespersonKey salesPersonKey;
            Salesperson salesPerson;

            // 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 person key object to specify the sales person
            salesPersonKey = new SalespersonKey();
            salesPersonKey.Id = "SANDRA M.";

            // Retrieve the sales person object
            salesPerson = wsDynamicsGP.GetSalespersonByKey(salesPersonKey, context);

            // Display the name of the sales person
            MessageBox.Show("Sales person: " + salesPerson.FirstName + " " + salesPerson.LastName);

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