DlsAPI

DlsAPI = Deployment Service Application Programming Interface

Definition
DlsAPI is the WebService interface provided by Deployment Service.

Overview
This overview is an excerpt from release notes:

DLS provides an API that can be used to perform certain tasks on the DLS without using the GUI. It is a WebService based API called DlsAPI. DlsAPI does not provide equal functionality as the DLS-GUI, but is evolving continuously (driven by various project and customer requests).

DLS V2 and later provides both DlsAPI v100 (as released with DLS V1) and new methods as part of DlsAPI v200.

While DlsAPI v100 methods support IP Phones only, DlsAPI v200 methods also support IP Clients and IP Gateways. The DlsAPI is deployed with the DLS installation unit, in the folder: \DeploymentService\api

The folder contains:
 * 1) dlsapiv100.wsdl – the wsdl for the DlsAPI interfaces available in v100
 * 2) dlsapiv100.jar - the WSDL2JAVA result, especially the client stubs and the service locator. This can be used by JAVA clients as interface to the DlsAPI v100.
 * 3) dlsapiv200.wsdl – the wsdl for new DlsAPI interfaces available in v200
 * 4) dlsapiv200.jar - the WSDL2JAVA result, especially the client stubs and the service locator. This can be used by JAVA clients as interface to the DlsAPI v200.
 * 5) doc – subfolder with the DlsAPI interface description (Javadoc format)

On an installed and running DLS server (on Windows OS), the links to the WSDLs are: https:// :10444/DeploymentService/services/DlsAPIv100 https:// :10444/DeploymentService/services/DlsAPIv200

The link to the online documentation of DlsAPI is: https:// :10443/DeploymentService/dlsapidoc/

The same links are also valid for DLS installed on OpenScape Voice/UC servers (Linux OS) - but using the default port for https (443).

DlsAPI Documentation

 * - The PHP scripts mentioned in the DlsAPI-Overview document above. The scripts are "free software", and not actively maintained - so use at your own risk. [mailto:admin-support@wiki-siemens-enterprise.com?subject=DlsAPI-Test-Scripts Feedback] regarding bugs/experiences or your own adaptations/enhancements are appreciated anyway. Parts of the scripts are licensed under the terms of GNU Lesser General Public License. See the included file nusoap.php for details.
 * - The DlsAPI documentation. Note: please refer to the DLS installation unit itself for the latest version of the documentation. Last document upload Feb/17/2012

The following documents also cover some aspects of the DlsAPI:
 * - A DLS Overview slide set which includes an introduction to DlsAPI.
 * - DLS Technical description with focus on 802.1x