Oracle® Communications Services Gatekeeper Partner Relationship Management Guide Release 5.1 E37536-01 |
|
|
PDF · Mobi · ePub |
Oracle Communications Services Gatekeeper supports the following functionality in the Service Provider Login Web Service interface:
login/logout capabilities for backwards compatibility only
a way for prospective service providers to request a Service Provider Account.
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.
Note that the login method is deprecated. It is described here for backwards compatibility only.
When supported, login was used by an application to log in. This method returns a loginTicket that serves as an identifier for the session in the Service Provider interface.
The syntax for login:
login(spAccountId,password)
Table 5-1 describes the input parameters:
Table 5-1 Input Parameters for Login
Parameter Name | Type | Description |
---|---|---|
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. |
Note that logout method is deprecated. It is described here for backwards compatibility only.
When supported, logout was used by an application to log out. This method destroys the login session and the corresponding loginTicket.
The syntax for logout:
logout(loginTicket)
where, loginTicket is the identifier retrieved at the time of logging in.
The registerSpAccountReq method is used to request a new Service Provider Account. When this request has been approved by the operator, see "registerSpAccountRes", the Service Provider can log in to the Partner Relationship Management module. For more information on the approval by the operator, see "registerSpAccountRes".
The syntax for registerSpAccountReq:
registerSpAccountReq(spAccountId, spAccount, password)
Table 5-2 describes the input parameters:
Table 5-2 Input Parameters for registerSpAccountReq
Parameter Name | Type | Description |
---|---|---|
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. |
The Service Provider Login Web Service interface uses the following complex datatypes.
Table 5-3 provides a description of a Service Provider Account, including contact details.
Table 5-3 Contents of an SpAccount
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 |
Customer relationship management (CRM)/Partner relationship management (PRM) application-defined name value pairs. See "Property". |
This is an 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.