PCSP SOAP API
Revised: April 9, 2008, OL-15381-05
The PacketCable specification details the Simple Object Access Protocol (SOAP) message interface. This message specification is the "defacto application programming interface (API)" to the BTS 10200 through this interface.
User level security or Web Services User Security (WSUS) is a separate service offering that enables the BTS 10200 user security within the confines of PacketCable provisioning.
Login/Logout: User Security API
The Web Services Description Language (WSDL) for the security interface is defined below. A full listing of the WSDL is provided in the appendix. The WSUS service is provided to create user login sessions that parallel the behavior of login sessions of the BTS 10200 CLI. This allows for the application of command authorization and authentication for the PacketCable service.
Note In the PacketCable specification, user or session level security is not addressed. There is a need for these capabilities which allow for differentiation of users. This need may be addressed in a future release.
The interface offers two basic SOAP message containers and one generic fault container. The service name is "Bts10200SecurityService" and the default URL for the service is https://localhost/wsus/services/bts10200Security
The service coexists with the PacketCable Subscriber Provisioning (PCSP) service and has the following messages:
•login—This is the basic login function that authenticates and returns a session key.
•loginWithStatus—This function processes a normal login. It also checks for warnings on the expiration of the password and returns a status string indicating the status of the password. For example, if the password is about to expire, a warning status is returned. A session key is returned as part of the function.
•loginResetPassword—This function allows the user to access the system and log in under normal authentication. It resets the user password to a new value. This clears any warning indication about password expiration.
•logout—This terminates any session associated with the supplied session key.
•BtsUserException - This is the general fault defined in the Bts10200SecurityService. It contains a descriptive string and numeric value for the associated fault that occurred in the WSUS service.
The WSDL for this interface is defined below. A full listing of the WSDL is provided in the appendix. The interface offers three basic SOAP messages and one generic fault container.
The basic PacketCable Subscriber Provisioning or PCSP service is accessible through the general URL format: https://localhost/axis/services/PcspI01Service.
The interface offers three basic message constructs (listed below). The three constructs provide all the defined input and output for the basic PCSP service.
•PUT—The PUT message accepts an array of homogenous objects to be processed as either an add or a change function. The type of function is defined in the command status field. This alters or adds elements in the BTS 10200 database. A response consisting of homogeneous argument objects is returned.
•GET—The GET message accepts a homogenous array of arguments defined as "keys" to indicate which database elements are to be returned in this request. The reply is a homogenous array of objects generated from the show or display request.
•DELETE—The DELETE message accepts an array of homogenous arguments defined as "keys" to indicate which elements of the database are to be removed. A response consisting of argument objects is returned to indicate the success or failure of the request.
The provisioning of PcspCiscoBtsCli is a propriety extension to PacketCable1.5 specific for Cisco BTS 10200. Only the PUT messaging interface is supported. The DELETE and GET messaging interfaces do not allow XmlEncoding to support the necessary information for the request. Inside the PUT messaging interface, a PcspObj is passed in as the parameter. For the interface to invoke the PcspCiscoBtsCli object, the following must be set in the PcspObj:
The PcspObj.cmdStatus field is not used and is ignored. The key is the noun portion as specified in BTS CLI syntax: "<verb> <noun> <parameters>". The XmlEncoding is the request (or response) and is exactly the same syntax as in the BTS generic SOAP/XML and CORBA interface currently available. For further details of this existing syntax, please refer to the programmer's guide for the CORBA interface or the Generic SOAP/XML.