Bookshelf Home | Contents | Index | PDF     

Siebel CRM Web Services Reference > Primary Web Services for Siebel CRM 8.0 >

ABOWebService

Use this Web service to expose the following Asset-Based Ordering (ABO) functions: convert a quote into an order, submit an order to the back-end office, convert a completed order line item to an asset, modify an asset, disconnect an asset, suspend, or resume an asset. This Web service works only with an Asset-Based Ordering (ABO) enabled environment. A typical application that uses the Web service is Siebel Communication.

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 the AccountId is provided, then it operates on the account profile. If the AccountId is not provided it operates on the contact profile.

Affixing ToQuote to the Web service name means: if an active quote is provided a quote item is added to the existing quote. If an active quote is not provided, a new quote is generated and the quote item is added to the new quote.

Affixing ToOrder in the Web service name means: if an active order is provided an order item is added to the existing order. If an active order is not provided, it generates a new order and adds the order item into the new order. For a list of operations associated with this Web service, see Table 4.

Table 4. ABOWebService operations
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 an asset (Service Item), and generates a quote item to update the selected asset.

ModifyAssetToOrder

Modifies an asset (Service Item), and generates an order item to update the selected asset.

DisconnectAssetToQuote

Disconnects an asset (Service Item) to generate a quote item to deactivate the selected asset.

DisconnectAssetToOrder

Disconnects an asset (Service Item), and generates an order item to deactivate the selected asset.

SuspendAssetToQuote

Suspends an active asset (Service Item) to generate a quote item to suspend the selected asset.

SuspendAssetToOrder

Suspends an asset (Service Item) and generates an order item to suspend the selected asset.

ResumeAssetToQuote

Resumes a suspended asset (Service Item) to generate a quote item to resume the selected asset.

ResumeAssetToOrder

Resumes an asset (Service Item), and generates an order item to resume the selected asset.
Request Message Description: AutoOrder

The ABOWebService operations: AutoOrder, SubmitOrder, ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, and DisconnectAssetToOrder share a common output message format: PDS Order.

The operations: ModifyAssetToOrder, SuspendAssetToOrder, ResumeAssetToOrder, DisconnectAssetToOrder have a common request message format.

The operations: ModifyAssetToQuote, SuspendAssetToQuote, ResumeAssetToQuote and DisconnectAssetToQuote have a common request message format, and a common response message format: PDS Quote.

For a description of this request message, see Table 5.

Table 5. Request Message Description: AutoOrder
Node
Description

Object Id

Required. Row Id of the quote to be converted to the sales order.

Response Message Description: AutoOrder

Integration Object Message Format: PDS Order. For a description of this response message, see Table 6.

Table 6. Response Message Description: AutoOrder
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 Table 7.

Table 7. Request Message Description: SubmitOrder
Node
Description

OrderId

Required. Row Id 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 Table 8.

Table 8. Request Message Description: AutoAsset
Node
Description

Object Id

Required. Row Id of the corresponding order that contains the order line item to be converted or applied to an asset.

LineItemId

Required. Row Id of an order line item to be converted or applied to an asset.

Response Message Description: AutoAsset

Integration Object Message Format: PDS Asset. For a description of this response message, see Table 9.

Table 9. Response Message Description: AutoAsset
Node
Description

PDS Asset

Required. Integration object.

Header

Asset header.

Line Item

Asset.

XA

Asset attributes.

Request Message Description: ModifyAssetToQuote

For a description of this request message, see Table 10.

Table 10. Request Message Description: ModifyAssetToQuote
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

Optional. A document in Order Management is undestood as a Quote or an Order. Each Document can have multiple children, known as Quote Items or Order Line Items. ActiveDocumentId refers to the current active Document that an active 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.

AccountId

Account Id of the account that owns the selected asset (Service Item).

ContactId

Contact Id of the contact who owns the selected asset (Service Item) to be modified.

DueDate

The due date of the generated line item.

PriceListId

Specifies a price list Id which is associated with a newly generated quote.

CompoundProductNumber

Compound product number for the Asset Based Ordering (ABO) network ordering. It is not required if network ordering is not used.

Response Message Description: ModifyAssetToQuote

Integration Object Message Format: PDS Quote. For a description of this response message, see Table 11.

Table 11. Response Message Description: ModifyAssetToQuote
Node
Description

PDS Quote

Required. Integration object.

Header

Quote header.

Line Item

Quote line item.

XA

Quote line item attributes.

Request Message Description: ModifyAssetToOrder

For a description of this request message, see Table 12.

Table 12. Request Message Description: ModifyAssetToOrder
Node
Description

AssetIntegrationId

Asset integration Id of the selected asset. AssetIntegrationId or AssetNumber are required inputs.

AssetNumber

Asset Integration Id of the selected asset. AssetIntegrationId or AssetNumber are required inputs.

ActiveDocumentId

Optional. A document in Order Management is undestood as a Quote or an Order. Each Document can have multiple children, known as Quote Items or Order Line Items. ActiveDocumentId refers to the current active Document that an active 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.

AccountId

Account Id of the account that owns the selected asset (Service Item).

ContactId

Contact Id of the contact who owns the selected asset (Service Item) 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. Required only if network ordering if used.

Response Message Description: ModifyAssetToOrder

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.

Response Message Description: DisconnectAssetToQuote

Integration Object Message Format: PDS Quote.

Request Message Description: DisconnectAssetToOrder

This is the same request message as ModifyAssetToOrder.

Response Message Description: DisconnectAssetToOrder

Integration Object Message Format: PDS Order.

ABOWebService Application Interface

This topic describes the application objects called by the this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 13.

Table 13. ABOWebService Service Object
Name
Boundary Object Type
Class (if
Business Service)

SISOMAutoOrderWebService

Workflow

Not applicable

SISOMSubmitWebService

Workflow

Not applicable

SISOMAutoAssetWebService

Workflow

Not applicable

SISOMModifyWebService-Quote

Workflow

Not applicable

SISOMModifyWebService-Order

Workflow

Not applicable

SISOMSuspendWebService-Quote

Workflow

Not applicable

SISOMSuspendWebService-Order

Workflow

Not applicable

SISOMResumeWebService-Quote

Workflow

Not applicable

SISOMResumeWebService-Order

Workflow

Not applicable

SISOMDisconnectWebService-Quote

Workflow

Not applicable

SISOMDisconnectWebService-Order

Workflow

Not applicable

Data Object (Integration Object)

For a description of data objects for this Web service, see Table 14.

Table 14. ABOWebService Data Object
Siebel Repository Name
External Name

PDS Quote

PDS Quote

PDS Order

PDS Order

PDS Asset

PDS Asset

Example Package for ABOWebService

To view an example of messages for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request (AutoOrder)

See the following file to view the sample code:

...\ABOWebService\AutoOrder_request.xml

Response (AutoOrder)

See the following file to view the sample code:

...\ABOWebService\AutoOrder_response.xml

Request (ModifyAssetToQuote)

See the following file to view the sample code:

...\ABOWebService\ModifyAssetToQuote_request.xml

Response (ModifyAssetToQuote)

See the following file to view the sample code:

...\ABOWebService\ModifyAssetToQuote_response.xml

Request (AutoAsset)

See the following file to view the sample code:

...\ABOWebService\AutoAsset_request.xml

Response (AutoAsset)

See the following file to view the sample code:

...\ABOWebService\AutoAsset_response.xml

Message Schema (WSDL) for ABOWebservice

To view the message schema for this Web service, navigate to the documentation library for Siebel applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\ABOWebService\ABOWebService.wsdl

    
Siebel CRM Web Services Reference Copyright © 2009, Oracle and/or its affiliates. All rights reserved. Legal Notices.