Skip navigation.

API Description for Extended Web Services

  Previous Next vertical dots separating previous/next from contents/index/pdf Contents View as PDF  
Get
Adobe Reader

Access

The following sections provide detailed information about the Access service capability:

 


Web Service

The access Web Service provides an application with functions for application session management and password management.

When an application session has been created, a loginTicket is returned. This loginTicket is used to identify login session.

applicationLogin

Used by an application to login and retrieve a loginTicket.

Table 3-1 applicationLogin(serviceProvider, application, applicationInstanceGroup, password)

Parameter Name

Type

Description

serviceProvider

xsd:string

ID of the service provider as given by the operator or the service provider.

Input



application

xsd:string

ID of the application as given by the operator or the service provider.

applicationInstanceGroup

xsd:string

ID of the application instance group as given by the operator or the service provider.

password

xsd: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



applicationLoginReturn

xsd:string

Returns a LoginTicket used to identify the login session. This ticket shall be supplied in the SOAP header for each method invocation.

Possible Exceptions



AccessException


See AccessException.

GeneralException


See GeneralException.

applicationLogout

Used to login an application to the underlying system. Destroys the login session and the corresponding loginTicket.

Table 3-2 applicationLogout(loginTicket)

Parameter name

Type

Description

Input



loginTicket

xsd:string

The loginTicket retrieved when logging in.

Returns



Void.



Exceptions



AccessException


See AccessException.

GeneralException


See GeneralException.

changeApplicationPassword

Used to change the password for an application.

Table 3-3 changeApplicationPassword(loginTicket, oldPassword, newPassword)

Parameter Name

Type

Description

Input



loginTicket

xsd:string

The loginTicket retrieved when logging in.

oldPassword

xsd:string

The current password.

newPassword

xsd:string

The new password.

Returns



Void.



Exceptions



AccessException


See AccessException.

GeneralException


See GeneralException.

Exceptions

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.

Complex data types

-

 


Listener interface

There is no listener interface for the Access Web Service.

 

Skip navigation bar  Back to Top Previous Next