Service Provider Login

Provides login/logout capabilities for backwards compatibility only
Provides a way for prospective service providers to request a Service Provider Account.

Interface: SpLogin

The endpoint for this interface is: http://<host>:<port>/prm_sp/services/SpLogin

Where the value of host and port depend on the Oracle Communications Services Gatekeeper deployment.

Used by an application to login and retrieve a loginTicket that servers as an identifier when the Service Provider interface is used.

Table 6-1 String login(spAccountId, password)
Parameter Name	Type	Description
Input
spAccountId	xsd:string	The ID of Service provider Account. See registerSpAccountReq for information on how to request a Service Provider Account.
password	xsd:string	The password associated with the Service Provider login account.
Returns
loginReturn	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
ACCESS_DENIED
CommonException

logout(Deprecated. For backwards-compatibility only)

Used by an application to logout.This method call destroys the login session and the corresponding loginTicket

Table 6-2 logout(loginTicket)
Parameter Name	Type	Description
Input
loginTicket	xsd:string	The loginTicket retrieved when logging in.
Returns
logoutReturn	void
Possible Exceptions
ACCESS_DENIED
CommonException

registerSpAccountReq

Table 6-3 registerSpAccountReq(spAccountId, spAccount, password)
Parameter Name	Type	Description
Input
spAccountId	xsd:string	The desired ID the Service Provider Account.
spAccount	tns1:SpAccount	Data structure with details on the Service Provider account. See SpAccount.
password	xsd:string	The password associated with the Service Provider login account.
Returns
registerSpAccountReqReturn	void
Possible Exceptions
ACCESS_DENIED
CommonException

Exceptions

CommonException

This exception is raised when the login session has expired or there are communication problems with the underlying platform.

Complex data types

SpAccount

Table 6-4 appAccount
Element name	Datatype	Description
Name	xsd:string	Name of the Service Provider.
Address	xsd:string	Address of the Service Provider.
EMailAddress	xsd:string	E-mail address of the Service Provider.
ContactPerson	xsd:string	Contact person at the Service provider.
PhoneNumber	xsd:string	Phone number to the Service Provider.
Properties	mpl:ArrayOf_tns1_Property	CRM/PRM application-defined name value pairs. See Property.

Property

Array of name-value pairs. This datatype is used in several other datatypes specific for this interface. The properties are accessible from the Service Provider interface and the Operator interface, so they can be used for communicating information between the Service Provider and the Operator

Table 6-5 Property
Element name	Datatype	Description
Name	xsd:string	Name of the property, with the value defined in Value. Unique with the array.
Value	xsd:string	The data associated with Name.

Integration Guidelines for Partner Relationship Management