![]() ![]() ![]() ![]() ![]() ![]() |
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.
The endpoint for this interface is: http://<host>:<port>/prm_op/services/OpService
where the value of host and port depend on the Network Gatekeeper deployment.
Retrieves details about a specific Application Group.
Data structure with details about the Application Group. See AppGroup.
|
||
Creates a new Application Group with a certain ID.
Data structure describing the group. See AppGroup
|
||
Deletes an Application Group. All Application Accounts must be removed from the group before it can be deleted
Associates an Application Account for a specific Service Provider with an Application Group.
Retrieves the ID of the Application Group for a given Service Provider Account and Application Account combination.
Updates an Application Group with new SLA data.
The Application-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See AppGroup
|
||
Lists all Service Provider Groups
Retrieves details about a specific Service Provider Group.
Data structure with details about the Service Provider Group. See SpGroup.
|
||
Creates a new Service Provider Group with a certain ID.
Data structure describing the group. See SpGroup.
|
||
Deletes a Service Provider Group. All Service Provider Accounts associated with the group must be removed before it can be deleted
Associates a Service Provider Account with a Service Provider Group.
Retrieves the ID of the Service Provider Group for a given Service Provider Account.
Updates a Service Provider Group with new SLA data.
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
Indicates which states to filter the result on. See State.
|
||
Data structure containing a references to the Application Instance. See AppInstGroupRef.
|
||
Retrieves details about a specific Application Instance.
Data structure with details about the Application Instance. See AppInstGroup.
|
||
Gets the state of specific Application Instance.
The state of the Application Instance. See State.
|
||
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 Network Gatekeeper.
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,
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 Network Gatekeeper.
The response to the request. See RequestResponse.
|
||
Updates an Application Instance Group with new data.
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.
The response to the request. See RequestResponse.
|
||
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.
CRM/PRM application-defined properties in the form of name-value pairs. See AppInstGroup.
|
||
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 Network Gatekeeper.
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 Network Gatekeeper.
Activates a Service Provider Account, which changes the state of the account to ACTIVE.
Deactivates a a Service Provider Account, which changes the state of the account to INACTIVE.
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.
Data structure with details on the Service Provider account. See SpAccount.
|
||
Retrieves the state of a specific Service Provider Account.
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.
Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See AppAccount.
|
||
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.
The response to the request. See RequestResponse.
|
||
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.
The response to the request. See RequestResponse.
|
||
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.
Data structure describing the Application Account. See AppAccount.
|
||
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.
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.
Updates an Application Account 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.
|
||
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.
Data structure with details about the Application Account. See AppAccount.
|
||
Retrieves the state of a specific Application Account.
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.
Deactivates an Application Account, which changes the state of the account to INACTIVE. The current state of the account must be ACTIVE.
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 Network Gatekeeper. If disapproved, the Application Instance is deleted.
The response to the request. See RequestResponse.
|
||
Activates an Application Instance, which changes the state of the Instance to ACTIVE.
Deactivates an Application Instance, which changes the state of the Instance to INACTIVE.
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 registerSpAccountRes,
Lists all Application Account IDs for a specific Service Provider. The result is filtered on the state of the Application Account
Indicates which states to filter the result on. State.
|
||
Data structure 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
Indicates which states to filter the result on. 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.
The response to the request. See RequestResponse.
|
||
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,
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.
The response to the request. See RequestResponse.
|
||
Updates a 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.
|
||
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.
The response to the request. See RequestResponse.
|
||
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.
Details about contact information and CRM/PRM application-defined properties in the form of name-value pairs. See SpAccount.
|
||
Sets the password the Service Provider uses to authenticate to use the Partner Relationship Management Interface exposed by Network Gatekeeper.
Changes the password the Operator uses to authenticate with the Partner Relationship Management Interface exposed by Network Gatekeeper. The Operator Account is the one the Operator is currently logged in as.
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.
The user level of the currently logged in Operator Account. See UserLevel.
|
||
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.
This exception is raised when the login session has expired (BC only) or there are communication problems with the underlying platform.
Description of an Application Account.
CRM/PRM application-defined name value pairs. See Property.
|
Reference to IDs of an Application Account.
Reference to IDs of an Application Instance.
Container for Application-level SLA and CRM/PRM application-defined properties.
CRM/PRM application-defined properties. Name-value pairs. See Property.
|
Container for Application Instance 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 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
Enumeration defining the operator’s response to an request
Description of a Service Provider Account, including contact details.
CRM/PRM application-defined name value pairs. See Property.
|
Container for Service Provider SLA and CRM/PRM application-defined properties.
CRM/PRM Application-defined properties. Name-value pairs. See Property.
|
Defines the user level of the currently logged in Operator user. Enumeration.
The user level reflects the user levels defined for the operations and maintenance of Network Gatekeeper. Each operation performed via 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.
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.
![]() ![]() ![]() |