![]() ![]() ![]() ![]() ![]() ![]() |
The Service Provider Service Web Service provides the Service Provider with operations for handling Service Provider Accounts, Application Accounts, and Applications Instances.
The endpoint for this interface is: http://<host>:<port>/prm_sp/services/SpService
Where the value for host and port depend on the Network Gatekeeper deployment.
Makes a request to delete the Service Provider Account. Before a Service Provider Account can be deleted, it must be in the INACTIVE state. The request must be approved before the Service Provider Account is deleted. This is done by the Operator, using deleteSpAccountRes,
Deactivates the Service Provider Account, which changes the state of the account to INACTIVE.
Activates the Service Provider Account. which changes the state of the account to ACTIVE.
Retrieves details about the Service Provider Account. The details include contact details and CRM/PRM application-defined properties in the form of name-value pairs.
Data structure with details on the Service Provider account. See SpAccount.
|
||
Retrieves the state of the Service Provider Account.
Information of the state of the Service Provider Account. See State.
|
||
Requests registration of an Application Account for the Service Provider Account. This request must be approved by the Operator: see registerAppAccountRes.
Data structure with details about the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See AppAccount.
|
||
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 delete. This is done using deleteAppAccountRes. The Application Account must be in state INACTIVE in order for this call to be accepted.
Requests an update of the Service Provider Account with new data.
Data structure with details on the Service Provider Account, including CRM/PRM application-defined properties in the form of name-value pairs. See SpAccount.
|
||
Requests an update to an Application Account associated with the Service Provider with new data.
Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See AppAccount.
|
||
Requests an update on an Application Instance. The request must be approved by the Operator. See updateAppInstGroupRes.
Data-structure with the Application Instance CRM/PRM application-defined properties in the form of name-value pairs. See AppInstGroup.
|
||
Requests a deletion of an Application Instance. The request must be approved by the Operator. This is done using deleteAppInstGroupRes,
Lists all Application Account IDs for the Service Provider. The result is filtered based on the state of the Application Account
Indicates the states on which states to filter the result. State.
|
||
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.
Data structure with details about the Application Account. See AppAccount.
|
||
Retrieves the state of a specific Application Account.
Information on the state of the Application Account. See State
|
||
Activate an Application Account, which changes the state of the account to ACTIVE. The current state of the account must be INACTIVE.
Deactivates an Application Account, which changes the state of the account to INACTIVE. The current state of the account must be ACTIVE.
Activates an Application Instance, which changes the state of the instance to ACTIVE.
Gets the state of an Application Instance.
The state of the Application Instance. See State.
|
||
Deactivates an Application Instance, which changes the state of the group to INACTIVE.
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 Network Gatekeeper.
The CRM/PRM application-defined properties in the form of name-value pairs. See AppInstGroup.
|
||
Deactivate an Application Instance. Change the state of the instance to INACTIVE.
Lists all Application Instances for an Application Account. Filtering is possible on the state of the Application Instance
Indicates which states to filter the result on. See State
|
||
Retrieves details about a specific Application Instance.
Data structure with details about the Application Instance. See AppInstGroup.
|
||
Retrieves the Service Provider SLA.
Retrieves the Application-level SLA.
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 Network Gatekeeper.
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 Network Gatekeeper.
Exceptions of this type are raised when the operation is not permited. The user does not have adequate privileges to perform the operation.
This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
The operation is not valid since the operation results in a state transition, and the transition from the current state to the state the operation results in is not allowed.
Description of an Application Account.
CRM/PRM application-defined name value pairs. See Property.
|
Container for the CRM/PRM application-defined properties.
CRM/PRM application-defined properties. Name-value pairs. See 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
Description of a Service Provider Account, including contact details.
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.
SeeAccount States for more information about states, and transitions between different states.
![]() ![]() ![]() |