API Description for Parlay X
Access
A normal Parlay X web services user (without the right to use the administrative parts) can perform the following tasks:
- Login
- Log out
- Change password
The methods described below are not a part of the Parlay X standard, since Parlay X does not deal with users and user administration but leaves this to each implementation:
Access API
applicationLogin
Used by an application to login and retrieve a loginTicket.
Table 3-1 applicationLogin(serviceProvider, application, applicationInstanceGroup, password)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
serviceProvider
|
String
|
ID of the service provider as given by the operator or the service provider.
|
|
application
|
String
|
ID of the application as given by the operator or the service provider.
|
|
applicationInstanceGroup
|
String
|
ID of the application instance group as given by the operator or the service provider.
|
|
password
|
String
|
Password for the application as given by the operator
or the service provider. Note that this may also have been changed by the by the application provider.
|
|
Returns
|
|
|
String
|
ID of the login-session. This ID is used for each request towards WebLogic Network Gatekeeper.
Shall be used to access other Parlay X services. The ID shall be sent in the SOAP header of every SOAP operation.
|
|
Possible exceptions
|
|
AccessException
|
|
GeneralException
|
applicationLogout
Used to logout an application from the underlying system. Destroys the login session and the corresponding loginTicket.
Table 3-2 applicationLogout(loginTicket)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
loginTicket
|
String
|
ID of the login-session. The loginTicket retrieved when logging in.
|
|
Returns
|
|
|
-
|
|
|
Possible exceptions
|
|
AccessException
|
|
GeneralException
|
changeApplicationPassword
Used to change the password for an application.
Table 3-3 changeApplicationPassword(loginTicket, oldPassword, newPassword)
|
Parameter Name
|
Type
|
Description
|
|
Input
|
|
loginTicket
|
String
|
ID of the login-session. The loginTicket retrieved when logging in.
|
|
oldPassword
|
String
|
The current password.
|
|
newPassword
|
String
|
The new password.
|
|
Returns
|
|
|
-
|
|
|
Possible exceptions
|
|
AccessException
|
|
GeneralException
|
Exceptions
Table 3-4 Exceptions specific for Access
|
Exception
|
Description
|
|
AccessException
|
Exceptions of this type are raised when there are error conditions related to the Access Web Service. Other error conditions are reported using the exception GeneralException.
|
|
GeneralException
|
This exception is raised when the applications session has expired or there are communication problems with the underlying platform.
|
