GetDynamicsOnlineConfigurationByKey

Description

Retrieves the Dynamics Online Configuration for a specific company.

Parameters

Parameter	Type	Description
key	CompanyKey	The company key object that specifies the company for which the Dynamics Online Configuration will be retrieved.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetDynamicsOnlineConfigurationByKeyResult	DynamicsOnlineConfiguration	A customer object.

Interfaces

• Dynamics GP
• Common

Examples

The following C# example retrieves the Dynamics Online Configuration object for the Fabrikam sample company. A message box displays the company name from the Dynamics Online Configuration data.

** 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;
            DynamicsOnlineConfiguration doConfiguration;

            // Create an instance of the service
            DynamicsGP wsDynamicsGP = new DynamicsGP();

            // Be sure that default credentials are being 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
            context.OrganizationKey = null;

            // Retrieve the Dynamics Online Configuration for the company
            doConfiguration = wsDynamicsGP.GetDynamicsOnlineConfigurationByKey(companyKey, context);

            // Display the company name from the configuration data
            MessageBox.Show("Configuration for: " + doConfiguration.CompanyName);
        }
    }
}

** 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;
            DynamicsOnlineConfiguration doConfiguration;

            // 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 = null;

            // Retrieve the Dynamics Online Configuration for the company
            doConfiguration = wsDynamicsGP.GetDynamicsOnlineConfigurationByKey(companyKey, context);

            // Display the company name from the configuration data
            MessageBox.Show("Configuration for: " + doConfiguration.CompanyName);

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