Overview

1 Overview

The deprecated Oracle Communications Session Delivery Manager SOAP API is a SOAP and XML provisioning Application Programming Interface (API) client and server programing model that enables users to write client applications that automate the provisioning of devices. The web service consists of operations that can be performed on devices managed by the Oracle Communications Session Delivery Manager server and data structures that are used as input and output parameters for these operations.

Important:

With the introduction of Oracle Communications Session Delivery Manager, Release 8.0, the SOAP API client is provided for backwards compatibility only. The SOAP API will not support any new APIs for new SDM enhancements. Use the REST API for Oracle Communications Session Delivery Manager if you require access to new SDM features via a programmatic API.

The Oracle Communications Session Delivery Manager server accepts and responds to requests from clients that are coded to use the API. The server responds to requests to read and update configuration data in the Oracle Communications Session Delivery Manager SOAP API database or apply configurations to devices in the same way in which it responds to requests from the GUI client application. These messages that are exchanged between SOAP and XML clients and the server are encapsulated in the standard Simple Object Access Protocol (SOAP) format, as defined by the World Wide Web Consortium (W3C).

The provisioning API has the following components:

Active configuration—The read-only configuration on the device.
Session ID—Identifies the connection that is established between a SOAP client application instance and the Oracle Communications Session Delivery Manager server. The session ID (SID) is used by the server to distinguish between multiple clients currently logged in, and is a required parameter for almost all operations supported by the API.
Managed device—The API supports all managed objects (configuration elements) and sub-objects (sub-elements) available on the device.

Note:
This guide covers the basic configuration parameters for session delivery product devices. See your session delivery product device documentation, such as its ACLI guide, for more configuration information that is beyond the scope of this guide and may be specific to the release of the your devices.