This interface is deprecated and will be removed in a future release. Oracle recommends that you use the REST-based interfaces instead.
This appendix describes the SOAP-based Web Service interface that Oracle Communications Services Gatekeeper supports. You use this interface to extend and customize the GUIs supplied with pre-6.0 Services Gatekeeper releases.
The functionality in the Web services interface is organized in the following way:
Individual interfaces have their own error messages. These error messages are common across all interfaces:
"The appAccount in registered PENDING state"
"The spAccount in registered PENDING state"
"The AppInstGroup isn't in update pending status"
"The AppAccount not in update pending status"
"access failed"
"The AppInstanceGrp not exist"
"The AppInstanceGrp not belong to the AppAccount"
"Application not existed"
"the Application doesn't belong to the SpAccount"
"Application in register pending status"
"The AppAccount not exist"
"The AppAccount doesn't belong to the Sp"
"Sp Account in register pending state"
"Sp Account in register pending state"
Services Gatekeeper supports the following functionality in the Service Provider Login Web Service interface:
Login/logout capabilities for backward 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 Services Gatekeeper deployment.
The registerSpAccountReq method is used to request a new Service Provider Account. When this request has been approved by the operator, the Service Provider can log in to the Partner Relationship Management module. For more information on the approval by the operator, see "registerSpAccountRes".
Table C-1 describes the input parameters:
Table C-1 registerSpAccountReq Input Parameters
| 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 possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
The Service Provider Login Web Service interface uses the following complex data types.
Table C-2 describes of a Service Provider Account, including contact details.
Table C-2 Contents of an SpAccount
| Element name | Data Type | 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 data type is used in several other data types 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 C-3 describes the elements of a property.
The Operator Login Web Service in Services Gatekeeper's Partner Relationship Management module is provided for backward compatibility only. The current implement of PRM is sessionless.
The endpoint for this interface is:
http://<host>:<port>/prm_op/services/OpLogin
Where the value of host and port depend on the Services Gatekeeper deployment.
The Service Provider Service Web Service provides the Service Provider with operations for handling Service Provider Accounts, Application Accounts, and Applications Instances in Services Gatekeeper.
The endpoint for this interface is:
http://host:port/prm_sp/services/SpService
where the value of host and port depend on the Services Gatekeeper deployment.
This interface can generate these error messages:
"changeSpAccountPassword failed"
"setAppInstGroupPassword failed"
"getAppAccountSla failed"
"getSpAccountSla failed"
"getAppAccountSlaByType failed"
"getSpAccountSlaByType failed"
"getAppInstGroupState failed"
"getAppInstGroup failed"
"listAppInstGroups failed"
"deactivateAppInstGroup failed"
"activateAppinstGroup failed"
"deactivateAppAccount failed"
"activateAppAccount failed"
"getAppAccountState failed"
"getAppAccount failed"
"listAppAccounts failed"
"Only ACTIVE status can be updated"
"Only DEACTIVE status can be deleted!"
"the AppAcount existed already!"
The deleteSpAccountReq method makes a request to delete the Service Provider Account. The request must be approved before the Service Provider Account is deleted. This is done by the operator, using "deleteSpAccountRes".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The Service Provider Account's state cannot be deleted. For a Service Provider Account to be deleted, it must be in the INACTIVE state.
Deactivates the Service Provider Account, which changes the state of the account to INACTIVE.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The Service Provider Account is not in an appropriate state to allow the account to be deactivated.
Activates the Service Provider Account. which changes the state of the account to ACTIVE.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The Service Provider Account is not in an appropriate state to allow the account to be activated.
Retrieves details about the Service Provider Account. The details include contact details and customer relationship management (CRM)/partner relationship management (PRM) application-defined properties in the form of name-value pairs.
A data structure with details on the Service Provider account. See "SpAccount".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves the state of the Service Provider Account. This operation takes no input parameters.
Information of the state of the Service Provider Account. See "State".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Requests registration of an Application Account for the Service Provider Account. This request must be approved by the Operator: see "registerAppAccountRes".
Table C-4 describes the input parameters.
Table C-4 registerAppAccountReq Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appAccount |
tns1:AppAccount |
A data structure with details about the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See "AppAccount". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application account is not in the correct state to be registered.
Requests deletion of an Application Account associated with the Service Provider Account. The request must be approved by the Operator before the Application Account is deleted using "deleteAppAccountRes". The Application Account must be in state INACTIVE in order for this call to be accepted.
deleteAppAccountReq(appAcountId)
Where appAcountId is the ID of the application account.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application account is not in the right state to be deleted. The application account must be in the INACTIVE state before it can be deleted.
Requests an update of the Service Provider Account with new data.
Table C-5 describes the input parameters.
Table C-5 updateSpAccountReq Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountID |
xsd:string |
The ID of the service provider account. |
|
spAccount |
tns1:AppAccount |
The data structure with details on the Service Provider Account, including CRM/PRM application-defined properties in the form of name-value pairs. See "SpAccount". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The Service Provider Account is in an incorrect state and cannot be updated.
Requests an update to an Application Account associated with the Service Provider with new data.
Table C-6 describes the input parameters.
Table C-6 updateAppAccount Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appAccount |
tns1:AppAccount |
A data structure with details about the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See "AppAccount". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application account is in an invalid state and cannot be updated.
Requests an update on an Application Instance. The request must be approved by the Operator. See "updateAppInstGroupRes".
Table C-7 describes the input parameters.
Table C-7 updateAppInstGroupReq Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appInstGroupId |
xsd:string |
The ID of the Application Instance. |
|
appInstGroup |
tns1:AppInstGroup |
A data-structure with the Application Instance CRM/PRM application-defined properties in the form of name-value pairs. See "AppInstGroup". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application instance is in an invalid state and an update request cannot be made.
Requests a deletion of an Application Instance. The request must be approved by the Operator. This is done using "deleteAppInstGroupRes".
Table C-8 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application instance is in an invalid state and the deletion request cannot be processed.
Lists all Application Account IDs for the Service Provider. The result is filtered based on the state of the Application Account.
listAppAccounts(state)
Where state indicates the states on which to filter the result. See "State".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves details about a specific Application Account. The operation returns a data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs.
getAppAccount(appAccountId)
Where appAccountId is the ID of the application account.
Returns a data structure with details about the Application Account. See "AppAccount".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves the state of a specific Application Account.
getAppAccountState(appAccountId)
Where appAccountId is the ID of the application account.
Returns information on the state of the Application Account. See "State".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Activate an Application Account, which changes the state of the account to ACTIVE. The current state of the account must be INACTIVE.
activateAppAccount(appAcountId)
Where appAcountId is the ID of the application account.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application account is in an invalid state and cannot be activated.
Deactivates an Application Account, which changes the state of the account to INACTIVE. The current state of the account must be ACTIVE.
deactivateAppAccount(appAcountId)
Where appAcountId is the ID of the application account.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application account is in an invalid state and cannot be deactivated.
Activates an Application Instance, which changes the state of the instance to ACTIVE.
Table C-9 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The Application Instance is not in an appropriate state to allow the account to be activated.
Gets the state of an Application Instance.
Table C-10 describes the input parameters.
Returns the state of the Application Instance. See "State".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Deactivates an Application Instance, which changes the state of the group to INACTIVE.
Table C-11 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The Application Instance is not in an appropriate state to allow the account to be deactivated.
Requests the registration of an Application Instance for a specific Application Account. When this request has been approved by the Operator (see "registerAppInstGroupRes") an application has all credentials necessary to be authenticated on the traffic interfaces of the Services Gatekeeper.
Table C-12 describes the input parameters.
Table C-12 registerAppInstGroup Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appInstGroupId |
xsd:string |
The ID of the Application Instance to be registered. |
|
appInstGroup |
tns1:AppInstGroup |
The CRM/PRM application-defined properties in the form of name-value pairs. See "AppInstGroup". |
|
password |
xsd:string |
The password the application will use when authenticating on Services Gatekeeper |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
INVALID_STATE: The application instance is in an invalid state and cannot be registered.
Lists all Application Instances for an Application Account. Filtering is possible on the state of the Application Instance
Table C-13 describes the input parameters.
Table C-13 listAppInstGroup Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
state |
tns1:State |
Indicates which states to filter the result on. See "State". |
Returns a list of all Service Application Instance IDs matching the given criteria in a string array.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves details about a specific Application Instance.
Table C-14 describes the input parameters.
Returns a data structure with details about the Application Instance. See "AppInstGroup".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves an SLA of a given type for the Service Provider Account.
getSpAccountSlaByType(slaType)
Where slaType is the SLA type to retrieve.
Use:
service_provider
system:geo_service_provider
service_provider_node
a custom SLA type ID
For information on the different types, see ”Managing SLAs” in Services Gatekeeper Accounts and SLAs Guide.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves an SLA of a given type for the Application Account.
Table C-15 describes the input parameters.
Table C-15 getAppAccountSlaByType Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
slaType |
xsd:string |
The SLA type to retrieve. Use:
For information on the different types, see ”Managing SLAs” in Services Gatekeeper Accounts and SLAs Guide. |
|
appAccountId |
xsd:string |
The Application Account to retrieve the SLA for. |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Set the password associated with an Application Instance. This password is a part of the credentials an application uses to be authenticated on the traffic interfaces exposed by Services Gatekeeper.
Table C-16 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Change the Service provider Account password. This password is the password the Service Provider use to login to the Service Provider part of the Partner Management Interfaces exposed by Services Gatekeeper.
Table C-17 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
This section describes the complex data types used by the Service Provider Service interface.
Table C-18 provides the description of an Application Account.
| Element name | Data Type | Description |
|---|---|---|
|
Name |
xsd:string |
Descriptive name of the Application Account. |
|
Description |
xsd:string |
Short description of the Application Account. |
|
Properties |
impl:ArrayOf_tns1_Property |
CRM/PRM application-defined name value pairs. See "Property". |
Table C-19 describes the container for the CRM/PRM application-defined properties.
| Element name | Data Type | Description |
|---|---|---|
|
Name |
xsd:string |
Descriptive name of the Application Instance. |
|
Description |
xsd:string |
Short description of the Application Instance. |
|
SLA |
xsd:string |
The SLA for the Application Instance. Is always ”1” as the SLA feature is no longer used. |
|
Properties |
mpl:ArrayOf_tns1_Property |
CRM/PRM application-defined properties. Name-value pairs. See "Property". |
Array of name-value pairs, as shown in Table C-20. This data type is used in several other data types 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 C-21 provides the description of a Service Provider Account, including contact details.
| Element name | Data Type | 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". |
Defines the state of a Service Provider Account, Service Provider Group, Application Account, Application Group, or Application Instance. Enumeration, as shown in Table C-22.
See "Account States" for more information about states, and transitions between different states.
| Element name | Data Type | Description |
|---|---|---|
|
REGISTERED |
xsd:string |
The account or group is has been registered. The Operator must respond to this registration request. |
|
ACTIVE |
xsd:string |
Normal mode. |
|
INACTIVE |
N/A |
No traffic is allowed through the Services Gatekeeper when the account or group is in this state. |
|
UPDATE_PENDING |
N/A |
There is a pending update request. The request must be responded to by the Operator. |
|
DELETE_PENDING |
N/A |
There is a pending delete request on the account or group. The request must be responded to by the Operator |
|
LOCKED |
N/A |
Only valid for an Applicator Instances. For backward compatibility only. The group can be locked due to too many consecutive failed login attempts from an application. |
The Operator Service Web Service provides the Operator with operations for handling Service Provider Accounts, Service Provider Groups, Application Accounts, Application Account Groups and Applications Instances in Services Gatekeeper's Partner Relationship Management module.
The endpoint for this interface is:
http://host:port/prm_op/services/OpService
The value of host and port depend on the Services Gatekeeper deployment.
This interface generates these error messages:
”The SP Account not exist”
”Only DEACTIVE status can be deleted!”
”the AppAcount existed already!”
”SP no exist!”
”Application no exist”
Lists all Application Groups.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves details about a specific Application Group.
Returns a data structure with details about the Application Group. See "AppGroup".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Creates a new Application Group with a certain ID with an associated SLA.
Table C-23 describes the input parameters.
Table C-23 createAppGroupByType Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
slaType |
xsd:string |
The SLA type to update. Use:
For information on the different types, see ”Managing SLAs” in Services Gatekeeper Accounts and SLAs Guide. |
|
appGroupId |
xsd:string |
ID of the Application Group. |
|
appGroup |
tns1:AppGroup |
A data structure describing the group. See "AppGroup". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Deletes an Application Group. All Application Accounts must be removed from the group before it can be deleted.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Associates an Application Account for a specific Service Provider with an Application Group.
Table C-24 describes the input parameters.
Retrieves the ID of the Application Group for a given Service Provider Account and Application Account combination.
Table C-25 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if any of the accounts does not exist or no group is associated.
Updates an Application Group with a new SLA.
Table C-26 describes the input parameters.
Table C-26 updateAppGroupByType Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
slaType |
xsd:string |
The SLA type to update. Use:
For information on the different types, see ”Managing SLAs” in Services Gatekeeper Accounts and SLAs Guide. |
|
appGroupId |
xsd:string |
The ID of the group. |
|
appGroup |
tns1:AppGroup |
The Application-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See "AppGroup". |
Lists all Service Provider Groups. This operation requires no input.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves details about a specific Service Provider Group.
Returns a data structure with details about the Service Provider Group. See "SpGroup".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Creates a new Service Provider Group with a certain ID with a certain SLA type associated.
Table C-27 describes the input parameters.
Table C-27 createSpGroupByType Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
slaType |
xsd:string |
The SLA type to update. Use:
For information on the different types, see ”Managing SLAs” in Services Gatekeeper Accounts and SLAs Guide. |
|
spGroupId |
xsd:string |
ID of the Service Provider Group ID. |
|
spGroup |
tns1:SpGroup |
A data structure describing the group. See "SpGroup". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Deletes a Service Provider Group. All Service Provider Accounts associated with the group must be removed before it can be deleted
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if there are Service Provider accounts associated with the group.
Associates a Service Provider Account with a Service Provider Group.
Table C-28 describes the input parameters.
Updates a Service Provider Group with a new SLA.
Table C-29 describes the input parameters.
Table C-29 updateSpGroupByType Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
slaType |
xsd:String |
The SLA type to update. Use:
For information on the different types, see ”Managing SLAs” in Services Gatekeeper Accounts and SLAs Guide. |
|
spGroupId |
xsd:string |
The ID of the group. |
|
spGroup |
tns1:SpGroup |
The Service Provider-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See "SpGroup". |
Lists all Application Instances for a given combination of Service Provider Account and Application Account. Filtering is possible on the state of the Application Instance
Table C-30 describes the input parameters.
Table C-30 listAppInstGroups Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. Use null to not filter on this parameter. |
|
appAccountId |
xsd:string |
The ID of the Application Account. Use null to not filter on this parameter. |
|
state |
tns1:State |
Indicates which states to filter the result on. See "State". |
Returns a data structure containing a references to the Application Instance. See "AppInstGroupRef".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Retrieves details about a specific Application Instance.
Table C-31 describes the input parameters.
Returns a data structure with details about the Application Instance. See "AppInstGroup".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Gets the state of specific Application Instance.
Table C-32 describes the input parameters.
Returns the state of the Application Instance. See "State".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Requests registration of an Application Instance for a specific combination of a Service Provider Account and Application Account. When this request has been approved (see "registerAppInstGroupRes") the newly registered application has all the credentials necessary to be authenticated on the traffic interfaces of the Services Gatekeeper.
registerAppInstGroupReq(spAccountId, appAccountId, appInstGroupId, appInstGroup, password)
Table C-33 describes the input parameters.
Table C-33 registerAppInstGroupReq Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appInstGroupId |
xsd:string |
The ID of the Application Instance to be registered. |
|
appInstGroup |
tns1:AppInstGroup |
CRM/PRM application-defined properties in the form of name-value pairs. |
|
password |
xsd:string |
The password the newly created Application Instance will use when authenticating on the Services Gatekeeper |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired or there are communication problems with the underlying platform.
Requests deletion of an Application Instance. The Application Instance must be in state INACTIVE in order for this call to be accepted. The request must be approved before the Application Instance is deleted. This is done using "deleteAppInstGroupRes".
Table C-34 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if there is an SLA associated with the combination of Service Provider Accounts, Application Account, and Application Instance associated with the group.
INVALID_STATE: This exception is raised if the application is not in an INACTIVE state.
Responds to a request for deleting an Application Instance for a specific combination of Service Provider Account and Application Account.
It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Instance. If approved, the Application Instance is deleted, and the Application Instance can no longer be used to authenticate to send the traffic to Services Gatekeeper.
Table C-35 describes the input parameters.
See "RequestResponse" for details on the return parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if there is an SLA associated with the combination of Service Provider Accounts, Application Account, and Application Instance associated with the group.
INVALID_STATE: This exception is raised if the application is not in an INACTIVE state.
Updates an Application Instance Group with new data.
Table C-36 describes the input parameters.
Table C-36 updateAppInstGroup Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account |
|
appInstGroupId |
xsd:string |
The ID of the Application Instance |
|
appInstGroup |
tns1:AppInstGroup |
A data-structure with the Application Instance SLA and application-defined properties in the form of name-value pairs. See "AppInstGroup". |
Responds to a request for updating Application Instance for a specific combination of Service Provider Account and Application Account.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Application Instance to state ACTIVE. If approved, the Application Instance is updated with the new information.
Table C-37 describes the input parameters.
See "RequestResponse" for details on the return parameters.
Gets details about an specific Application Instance that is in state UPDATE_PENDING. The details include CRM/PRM application-defined properties in the form of name-value pairs.
Table C-38 describes the input parameters.
Returns CRM/PRM application-defined properties in the form of name-value pairs. See "AppInstGroup".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if group does not exist or if the SLA contains errors.
INVALID_STATE: This exception is raised if the application is not in an INACTIVE state.
Sets the password associated with an Application Instance. This password is a part of the credentials an application uses to authenticate to send traffic to Services Gatekeeper.
Table C-39 describes the input parameters.
Table C-39 setAppInstGroupPassword Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account |
|
appInstGroupId |
xsd:string |
The ID of the Application Instance |
|
newPassword |
xsd:string |
The new password. |
Unlock a locked Application Instance Group. The group may have been locked by too many faulty login attempts to the traffic interfaces exposed by the Services Gatekeeper.
Table C-40 describes the input parameters.
Activates a Service Provider Account, which changes the state of the account to ACTIVE.
Table C-41 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the account does not exist.
INVALID_STATE: Exception thrown if the Service Provider Account is not in an appropriate state to allow the account to be activated.
Deactivates a a Service Provider Account, which changes the state of the account to inactive.
Table C-42 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the account does not exist.
INVALID_STATE: Exception thrown if the Service Provider Account is not in an appropriate state to allow the account to be deactivated.
Retrieves details about a specific Service Provider Account. The details include contact details and CRM/PRM application-defined properties in the form of name-value pairs.
Table C-43 describes the input parameters.
Returns a structure with details on the Service Provider account. See "SpAccount".
Retrieves the state of a specific Service Provider Account.
Table C-44 describes the input parameters.
Returns information on the state of the Service Provider account. See "State".
Requests registration for an Application Account for a specific Service Provider Account. When this request has been approved by the Operator (see "registerAppAccountRes") the Application Account can be associated with an Application Account Group and an Application Instance.
Table C-45 describes the input parameters.
Table C-45 registerAppAccountReq Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appAccount |
tns1:AppAccount |
A data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See "AppAccount". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: This exception is raised if the application is in an invalid state.
Responds to a request to register an Application Account for a specific Service Provider Account. An Application Account Group is also associated with the Application Account.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Application Account. If approved, the Application Account is transferred into state ACTIVE. If Disapproved, the Application Account is deleted.
Table C-46 describes the input parameters.
Table C-46 registerAppAccountRes Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appGroupId |
xsd:string |
The ID of the Application Account Group to be associate with the Application Account. |
|
appAccountRef |
xsd:string |
Internal ID of the Application Account. This ID is used to correlate the Application Account ID with an Operator-internal ID. |
See "RequestResponse" for details on the return parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: This exception is raised if the application is in an invalid state.
Responds to a request to update an Application Account for a specific Service Provider.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Application Account state to Active. If approved, the Application Account is updated with the new information.
Table C-47 describes the input parameters.
See "RequestResponse" for details on the return parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the status of the Application Account is not in state UPDATE_PENDING.
Gets details about pending update requests for a specific combination of Service Provider and Application Account. The details includes descriptions and CRM/PRM application-defined properties in the form of name-value pairs. Valid only for Application Accounts in state UPDATE_PENDING.
Table C-48 describes the input parameters.
Returns a data structure describing the Application Account. See "AppAccount".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the status of the Application Account is not in state UPDATE_PENDING.
Requests the deletion of an Application Account. In order to be deleted, there must be no Application Instance associated with the combination of Service Provider Account and Application Account. The request must be approved before the Application Account is deleted, which is done using "deleteAppAccountRes". The Application Account must be in state INACTIVE in order for this call to be accepted.
Table C-49 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application account does not exist.
INVALID_STATE: Exception thrown if the status of the Application Account is not in state INACTIVE.
Responds to a request to delete an Application Account for a specific Service Provider Account. The Application Account must be in state DELETE_PENDING in order for this call to be accepted.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Application Account. If approved, the Application Account is simply deleted. If Disapproved, the Application Account is transferred into state INACTIVE.
Table C-50 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application account does not exist.
INVALID_STATE: Exception thrown if the status of the Application Account is not in state DELETE_PENDING.
Updates an Application Account with new data.
Table C-51 describes the input parameters.
Table C-51 updateAppAccount Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appAccount |
tns1:AppAccount |
Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See "AppAccount". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application account does not exist.
INVALID_STATE: Exception thrown if the status of the Application Account is in an invalid state.
Retrieves details about a specific Application Account. The return includes a data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs.
Table C-52 describes the input parameters.
Returns a data structure with details about the Application Account. See "AppAccount".
Retrieves the state of a specific Application Account.
Table C-53 describes the input parameters.
Returns information of the state of the Application Account. See "State".
Activates an Application Account, which changes the state of the account to ACTIVE. The current state of the account must be INACTIVE.
Table C-54 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application account does not exist.
INVALID_STATE: Exception thrown if the state of the Application Account does not allow the account to be activated.
Deactivates an Application Account, which changes the state of the account to INACTIVE. The current state of the account must be ACTIVE.
Table C-55 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application account does not exist.
INVALID_STATE: Exception thrown if the state of the Application Account does not allow the account to be deactivated.
Responds to a request to register an Application Instance for a specific combination of a Service Provider Account and Application Group.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Application Instance. If approved, the Application Instance is transferred into state ACTIVE and the application can authenticate with the traffic interfaces exposed by Services Gatekeeper. If disapproved, the Application Instance is deleted.
registerAppInstGroupRes(spAccountId, appAccountId, appInstGroupId, appInstGroupRef, response)
Table C-56 describes the input parameters.
Table C-56 registerAppInstGroupRes Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
appInstGroupId |
xsd:string |
The ID of the Application Instance. |
|
appInstGroupRef |
xsd:string |
Internal ID of the Application Instance. This ID is used to correlate the Application Instance ID with an Operator-internal ID. |
|
response |
tns1:RequestResponse |
The response to the request. See "RequestResponse". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application instance does not exist.
INVALID_STATE: Exception thrown if the state of the Application instance is invalid.
Activates an Application Instance, which changes the state of the Instance to ACTIVE.
Table C-57 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application instance does not exist.
INVALID_STATE: Exception thrown if the state of the Application instance is invalid.
Deactivates an Application Instance, which changes the state of the Instance to INACTIVE.
Table C-58 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Application instance does not exist.
INVALID_STATE: Exception thrown if the state of the Application instance does not allow the account to be deactivated.
Requests registration for a Service Provider Account. Contact details are supplied in the request, together with CRM/PRM application-defined properties. This request must be approved by the Operator (see "registerAppAccountRes").
Table C-59 describes the input parameters.
Table C-59 registerSpAccountReq Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
appAccountId |
xsd:string |
The ID of the Application Account. |
|
password |
xsd:string |
The password the Service Provider will use when authenticating to the Service Provider part of the Partner Relationship Management interface. |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the Service Provider account is not in the correct state.
Lists all Application Account IDs for a specific Service Provider. The result is filtered on the state of the Application Account.
Table C-60 describes the input parameters.
Table C-60 listAppAccounts Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
state |
tns1:State |
Input parameter. Indicates the state on which to filter the result. See "State". |
Returns an array containing references to Application Account Groups. See "AppAccountRef".
Lists all Service Provider Account IDs. The result is filtered on the state of state of the Service Provider Account.
Table C-61 describes the input parameters.
Table C-61 listAppAccounts Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
state |
tns1:State |
Input parameter. Indicates the state on which to filter the result. See "State". |
Responds to a request to register a Service Provider Account.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Service Provider Account. If approved, the Service Provider Account is transferred into state ACTIVE and the Service provider can authenticate with the PRM-SP Web Services. If Disapproved, the Service Provider Account is deleted.
Table C-62 describes the input parameters.
Table C-62 registerSpAccountRes Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
spGroupId |
xsd:string |
The ID of the Service Provider Group the Service Provider Account should be associated with. |
|
spAccountRef |
xsd:string |
Internal ID of the Service Provider. This ID is used to correlate the Service Provider ID with an Operator-internal ID. |
|
response |
tns1:RequestResponse |
The response to the request. See "RequestResponse". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the status of the Service Provider account is not in state REGISTERED.
Requests deletion of a Service Provider Account. In order to be deleted, the Service Provider Account must be state INACTIVE. The request must be approved before the Service Provider Account it is deleted. This is done using "deleteSpAccountRes".
Table C-63 describes the input parameters.
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the status of the Service Provider account is not in state INACTIVE.
Responds to a request to delete a Service Provider Account. The Service Provider Account must be in state DELETE_PENDING in order for this call to be accepted.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Service Provider Account. If approved, the Service Provider Account is simply deleted. If disapproved, the Service Provider Account is transferred into state INACTIVE.
Table C-64 describes the input parameters.
Table C-64 deleteSpAccountRes Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
response |
tns1:RequestResponse |
The response to the request. See "RequestResponse". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the status of the Service Provider account is not in state INACTIVE.
Updates a Service Provider Account with new data.
Table C-65 describes the input parameters.
Table C-65 updateSpAccount Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
spAccount |
tns1:SpAccount |
Data structure with details on the Service Provider Account, including CRM/PRM application-defined properties in the form of name-value pairs. See "SpAccount". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the Service Provider account is not in a valid state.
Responds to a request to update a Service Provider Account.
It is possible to approve or disapprove the request. Both cases trigger a state transition for the Service Provider Account to state ACTIVE. If approved, the Service Provider Account is updated with the new information.
Table C-66 describes the input parameters.
Table C-66 updateSpAccountRes Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
The ID of the Service Provider Account. |
|
response |
tns1:RequestResponse |
The response to the request. See "RequestResponse". |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the Service Provider account is in state INACTIVE.
Gets details about a specific Service Provider account that is in state UPDATE_PENDING. The details include contact information and CRM/PRM application-defined properties in the form of name-value pairs.
Table C-67 describes the input parameters.
Returns details about contact information and CRM/PRM application-defined properties in the form of name-value pairs. See "SpAccount".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: Exception thrown if the Service Provider account does not exist.
INVALID_STATE: Exception thrown if the Service Provider account is not in state UPDATE_PENDING.
Sets the password the Service Provider uses to authenticate to use the Partner Relationship Management Interface exposed by Services Gatekeeper.
Table C-68 describes the input parameters.
Changes the password the Operator uses to authenticate with the Partner Relationship Management Interface exposed by Services Gatekeeper. The Operator Account is the one the Operator is currently logged in as.
Table C-69 describes the input parameters.
Retrieves the user level of the currently logged in Operator Account. Different user levels have different privileges, and are authorized to different sets of operations. This operation takes no input.
Returns the user level of the currently logged in Operator Account. See "UserLevel".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
These complex data types are used by this interface.
Table C-70 describes of an Application Account.
| Element name | Data Type | Description |
|---|---|---|
|
name |
xsd:string |
Descriptive name of the Application Account. |
|
description |
xsd:string |
Short description of the Application Account. |
|
properties |
impl:ArrayOf_tns1_Property |
CRM/PRM application-defined name value pairs. See "Property". |
Table C-72 lists the reference to IDs of an Application Instance.
| Element name | Data Type | Description |
|---|---|---|
|
spAccountId |
xsd:string |
ID of the Service Provider Account associated with the Application Instance. |
|
appAccountId |
xsd:string |
ID of the Application Account associated with the Application Instance. |
|
appInstGroupId |
xsd:string |
ID of the Application Instance. |
Table C-73 describes the container for Application-level SLA and CRM/PRM application-defined properties.
| Element name | Data Type | Description |
|---|---|---|
|
sla |
xsd:string |
The SLA for the Application Group. |
|
properties |
mpl:ArrayOf_tns1_Property |
CRM/PRM application-defined properties. Name-value pairs. See "Property". |
Table C-74 describes the container for Application Instance CRM/PRM application-defined properties.
| Element name | Data Type | Description |
|---|---|---|
|
name |
xsd:string |
Descriptive name of the Application Instance. |
|
description |
xsd:string |
Short description of the Application Instance. |
|
sla |
xsd:string |
The SLA for the Application Instance. Always set to 1. |
|
properties |
mpl:ArrayOf_tns1_Property |
CRM/PRM application-defined properties. Name-value pairs. See "Property". |
Array of name-value pairs, as seen in Table C-75. This data type is used in several other data types specific to this interface. The properties are accessible from the Service Provider interface and the Operator interface, so they can be used to communicate information between them.
Table C-77 provides the description of a Service Provider Account, including contact details.
| Element name | Data Type | 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". |
Table C-78 describes the container for Service Provider SLA and CRM/PRM application-defined properties.
| Element name | Data Type | Description |
|---|---|---|
|
sla |
xsd:string |
The SLA for the Service Provider. |
|
properties |
impl:ArrayOf_tns1_Property |
CRM/PRM Application-defined properties. Name-value pairs. See "Property". |
Table C-79 lists the enumeration defining the user level of the currently logged in Operator user.
The user level reflects the user levels defined for the operations and maintenance of Services Gatekeeper. Each operation performed by using the Partner Management Interface results in one or more standard OAM operations. The user level of the currently authenticated user must satisfy the user level necessary for each of these operations. If this is not the case, the operation performed through the Partner Management Interface is denied.
| Element name | Data Type | Description |
|---|---|---|
|
UNAUTHORIZED |
xsd:string |
The currently authenticated in user is not authorized to perform any OAM operations. |
|
READ_ONLY |
xsd:string |
The currently authenticated user is authorized to perform OAM read- or get- operations. |
|
READ_WRITE |
xsd:string |
The currently authenticated user is authorized to perform OAM write- or set- operations. |
|
ADMINISTRATOR |
xsd:string |
The currently authenticated user is authorized to perform administrator OAM operations tasks |
Table C-80 defines the state of a Service Provider Account, Service Provider Group, Application Account, Application Group, or Application Instance. Enumeration.
See "Account States" for more information about states, and transitions among different states.
| Element name | Data Type | Description |
|---|---|---|
|
REGISTERED |
xsd:string |
The account or group is has been registered. The registration request must be responded to by the Service Provider. |
|
ACTIVE |
xsd:string |
Normal mode. |
|
INACTIVE |
N/A |
No traffic is allowed through the Services Gatekeeper when the account or group is in this state. |
|
UPDATE_PENDING |
N/A |
There is a pending update request. The request must be responded to by the Service Provider. |
|
DELETE_PENDING |
N/A |
There is a pending delete request on the account or group. The request must be responded to by the Service Provider. |
|
LOCKED |
N/A |
Only valid for an Application Instance. The group can be locked due to too many consecutive failed login attempts from an application. |
The Service Provider Utility Web Service allows the Service Provider to retrieve the Call Detail Records (CDRs) it has generated from Services Gatekeeper.
The endpoint for this interface is:
http://host:port/prm_sp/services/SpCdrUtil
where the value of host and port depend on the Services Gatekeeper deployment.
Counts the number of CDRs for a certain Service for a specified time interval.
Note:
A Service is the generic name for a Services Gatekeeper communication service, without regard for the Web Service version or the network plug-in being used. So, for example, the Service name for Parlay X 2.1 Third Party Call using Session Initiation Protocol (SIP) or Intelligent Network Application Part (INAP) or Parlay X 3.0 using Parlay 3.3 MultiProtocol Communication Controller (MPCC) is simply Third Party Call.Table C-81 describes the input parameters.
Table C-81 countCdrs Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
serviceName |
xsd:string |
The name of the Service for which to retrieve charge data records (CDRs). Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
From date and time. Use null to not filter on this parameter |
|
toDate |
xsd:dateTime |
To date and time. Use null to not filter on this parameter. |
|
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR. See "CdrCompletionStatus". Use null to not filter on this parameter. |
|
appAccountId |
xsd:string |
ID of the Application Account to filter the result on. Use null to not filter on this parameter |
Retrieves all CDRs matching the given criteria.
listCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId, startIndex, maxEntries)
Table C-82 describes the input parameters.
Table C-82 listCdrs Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
serviceName |
xsd:string |
The name of the Service for which to retrieve charge data records (CDRs). Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
From date and time. Use null to not filter on this parameter |
|
toDate |
xsd:dateTime |
To date and time. Use null to not filter on this parameter. |
|
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR. See "CdrCompletionStatus". Use null to not filter on this parameter. |
|
appAccountId |
xsd:string |
ID of the Application Account to filter the result on. Use null to not filter on this parameter |
|
startIndex |
xsd:long |
Input parameter. Which entry, in the overall result set, to start the result list on (cursor). |
|
maxEntries |
xsd:int |
Input parameter. The maximum number of alarms returned. |
Returns a list of CDRS. See "CdrInfo".
These complex data types are used by this interface.
Table C-83 lists the data structure defining a CDR. All services that produce charging data do not use all fields, and they use the fields in a slightly different, depending on the type of the service. See Services Gatekeeper Communication Service Reference Guide for details of which fields that are relevant for the different services.
| Element name | Data Type | Description |
|---|---|---|
|
transactionId |
xsd:long |
The Services Gatekeeper transaction sequence number. |
|
serviceName |
xsd:string |
The communication service whose use is being tracked |
|
timeStamp |
xsd:dateTime |
The time at which the event was triggered (in milliseconds from midnight 1 January 1970) |
|
origAddr |
xsd:string |
The address of the originating party. |
|
destAddr |
xsd:string |
The address of the destination party. |
|
spAccountD |
xsd:string |
The ID of the Service Provider that generated the CDR. |
|
appAccountID |
xsd:string |
The ID of the Application Account that generated the CDR. |
|
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR. See "CdrCompletionStatus". |
|
info |
xsd:string |
Additional info provided by the communication service |
|
additionalProperties |
impl:ArrayOf_tns1_Property |
Application defined data. See "CdrCompletionStatus". |
Table C-84 lists the enumeration defining the completion status of a CDR.
Table C-84 CdrCompletionStatus
| Element name | Data Type | Description |
|---|---|---|
|
COMPLETED |
xsd:string |
The operation generating the CDR succeeded. |
|
FAILED |
xsd:string |
The operation generating the CDR failed. |
|
PARTIAL |
xsd:string |
The operation generating the CDR succeeded partially. May be supported, depending on the communication service. |
|
COMPLETED_NOTIFICATION_FAILED |
xsd:string |
The CDR is completed, but the notification was not delivered to the application. |
|
POLICY_DENIED |
xsd:string |
Policy denied the operation. |
The Service Provider Statistics Utility Web Service allows the Service Provider to retrieve the statistics it has generated from Services Gatekeeper.
The endpoint for this interface is:
http://host:port/prm_sp/services/SpStatisticsUtil
Where the value of host and port depend on the Services Gatekeeper deployment.
Lists the statistics types registered in Services Gatekeeper. This operation takes no input parameters.
Returns the descriptions of the available statistics types. See "StatisticTypeDescriptor".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
Retrieves statistics matching the given criteria.
Table C-86 describes the input parameters.
Table C-86 getStatistics Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
statisticType |
xsd:int |
Number representing the type of statistics to retrieve. Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
From date and time. Use null to not filter on this parameter. |
|
toDate |
xsd:dateTime |
To date and time. Use null to not filter on this parameter. |
|
appAccountId |
xsd:string |
ID of the Application Account to filter the result on. Use null to not filter on this parameter. |
Returns statistics. See "StatisticsInfo".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
These complex data types are used by this interface.
Table C-87 lists the data structure defining a statistics record.All services that produces statistics do not use all fields, and they use the fields in a slightly different, depending on the type of the service. See Services Gatekeeper Communication Service Reference Guide for details of which fields that are relevant for the different services.
| Element name | Data Type | Description |
|---|---|---|
|
statisticsType |
xsd:string |
The statistics type. See WebLogic Product Description for information on available statistics types. |
|
timeStampStart |
xsd:dateTime |
The starting time of the interval during which the statistics were gathered. |
|
timeStampEnd |
xsd:dateTime |
The end time of the interval during which the statistics were gathered. |
|
numberOfTransactions |
xsd:int |
The number of transactions during the interval. |
|
spAccountD |
xsd:string |
The ID of the Service Provider that generated the statistics. |
|
appAccountID |
xsd:string |
The ID of the Application Account that generated the statistics. |
Table C-88 describes the data structure that holds a description for each type of statistics.
The Operator CDR Utility Web Service allows the Operator to retrieve call details records (CDRs) from Services Gatekeeper.
The endpoint for this interface is:
http://host:port/prm_op/services/OpCdrUtil
where the value of host and port depend on the Services Gatekeeper deployment.
Counts the number of CDRs for a certain Service for a specified time interval
Note:
A Service is the generic name for a Services Gatekeeper communication service, without regard for the Web Service version or the network plug-in being used. So, for example, the Service name for Parlay X 2.1 Third Party Call using SIP or INAP or Parlay X 3.0 using Parlay 3.3 MPCC is simply Third Party Call.countCdrs(serviceName, fromDate, toDate, completionStatus, spAccountId, appAccountId)
Table C-89 describes the input parameters.
Table C-89 countCdrs Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
serviceName |
xsd:string |
The name of the Service for which to retrieve charge data records (CDRs). Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
From date and time. Use null to not filter on this parameter |
|
toDate |
xsd:dateTime |
To date and time. Use null to not filter on this parameter. |
|
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR. See "CdrCompletionStatus". Use null to not filter on this parameter. |
|
spAccountId |
xsd:string |
Input parameter. ID of the Service Provider Account to filter the result on. Use null to not filter on this parameter. |
|
appAccountId |
xsd:string |
ID of the Application Account to filter the result on. Use null to not filter on this parameter |
Retrieves all CDRs matching the given criteria.
listCdrs(serviceName, fromDate, toDate, completionStatus, spAccountId, appAcountId, startIndex, maxEntries)
Table C-90 describes the input parameters.
Table C-90 listCdrs Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
serviceName |
xsd:string |
The name of the Service for which to retrieve CDRs. Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
From the date and time. Use null to not filter on this parameter |
|
toDate |
xsd:dateTime |
To the date and time. Use null to not filter on this parameter. |
|
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR.See "CdrCompletionStatus". Use null to not filter on this parameter. |
|
spAccountId |
xsd:string |
ID of the Service Provider Account to filter the result on. Use null to not filter on this parameter. |
|
appAccountId |
xsd:string |
ID of the Application Account to filter the result on. Use null to not filter on this parameter. |
|
startIndex |
xsd:long |
Which entry, in the overall result set, to start the result list on (cursor). |
|
maxEntries |
xsd:int |
The maximum number of alarms returned. |
Returns a list of CDRS. See "CdrInfo".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
These are complex data types used by this interface.
Table C-91 describes the data structure defining a CDR. All services that produce charging data do not use all fields, and they use the fields slightly different, depending on the type of the service. See Services Gatekeeper Communication Service Reference Guidefor details of which fields that are relevant for the different services.
| Element name | Data Type | Description |
|---|---|---|
|
transactionId |
xsd:long |
The Services Gatekeeper transaction sequence number |
|
serviceName |
xsd:string |
The communication service whose use is being tracked |
|
timeStamp |
xsd:dateTime |
The time at which the event was triggered (in milliseconds from midnight 1 January 1970 |
|
origAddr |
xsd:string |
The address of the originating party. |
|
destAddr |
xsd:string |
The address of the destination party. |
|
spAccountId |
xsd:string |
The ID of the Service Provider that generated the CDR. |
|
appAccountId |
xsd:string |
The ID of the Application Account that generated the CDR. |
|
completionStatus |
tns1:CdrCompletionStatus |
Completion status of the CDR. See "CdrCompletionStatus". |
|
info |
xsd:string |
Additional info provided by the service capability module. |
|
additionalProperties |
impl:ArrayOf_tns1_Property |
Application defined data. See "Property". |
Table C-92 lists the enumeration that defines the completion status of a CDR.
Table C-92 CdrCompletionStatus
| Element name | Data Type | Description |
|---|---|---|
|
COMPLETED |
xsd:string |
The operation generating the CDR succeeded. |
|
FAILED |
xsd:string |
The operation generating the CDR failed |
|
PARTIAL |
xsd:string |
The operation generating the CDR succeeded partially. May be supported, depending on the communication service. |
|
COMPLETED_NOTIFICATION_FAILED |
xsd:string |
The CDR is completed, but the notification was not delivered to the application. |
|
POLICY_DENIED |
xsd:string |
Policy denied the operation. |
The Operator Statistics Utility Web Service allows the Operator to retrieve the statistics generated in Services Gatekeeper.
The endpoint for this interface is:
http://host:port/prm_op/services/OpStatisticsUtil
where the value for host and port depend on the Services Gatekeeper deployment.
OpStatisticsUtil Error Messages
This interface can generate these error messages
"getStatistics failed!"
"listStatisticTypes failed"
Lists the statistics types registered in Services Gatekeeper. This operation takes no input.
Returns the descriptions of the available statistics types. See "StatisticTypeDescriptor".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
Retrieve statistics matching the given criteria.
Table C-94 describes the input parameters.
Table C-94 getStatistics Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
statisticType |
xsd:int |
Number representing the type of statistics to retrieve. Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
From date and time. Use null to not filter on this parameter. |
|
toDate |
xsd:dateTime |
To date and time. Use null to not filter on this parameter. |
|
spAccountId |
xsd:string |
Input parameter. ID of the Service Provider Account to filter the result on. Use null to not filter on this parameter |
|
appAccountId |
xsd:string |
ID of the Application Account to filter the result on. Use null to not filter on this parameter. |
Returns statistics. See "StatisticsInfo".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
These complex data types are used by this interface.
Table C-95 describes the data structure defining a statistics record. All services that produce statistics do not use all fields, and they use the fields slightly differently, depending on the type of the service.
| Element name | Data Type | Description |
|---|---|---|
|
statisticsType |
xsd:string |
The statistics type. |
|
timeStampStart |
xsd:dateTime |
The starting time of the interval during which the statistics were gathered. |
|
timeStampEnd |
xsd:dateTime |
The end time of the interval during which the statistics were gathered. |
|
numberOfTransactions |
xsd:int |
The number of transactions during the interval. |
|
spAccountId |
xsd:string |
The ID of the Service Provider that generated the statistics. |
|
appAccountId |
xsd:string |
The ID of the Application Account that generated the statistics. |
The Operator Alarm Utility Web Service allows the Operator to retrieve alarms from Services Gatekeeper.
The endpoint for this interface is:
http://host:port/prm_op/services/OpAlarmUtil
where the value of host and port depend on the Services Gatekeeper deployment.
Counts the number of alarms of a certain type of a given severity for a specified time interval.
Table C-97 describes the input parameters.
Table C-97 countAlarms Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
alarmId |
xsd:int |
The ID of the type of alarm. |
|
severity |
tns1:AlarmSeverity |
Severity of the alarm. See "AlarmSeverity". Use null to not filter on this parameter |
|
fromDate |
xsd:dateTime |
Start date and time. Use null to not filter on this parameter. |
|
toDate |
xsd:dateTime |
End date and time. Use null to not filter on this parameter. |
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
Retrieves all alarms matching the given criteria.
Table C-98 describes the input parameters.
Table C-98 listAlarms Input Parameters
| Parameter Name | Type | Description |
|---|---|---|
|
alarmId |
xsd:int |
The ID of the type of alarm. |
|
severity |
tns1:AlarmSeverity |
Severity of the alarm. See "AlarmSeverity". Use null to not filter on this parameter. |
|
fromDate |
xsd:dateTime |
From date and time.Use null to not filter on this parameter. |
|
toDate |
xsd:dateTime |
To date and time. Use null to not filter on this parameter. |
|
startIndex |
xsd:long |
Which entry, in the overall result set, to start the result list on (cursor). |
|
maxEntries |
xsd:int |
The maximum number of alarms returned. |
Returns the list of alarms. See "AlarmInfo".
The possible exceptions are:
ACCESS_DENIED: Exceptions of this type are raised when the operation is not permitted. The user does not have the appropriate privilege level to perform the operation.
CommonException: This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
These complex data types are used by this interface.
Table C-99 describes the data structure defining an alarm.
| Element name | Data Type | Description |
|---|---|---|
|
alarmInstanceId |
xsd:long |
The ID of the emitted alarm. Unique identifier for an emitted alarm. |
|
alarmId |
xsd:int |
The identifier for the alarm type. |
|
source |
xsd:string |
Specifies the name of the software module that raised the alarm and the IP address of the server the service is installed in. |
|
severity |
tns1:AlarmSeverity |
Specifies the alarm's severity level. See "AlarmSeverity". |
|
timeStamp |
xsd:dateTime |
Specifies the time and date the alarm was raised. |
|
info |
xsd:string |
Alarm information provided by the software module the raised the alarm. |
|
additional_info |
xsd:string |
Additional information depending on context. |