ReplaceSeriesModel (Stateless)

Method

ReplaceSeriesModel(ClientConnectInfo connectInfo, ReplaceSeriesModelParameters parameters)

Updates the Series ID and/or Model ID of the specified configuration. This function is intended to enable the scenario where a configuration is created via the Web Configurator with a set of categories, options, rules, etc. that are a subset of a more complete or more complex series. This provides a means for a sales user to create a configuration using one Series/Model and then have the configuration updated using more advanced functionality at a later time.

By default, an affected configuration will be automatically put into a draft state as an indicator that the configuration should be opened and resaved to have the new Series/Model take effect. Likewise, by default, the Series and Model being assigned will be validated before the change is made. Both behaviors can be disabled via the ReplaceSeriesModelParameters argument.

This function is not intended to provide a way to alternate between two series since it can result in data loss.

Also, note that the Configuration object in the resultant ReplaceSeriesModelResult will be populated with the configuration XML, but since the configuration is not actually “loaded” by the Configurator, its other properties will be largely unassigned or at their default values.

To best leverage this method, your integrator should do the following:

Implement the IBasicIntegration interface. If this interface is not implemented, you must support “configxml” in the indexer.
Handle a SaveContext.SaveType of CommitConfigOnly.

Parameters

ClientConnectInfo

The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.

Properties

The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.

Data Type	Property	Description
string	AuthUserName	Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string	AuthPassword	Returns or sets the password to authenticate the caller to the service.

ReplaceSeriesModelParameters

An instance of ReplaceSeriesModelParameters is passed into the ReplaceSeriesModel method.

Constructors

ReplaceSeriesModelParameters()

ReplaceSeriesModelParameters(ConfigHeader header, int lineItemId, string seriesId, string modelId)

Properties

Data Type	Property	Description
int	LineItemId	Returns or sets the configuration number to replace.
bool	ValidateIdentifiers	Returns or sets whether the Series/Model IDs passed in are validated.
bool	AutoDraftMode	Returns or sets whether the configuration is automatically placed into draft mode.
string	SeriesId	Returns or sets the Series ID to assign. If NULL, the Series ID will not be replaced.
string	ModelId	Returns or sets the Model ID to assign. If NULL, the Model ID will not be replaced.

Inheritance

ConfigParameters

The ConfigParameters class represents contextual information needed by the integration libraries for the Web Configurator Service.

Constructors

ConfigParameters()

ConfigParameters(ConfigHeader header)

Properties

Data Type	Property	Description
ConfigHeader	Header	Returns or sets the header (type and id) of the record in the host system being configured.

Inheritance

ParametersBase

The ParametersBase class is the base class for the parameters types that are passed in to various methods on the service. All parameters-derived types have the parameters listed below.

Properties

Data Type	Property	Description
bool	OmitConfigurationXmlFromResult	Returns or sets whether or not the configuration xml should be omitted from the result object. In general, the various methods that interact with the service will cause the configuration XML to be returned to the caller each time. It can be bandwidth and processing intensive to recreate the XML for each call. By setting this property to True, those steps will be skipped resulting in less data being transmitted and less server-side processing.
OperationsBehaviors	OperationBehaviors	This property is used to provide additional contextual behaviors to the service call. Provide an instance of the OperationBehaviors class with properties set to identify whether the configuration should be saved (via the Stateless services) or whether a StateGraph should be returned with the result of the web service call.
DiagnosticOutput	DiagnosticOutput	Specifies the type of diagnostic information that should be returned as a result of the service call. Available values include: None RulesExecuted RulesMessages RulesChanges This provides access to the rules that were executed along with their associated messages and changes. If set to a value other than None, the DiagnosticData property of the various Result objects will be populated.
bool	ValidateRequiredProperties	Returns or sets a value indicating whether the configuration should be validated for required Property values. The default value is true.

Returns

ReplaceSeriesModelResult

An instance of ReplaceSeriesModelResult is returned by the ReplaceSeriesModel method. It does not contain any unique properties.

Inheritance

ConfigurationResult

The returned ConfigurationResult object contains general information about the configuration. It is a base class inherited many of the "result" objects, such as SaveConfigurationResult or CreateConfigurationResult.

Properties

Data Type	Property	Description
ConfigHeader	Header	Returns or sets the Config Header (ID + entity type).
ConfigurationResultCode	ResultCode Possible Values: Success Failure	Returns or sets whether the operation was successful and without errors.
ConfigurationResultMessage[]	ResultMessages	Returns or sets resulting messages from the configuration action.
ConfigurationFailureCode	FailureCode Possible Values: None SiteUnderMaintenance CompatEngineNotInitialized ServiceDisabled InvalidArgument InvalidOperation	In the event the ResultCode is Failure, returns a code identifying the type of failure
int	LineItemId	Returns or sets the line item id of the configuration. This is valid when the ConfigResult instance is a result of the IWebConfig.SaveConfiguration() or the IWebConfig.FixConfiguration() methods, otherwise the value is -1.
Configuration	Configuration	Returns or sets a Configuration object containing various properties relating to the current configuration. This will only ever be assigned if the Configuration is relevant to the operation that was executed.
ConfigurationStateGraphBase	StateGraph	Returns or sets a StateGraph object containing various properties relating to the current configuration. This will only ever be assigned if the ConfigParameters.OperationBehaviors.StateGraphParameters property is provided on the request.
DiagnosticData	DiagnosticData	Returns the DiagnosticData associated with the operation. This will only ever be assigned if theConfigParameters.DiagnosticOutput property is provided on the request.
SessionContext	SessionContext	Returns a SessionContext object containing server-side properties that pertain to the current configuration session.