# Welcome

This documentation is the specification for the Akixi Web Services Application Programming Interface (API). The Web Services Application Programming Interface (will be referred to as “WS API”, “Web Services”, or “WS” interchangeably hereafter) allows the remote application to perform Akixi Application administrative tasks programmatically. Administrative tasks can be automatically invoked from your client-side logic by building SOAP requests and processing server-side responses. Web Services can significantly reduce the amount of time spent on performing routine tasks that were previously available via Web-based Akixi User Interface only. In order to fully understand this document, the reader should have the following knowledge & experience:

• Akixi Web Application.
• XML.
• SOAP.
• WSDL.

If you would like to learn more about the Akixi Application/Service or about its provisioning concepts & application components used by the Akixi WS API, the “Useful Links & Resources” chapter can be a good start. If you have any queries or suggestions regarding Web Services documentation or functionality, please do not hesitate to contact Akixi Support. Note that the Akixi Application will also be referred to as the “Akixi Service” interchangeably hereafter.

# What’s In This Documentation?

• Getting Started provides an introduction to SOAP-based Web Services as well as the basic SOAP message structure used by the Akixi Service.

• Authentication covers Web Service API authentication in detail.

• Administrative Operations is a detailed guide on every possible provisioning operation that can be performed via the Akixi Web Services API.

• Akixi Web Services Data Types lists the different data types supported by the API.

• Web Services Properties provides a comprehensive reference for every Property and/or setting that can be configured via the API.

• Error Codes gives a complete reference for all supported error codes returned from Web Services API operations.

• Provisioning System Implementation Guidance contains guidance for how to implement programmatic logic for automatically updating the Akixi Service configuration from Telephony Provider or Reseller provisioning systems. This is a “must read” chapter for Cisco BroadWorks system developers and/or integrators.

• Developing Client Applications provides an overview of the sample code that is available separately, which demonstrates how to consume & invoke the Akixi Web Services API as a remote client using Oracle Java as the programming language implementation.