GetDynamicsOnlineConfigurationList

Description

Retrieves a list of Dynamics Online Configuration objects that meet the specified criteria.

Parameters

Parameter	Type	Description
criteria	DynamicsOnlineConfigurationCriteria	The Dynamics Online Configuration criteria object that specifies which objects to retrieve.
context	Context	Specifies information about how the method will be called.

Return Value:

Value	Type	Description
GetDynamicsOnlineConfigurationListResult	ArrayOfDynamicsOnlineConfiguration	A list of the Dynamics Online Configuration objects that match the specified criteria.

Interfaces

• Dynamics GP
• Common

Examples

The following C# example retrieves the collection of Dynamics Online Configuration objects which Commerce Services are active. A message box displays the number of companies.

** 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[] doConfigurations;
            DynamicsOnlineConfigurationCriteria doCriteria;
            RestrictionOfNullableOfBoolean activeRestriction;

            // 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();

            // Set up the context
            context.OrganizationKey = null;

            // Specify the criteria for the configurations to retrieve
            activeRestriction = new RestrictionOfNullableOfBoolean();
            activeRestriction.EqualValue = true;
            doCriteria = new DynamicsOnlineConfigurationCriteria();
            doCriteria.IsCommerceServicesActive = activeRestriction;

            // Retrieve the Dynamics Online Configurations
            doConfigurations = wsDynamicsGP.GetDynamicsOnlineConfigurationList(doCriteria, context);

            // Display the number of configuration sets found
            MessageBox.Show("Configurations found: " + doConfigurations.Length.ToString());
        }
    }
}

** 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[] doConfigurations;
            DynamicsOnlineConfigurationCriteria doCriteria;
            RestrictionOfNullableOfboolean activeRestriction;

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

            // Specify the criteria for the configurations to retrieve
            activeRestriction = new RestrictionOfNullableOfboolean();
            activeRestriction.EqualValue = true;
            doCriteria = new DynamicsOnlineConfigurationCriteria();
            doCriteria.IsCommerceServicesActive = activeRestriction;

            // Retrieve the Dynamics Online Configurations
            doConfigurations = wsDynamicsGP.GetDynamicsOnlineConfigurationList(doCriteria, context);

            // Display the number of configuration sets found
            MessageBox.Show("Configurations found: " + doConfigurations.Length.ToString());

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