ABOWebService Operations
The asset operations Modify, Disconnect, Suspend, or Resume create a new line item, based on the account or contact profile. They have a similar input and output data schema. If AccountId is provided, then the Web service operates on the account profile. If AccountId is not provided, then it operates on the contact profile.
Affixing ToQuote in the Web service name means: if an active quote is provided, then the Web service adds the quote item to the existing quote. If an active quote is not provided, then the Web service generates a new quote and adds the quote item to the new quote.
Affixing ToOrder in the Web service name means: if an active order is provided, then the Web service adds the order item to the existing order. If an active order is not provided, then the Web service generates a new order and adds the order item to the new order. For a list of operations associated with this Web service, see the following table.
Name | Description |
---|---|
AutoOrder |
Converts a Quote to a Sales Order. |
SubmitOrder |
Submits an Order. |
AutoAsset |
Creates assets from the completed order line items or updates a current asset. |
ModifyAssetToQuote |
Modifies a Service Item asset, and generates a quote item to update the selected asset. |
ModifyAssetToOrder |
Modifies a Service Item asset, and generates an order item to update the selected asset. |
DisconnectAssetToQuote |
Disconnects a Service Item asset to generate a quote item to deactivate the selected asset. |
DisconnectAssetToOrder |
Disconnects a Service Item asset, and generates an order item to deactivate the selected asset. |
SuspendAssetToQuote |
Suspends an active a Service Item asset to generate a quote item to suspend the selected asset. |
SuspendAssetToOrder |
Suspends a Service Item asset and generates an order item to suspend the selected asset. |
ResumeAssetToQuote |
Resumes a suspended a Service Item asset to generate a quote item to resume the selected asset. |
ResumeAssetToOrder |
Resumes a Service Item asset, and generates an order item to resume the selected asset. |
Request Message Description: AutoOrder
The following Web service operations AutoOrder, SubmitOrder, ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, and DisconnectAssetToOrder share a common output message format: PDS Order.
ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, DisconnectAssetToOrder share a common request message format.
ModifyAssetToQuote, SuspendAssetToQuote, ResumeAssetToQuote and DisconnectAssetToQuote share a common request message format, and a common response message format, PDS Quote.
For a description of this request message, see the following table.
Node | Description |
---|---|
Object Id |
Required. Row ID of the quote to be converted to the Sale Order. |
Skip Query Order |
Allows the calling application to skip querying the modified or new Order back to the calling Web service after the Auto Order operation is performed. |
Response Message Description: AutoOrder
The integration object message format is PDS Order. For a description of this response message, see the following table.
Node | Description |
---|---|
PDS Order |
Instance of the integration object PDS Order. |
Header |
Order Header. |
Line Item |
Order Line Items. |
XA |
Order Line Item attributes. |
Request Message Description: SubmitOrder
For a description of this request message, see the following table.
Node | Description |
---|---|
OrderId |
Required. RowId of the order to be submitted. |
Response Message Description: SubmitOrder
integration object message format: PDS Order, which has the same format as the AutoOrder response message.
Request Message Description: AutoAsset
For a description of this request message, see the following table.
Node | Description |
---|---|
Object Id |
Required. RowId of the corresponding Order that contains the Order Line Item to be converted or applied to an asset. |
LineItemId |
Required. RowId of an Order Line Item to be converted or applied to an asset. |
Response Message Description: AutoAsset
This integration object message format is PDS Asset. For a description of this response message, see the following table.
Node | Description |
---|---|
PDS Asset |
Required. Integration object. |
Header |
Asset header. |
Line Item |
Asset |
XA |
Asset attributes |
For a description of this request message, see the following table.
Node | Description |
---|---|
AssetIntegrationId |
Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. |
AssetNumber |
Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. |
ActiveDocumentId |
A document in SiebelOrder Management which refers to either a quote or an order. Each Document can have multiple children, that is Quote Items, or Order Line Items. ActiveDocumentId refers to the current active Document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input. |
AccountId |
Account ID of the account that owns the selected Service Item asset. |
ContactId |
Contact ID of the contact who owns the selected Service Item asset to be modified. |
DueDate |
The due date of the generated line item. |
PriceListId |
Specifies a Price List ID that is associated with the quote if a new quote is requested to generate. |
CompoundProductNumber |
Compound Product Number for the Asset Based Ordering (ABO) network ordering. It is not required if network ordering is not used. |
PriceOnSync |
Passed down to the sub-process SIS OM Edit Complex Asset Workflow to the step SIS OM PMT Service 'Synchronize' step to trigger a reprice if necessary. |
The integration object message format is PDS Quote. For a description of this response message, see the following table.
Node | Description |
---|---|
PDS Quote |
Required. Integration object. |
Header |
Quote header. |
Line Item |
Quote line item. |
XA |
Quote line item attributes. |
For a description of this request message, see the following table.
Node | Description |
---|---|
AssetIntegrationId |
Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. |
AssetNumber |
Asset integration ID of the selected asset. Provide either AssetIntegrationId or AssetNumber. |
ActiveDocumentId |
A document in Siebel Order Management which refers to either a quote or an order. Each Document can have multiple children, which are Quote Items or Order Line Items. ActiveDocumentId refers to the current active document that the current process is working on. In this Web service call, it is the Quote ID of the active Quote to which the generated quote item has to be added. This is an optional input. |
AccountId |
Account ID of the account that owns the selected Service Item asset. |
ContactId |
Contact ID of the contact who owns the selected Service Item asset to be modified. |
DueDate |
The due date of the generated line item. |
PriceListId |
Specifies a Price List ID associated with the quote if a new quote is requested. |
CompoundProductNumber |
Compound Product Number for ABO network ordering. It is required only if network ordering is used. |
Integration object message format: PDS Order, which has the same format as the AutoOrder response message.
Request Message Description: SuspendAssetToQuote
This is the same request message as ModifyAssetToQuote.
Response Message Description: SuspendAssetToQuote
Integration object message format: PDS Quote.
Request Message Description: SuspendAssetToOrder
This is the same request message as ModifyAssetToOrder.
Response Message Description: SuspendAssetToOrder
Integration object message format: PDS Order.
Request Message Description: ResumeAssetToQuote
This is the same request message as ModifyAssetToQuote.
Response Message Description: ResumeAssetToQuote
Integration object message format: PDS Quote.
Request Message Description: ResumeAssetToOrder
This is the same request message as ModifyAssetToOrder.
Response Message Description: ResumeAssetToOrder
Integration object message format: PDS Order.
Request Message Description: DisconnectAssetToQuote
This is the same request message as ModifyAssetToQuote.
Integration object message format: PDS Quote.
This is the same request message as ModifyAssetToOrder.
Integration object message format: PDS Order.