Product Configurator Web Service for Orders Operations

The following table provides a list of the operations associated with this Web service.

Name	Description
GetObjStructureOrder	Retrieves the product relationships, attributes, linked items and resources.
GetObjGroupItemsOrder	Retrieves the product UI definition, UI group, and group items.
GetObjDefaultGroupItemsOrder	Retrieves the default product group items. Group items are based on all relationships, attributes, linked items and resources.
BeginConfigurationOrder	Enables customization of products stored in the Siebel database. Initializes the configurator session with an order instance and product model.
UpdateConfigurationOrder	Executes operations on the order instance initialized in BeginConfigurationOrder.
EndConfigurationOrder	Releases server resources used during the configuration of the product.

Request Message Description: GetObjStructureOrder

GetObjStructureOrder and GetObjGroupItemsOrder have the same request and response message.

GetObjDefaultGroupItemsOrder request and response message is the same as GetObjGroupItemsOrder. The Object’s direct child properties are ignored as well those of UIOption, Responsibilities, and Group. Only the GroupItem child is looked at and returned (others are copied to the Response message).

GroupItem behavior is similar to that of GetObjGroupItemsOrder.

The following table provides a description of the request message GetObjStructureOrder.

Node	Description
WebChannelObjStructure	Required.This structure specifies the objects that are queried and the data that is returned about the objects.
Object	Required. Specify one or more objects.
Name	The name of the object (product or class). Either Name or Id is required.
Id	The Id of an object (product or class). Either Name or Id is required.
ObjectType	Required. The object type, either Product or Class.
ParentClassId	The class Id of the parent object.
DisplayName	The display name.
Description	The description.
Attribute	Zero or more child objects to be queried for.
Name	The name of the attribute. If this value is empty, then all attributes are returned.
LocalType	The local type.
InternalType	The internal type.
OrigId	The internal Id.
DisplayName	The display name.
Hidden	The hidden flag.
Required	Required flag.
ReadOnly	Read-only flag.
ValidationSpec	The validation specification.
UnitOfMeasure	The unit of measure.
Description	The description.
AttributeDomain	Zero or more.
LocalValue	The local value.
InternalValue	The internal value.
AttributeDomainDecoration	Zero or more name value pairs of attribute-domain-specific properties.
Name	The name of the attribute.
Value	The value of the attribute.
AttributeDefaultValue	The default value of the attribute. Only one of the value types is populated depending on the type of the value.
DisplayValue	The display value.
String	A string value.
Number	A number value.
Integer	An integer value.
Date	A date value.
Boolean	A Boolean value.
AttributeRejectedValue	A rejected value of the attribute. Only one of the value types is populated depending on the type of the value.
DisplayValue	The display value.
String	A string value.
Number	A number value.
Integer	An integer value.
Date	A date value.
Boolean	A Boolean value.
AttributeDecoration	Zero or more.
Name	The attribute properties name.
Value	Value pairs.
Relationship	Zero or more relationships. Only those child objects that are specified are queried for.
Name	The name of the relationship. If Name or Id is specified, then only that particular relationship is returned. If both are empty, then all relationships are returned.
Id	The Id of the relationship. If Name or Id is specified, then only that particular relationship is returned. If both are empty, then all relationships are returned.
DisplayName	The display name.
ClassName	The class name.
ClassId	The class Id.
DefaultProductId	The default product Id.
DefaultCardinality	The default cardinality.
MinimumCardinality	The minimum cardinality.
MaximumCardinality	The maximum cardinality.
RelationshipDomain	Zero or more.
Name	The name of the product. If Name or Id is specified, then only that particular relationship domain will be returned. If both are empty, then all relationship domain products will be returned.
Id	The Id of the product. If Name or Id is specified, then only that particular relationship domain are returned. If both are empty, then all relationship domain products are returned.
DisplayName	The display name.
OrigId	The originating Id.
Description	The description of the product.
RelationshipDomainDecoration	Zero or more.
Name	The name of the specific properties of the relationship domain.
Value	Value pairs.
RelationshipDecoration	Zero or more.
Name	The relationship properties name.
Value	Value pairs.
LinkedItem	Zero or more linked items. Only those child objects that are specified are queried for.
Name	The name of the linked item.
Id	The Id of the linked item. If Name or Id is specified, then only that particular linked item is returned. If both are empty, then all linked items are returned.
DisplayName	The display name.
VariableName	The variable name.
SortSpec	The sort specification.
SearchSpec	The search specification.
NeedsExecution	The needs-execution flag, used for business-component-based queries.
Expression	The expression.
DefaultValue	The default value.
BusinessObject	The business object, used for business-component-based queries.
BusinessComponent	The business component, used for business-component-based queries.
FieldName	The field name in the business component.
Active	The active flag.
LinkedItemDecoration	The linked item properties.
Name	The name value.
Value	Value pairs.
Resource	Zero or more resources. Only those child objects that are specified will be queried for.
Name	The name of the resource. If Name or Id is specified, then only that particular resource is returned. If both are empty, then all resources are returned.
Id	The Id of the resource. If Name or Id is specified, then only that particular resource is returned. If both are empty, then all resources are returned.
DisplayName	The display name.
ResourceDecoration	The resource properties.
Name	The name value.
Value	Value pairs.
ObjectDecoration	The object properties.
Name	The name value.
Value	Value pairs.

Request Message Description: GetObjGroupItemsOrder, GetObjDefaultGroupItemsOrder

The following table provides a description of the request messages GetObjGroupItemsOrder and GetObjDefaultGroupItemsOrder.

Node	Description
WebChannelObjGroupItems	Required. This structure identifies the objects that will be queries and the data that will be returned for the objects.
Object	Required. One or more must be specified.
Name	The name of the object (product or class). Either Name or Id is required.
Id	The Id of the object (product or class). Either Name or Id is required.
ObjectType	Required. The type of the object, either Product or Class.
ParentClassId	The class Id of the parent.
DisplayName	The display name.
Description	The description.
UIOption	Zero or more.
Name	The name of the UI option. If Name or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned.
Id	The Id of the UI option. If Name or Id is specified, then only that particular UI option will be returned. If both are empty, then all UI options will be returned.
Type	The type.
DisplayName	The display name.
Sequence	The sequence.
BaseTheme	The base theme.
ProductTheme	The product theme.
Responsibility	Zero or more.
Name	The name of the responsibility. If Name or Id is specified, only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned.
Id	The Id of the responsibility. If Name or Id is specified, only that particular responsibility will be returned. If both are empty, then all responsibilities will be returned.
Group	Zero or more.
Name	The name of the group. If Name or Id is specified, then only that particular group will be returned. If both are empty, then all groups will be returned.
Id	The Id of the group. If Name value or Id value is specified, then only that particular group will be returned. If both are empty, then all groups will be returned.
DisplayName	The display name.
Sequence	The sequence.
GroupTheme	The group theme.
Description	The description.
GroupItem	Zero or more.
Id	The Id of the group item. If Id or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned.
Type	The type of the group item (Relationship, Attribute, LinkedItem, or Resource). If Id or Type is specified, then only that particular group item will be returned. If both are empty, then all group items will be returned.
Sequence	The sequence.
GroupItemTheme	The theme of the group item.
Attribute	An attribute child object of GetObjStructureOrder request message.
Relationship	A relationship child object of GetObjStructureOrder request message.
LinkedItem	A LinkedItem child object of GetObjStructureOrder request message.
Resource	Refer to the Resource child object of GetObjStructureOrder request message.
GroupDecoration	The group properties.
Name	The name value.
Value	Pairs.
Object Decoration	The object properties of the name value pairs.

Request Message Description: BeginConfigurationOrder

The following table provides a description of the request message, BeginConfigurationOrder.

Node	Description
BeginConfigurationOrder_Input	Required.
InitInstanceOperation	Required. The operation type for the BeginConfigurationOrder session. There are the following options: Load. Loads the hierarchy object from the database. HeaderId and RootId are required. IntegrationObjectName is required to determine which table to query and what the structure of the hierarchy is. This option allows you to synchronize the quote or order to the database when configuration is complete. You can also configure the quote or order to remain in-memory, without needing to synchronize to the database. Default. Load the hierarchy object from the database and creates a new line item for a product with its default instance. HeaderId and ProductId are required. IntegrationObjectName is required to determine which table to query and what the structure of the hierarchy is. Set. Loads the hierarchy object from the ListOfOrder parameter (PDS Order integration object). RootId is required to determine the root line item to use in this session. This option allows you to synchronize the quote or order to the database when configuration is complete. You can also configure the quote or order to remain in-memory, without needing to synchronize to the database. Add. Adds a new line item to the hierarchy object from the ListOfOrder parameter (PDS Order integration object). ProductId is required.
HeaderId	Required for InitInstanceOperation of LOAD or DEFAULT. The row Id of the header.
RootId	Required for InitInstanceOperation of LOAD or SET. The row Id for the root line item.
ProductId	Required for InitInstanceOperation of DEFAULT or ADD. The product Id for the root line item.
ListOfOrder	Required for InitInstanceOperation of SET or ADD. The hierarchy object in PDS Order integration object format.
ListOfData	The list of products, attributes, or relationships for which a user requires the domain information (with exclusions) in CfgInteractData integration object format.
ProductData	The product type.
Item	The item name.
IntegrationId	The integration Id of the line item. If IntegrationId is specified, then only this line item and its subline items are considered. ProductId is optional. If ProductId is also specified, then it must match IntegrationId. If the IntegrationId and ProductId are not specified, then the root line item is considered.
ProductId	The product Id of the line item. If IntegrationId specified, then only this line item and its subline items are considered. ProductId is optional. If ProductId is also specified, then it must match IntegrationId. If IntegrationId and ProductId are not specified, then the root line item is considered.
Name	The name of the product.
Quantity	The quantity.
RelationshipName	The relationship name. For subline items, RelationshipName can be specified to limit the search to a particular relationship.
RootIntegrationId	The integration Id of the root line item.
PortId	The relationship Id.
ParentProductId	The parent product Id.
ParentIntegrationId	The parent Integration Id.
CanDrilldown	The can-drilldown flag. It indicates whether the line item is a customizable product.
ListPrice	The list price.
NRCCxTotal	The nonrecurring total price. Set this price only on the root line item.
MRCCxTotal	The recurring total price. Set this price only on the root line item.
CurrentPrice	The current price of the item after all the discounts have been applied.
ExchangeDate	The exchange date of the pricing field values.
CurrencyCode	The currency code of the pricing field values.
HasGenericsFlag	The has-generics flag. It indicates whether the line item is incomplete.
EligibilityStatus	The eligibility status.
EligibilityReason	The eligibility reason.
Explanation	The explanation, if required.
ExplanationText	The text of the explanation.
Relationship	Zero or more. The list of relationships for which information is required.
Name	The name of the relationship to query for. If the query is empty, then all relationships are returned.
Id	The Id. It is always returned whether specified in the request or not.
Request Type	Indicates the type of the information that is calculated for this relationship. The values include: SelectionInfo. Only current line items for this relationship are generated. DomainInfo. Only the possible domain items for this relationship are generated. Any other value. Both of the previous values are generated.
DomainItem	Zero or more domain items of the relationship. Always returned whether specified in the request or not.
Name	The name of the domain item.
Id	The Id of the domain item.
ListPrice	The list price.
ExchangeDate	The exchange date of the pricing field values.
CurrencyCode	The currency code of the pricing field values.
PriceType	Indicates the type of list price: one-time or recurring.
CanDrilldown	The can-drill-down flag. It indicates whether the line item is a customizable product.
Excluded	The excluded flag. It indicates whether this domain item is excluded by a constraint, eligibility and compatibility rule, or a promotion.
Attribute	Zero or more attributes for which information is required.
Name	The name of attribute to query for. If the query is empty, then all attributes are returned.
ValueType	The type of the attribute. It is always returned whether specified in the request or not.
AttributeValue	Zero or more attribute values. It is always returned whether specified in the request or not.
DisplayValue	The display value.
StringValue	The value displayed as a string.
IntegerValue	The value displayed as an integer.
NumberValue	The value displayed as a number.
BooleanValue	The value displayed as a Boolean value.
DateTimeValue	The date and time value.
Selected	The selected flag. It indicates whether this value is selected.
Excluded	The Excluded flag. It indicates whether this value is excluded by a constraint, eligibility and compatibility rule, or promotion.
Item	Zero or more items. Same recursive structure as already defined.
ListOfLinkedItems	The linked items.
LinkedItems	The linked items.
LinkedItemValue	One or more values of linked items.
Name	The name of the linked item.
ValueType	The type of value.
StatusText	The details of the error, if an error occurs.
ConflictResolution	Indicates whether a Proceed or Undo operation was performed on the conflicts and also whether any other violations occurred that resulted in an Undo operation. The values are: Proceed or Undo.
Messages	Zero or one message.
MessageType	Zero or more message types.
MessageSource	The source of the messages, which might be eligibility, promotion, cardinality, proceed actions, and so on.
Message	The message text.
ReturnFullInstance	Indicates whether the Order instance is returned in the ListOfOrder parameter of the response message. The values are: Y (default) and N.

Response Message Description: BeginConfigurationOrder

GetObjGroupItemsOrder and GetObjDefaultGroupItemsOrder have the same request and response messages. See the response message description for BeginConfigurationOrder for details. The following table includes a description of this response message BeginConfigurationOrder.

Node	Description
BeginConfigurationOrder_Output	Required.
Error_spcCode	Displays an error code if an error occurs.
Error_spcMessage	Displays an error message if an error occurs.
RootId	The new item’s root Id.
RootIntegrationId	The new item’s root integration Id.
ListOfOrder	Indicates the order instance, if the ReturnFullInstance input parameter was set to Y. See BeginConfigurationOrder Request Message for details.
ListOfData	The domain information about products, attributes, or relationships and the current selections for the attributes, or relationships that was requested in the request message. See the Request Message for more details.
ListOfStatus	Indicates whether the request was successful or not and contains messages to be displayed.
Status	Required.
StatusCode	The values are: Success. The operation was successful. Warning. Some conflicts occurred that were automatically resolved. The messages are present in ListOfMessages. Error. Some conflicts could not be resolved. Any further requests to this session will not be responded to. Messages are present in ListOfMessages.

Request Message Description: UpdateConfigurationOrder

The following table includes a description of this request message UpdateConfigurationOrder.

Node	Description
UpdateConfigurationOrder_Input	Required.
ConflictAutoResolve	The values are: Proceed. All conflicts are resolved automatically. Undo. Any conflict will undo the entire batch job.
FinishInstanceInFlag	If this flag is set to Y, then FinishIt is called.
SaveInstanceInFlag	If this flag is set to Y, then the instance is saved to the database.
RepriceInstanceInFlag	If this flag is set to Y, then reprice is called.
VerifyInstanceInFlag	If this flag is set to Y, then the verify instance is called.
ListOfData	Same as ListOfData in BeginConfigurationOrder Request Message.
ListOfRequest	The list of requests that are executed on the product instance.
Requests	The requests.
Request	Zero or more.
Type	The type of request. The values are: AddItem, RemoveItem, SetItemQuantitty, SetAttribute, and ReplaceItem.
Item	Zero or more requests.
AddProductId	The add product Id for AddItem or ReplaceItem.
Quantity	The quantity.
RelationshipId	The relationship Id that contains the new product for AddItem or ReplaceItem.
IntegrationId	The integration Id on which the operation is performed.
Attribute	Zero or more SetAttribute request details.
Name	The name of the attribute.
ValueType	The type of value.
AttributeValue	Zero or more.
DisplayValue	The new display value of the attribute
String	The value displayed as a string.
Number	The value displayed as a number.
Integer	The value displayed as an integer.
Date	The value displayed as a date.
Boolean	The value displayed as a Boolean value.

The following table includes a description of this request message UpdateConfigurationOrder.

Node	Description
UpdateConfigurationOrder_Output	Required.
Error_spcCode	Displays an error code if an error occurs.
Error_spcMessage	Displays an error message if an error occurs.
FinishConfigurationOutFlag	Y or N. Indicates whether Finish Configuration was done. It might not be performed if errors occur.
RepriceOutFlag	Y or N. Indicates whether a Reprice operation was done. It might not be performed if errors occur.
SaveInstanceOutFlag	Y or N. Indicates whether the Save Instance was done. It might not be performed if conflicts occur.
VerifyOutFlag	Y or N. Indicates whether Verify was done. It might not be performed if there were errors.
ListOfData	The domain information about products, attributes, or relationships as well as current selections for the attributes, or relationships requested in the request message.
ListOfStatus	Indicates whether the request was successful or not, and contains messages to be displayed.

The following table includes a description of this request message EndConfigurationOrder.

Node	Description
EndConfigurationOrder_Input	Required.
SaveInstanceFlag	The save-instance flag.

The following table includes a description of this request message EndConfigurationOrder.

Node	Description
EndConfigurationOrder_Output	Required.
Error_spcCode	Displays an error code if an error occurs.
Error_spcMessage	Displays an error message if an error occurs.
ListOfOrder	The order instance.