Services and Operations

The interfaces are organized into services that include related operations. The following interfaces are exposed for any client to invoke the services related to the framework. These services can be invoked over two different channels: SOAP over HTTP and SOAP over JMS.

Note: Supported encoding style in the web service request is UTF-8.

All Web Services support HTTP and JMS. Web Services endpoint URL has the following format:

http://<Hostname>:<Port>/api/<serviceName>ServiceHTTP.

For example, http://localhost:9091/api/aopdService.

The naming convention for SOAP action is /api/<serviceName>.

The naming convention for JMS destination is tibco.aff.<shortnameformodule>.services.<servicenamelowercase>.

For example, tibco.aff.oms.ordersService.

If AOPD is running in colocated mode, the host name is omsServer. If AOPD is running in standalone mode, the host name is aopd.

The operations specified in the table follow the naming conventions.

Services and Operations Summary
Module Service JMS Destination Operation
Order Management (OM) Order tibco.aff.oms.ordersService CancelOrder
GetOrderDetails
GetOrders
GetOrderExecutionPlan
GetEnrichedExecutionPlan
SubmitOrder
AmendOrder
SyncSubmitOrder
WithdrawOrder
FetchAuthenticationToken
PerformBulkOrderAction
ActivateOrder
SuspendOrder
Purge N/A purgeOrders
getPurgeStatus
getPurgeEstimate
Offline Catalog N/A RequestOfflineCatalog
Purge
Automatic Order Plan Development (AOPD) AOPD tibco.aff.aopd.aopdService generatePartialPlan
generatePlan
Note: For all the web services to work correctly, the data models should be available to Orchestrator and Automatic Order Plan Development (AOPD) components.