19 Subscriber Profile

This chapter describes the operations in the Subscriber Profile interface of the RESTful Web Services provided in Oracle Communications Services Gatekeeper.

About the Subscriber Profile Interface

Applications use the RESTful Subscriber Profile interface to query an operator's database for individual subscriber profile attributes (such as a user's terminal type) or entire subscriber profiles.

REST Service Descriptions Available at Run-time

When the Administration Server for your Services Gatekeeper domain is in the running state, the REST service descriptions of these operations can be found at

http://host:port/rest/subscriber_profile/index.html

where host and port are the host name and port of the machine on which Services Gatekeeper is installed.

---

Get

The GET operation retrieves specific subscriber profile properties. The properties that can be accessed are defined in the service provider and application SLAs associated with the application.

To retrieve specific subscriber profile properties, provide the address the subscriber and the required subscriber profile properties within the query object in the Request-URI of the GET method.

If this operation is successful, the response body contains a JSON data object with the required pathnames and values for the required profile properties associated with the specified subscriber.

Authorization

Basic

HTTP Method

GET

URI

http://host:port/rest/subscriber_profile/profile?query=${query}

where:

• host and port are the host name and port of the machine on which Services Gatekeeper is installed.

• ${query} is a JSON object.

The parameters accepted in the ${query} object are:

• address. String. Required. The address associated with the subscriber whose data is being accessed. The supported schemes are:

  • tel id

  • imsi (International Mobile Subscriber Identity)

  • IPv4

• pathNames: Array of String values. Required. The requested subscriber profile properties expressed as a relative UNIX path. For example, serviceName/accessControlId/accessControlId

The ${query} object in the URI is represented by the following JSON data structure, where the value part of each name/value pair indicates its data type:

{
   "address":"URI",
   "pathNames":["String"]
}

Response Header

Standard header fields. If the request fails, the Status-Line header field will contain the status code and the reason for the failure. See "Errors and Exceptions".

Response Body

The response body is a JSON object which contains the requested properties as an array value for the properties attribute. Each element in the array contains the following:

• pathName. String. The pathname for the requested property.

• propertyValue. String. The value associated with the requested property.

The response body for this operation is represented by the following JSON data structure, where the value part of the name/value pair indicates its data type:

{"properties": [{
  "pathName": "String",
  "propertyValue": "String"
}]}

---

Get Profile

The GET Profile operation retrieves the entire profile for a specific subscriber.

To retrieve the entire profile for a specific subscriber, provide the associated subscriber Id and profile ID within the query object in the Request-URI of the GET method.

If Get Profile is successful, the response body contains a JSON data object with the required pathnames and values for all the profile properties associated with the specified subscriber.

Authorization

Basic

HTTP Method

GET

URI

http://host:port/rest/subscriber_profile/profile?id=${id}

where:

• host and port are the host name and port of the machine on which Services Gatekeeper is installed.

• ${id} is a JSON object.

The parameters accepted by ${id} object are:

• profileID. String. Required. The ID of the profile which acts as a set of filters limiting the attributes that can be accessed based on the SLAs associated with the application. This entry may be ignored if Services Gatekeeper connects to the network using certain protocols.

• subscriberID. String. Required. The ID that uniquely identifies the subscriber whose profile is being accessed.

The ${id} object in the URI is represented by the following JSON data structure, where the value part of each name/value pair indicates its data type:

{
   "profileID":"a_profileId",}
   "subscriberID":"a_subsc_id"
}

Response Header

Standard header fields. If the request fails, the Status-Line header field will contain the status code and the reason for the failure. See "Errors and Exceptions".

Response Body

The response body is a JSON object which contains the requested properties as an array value for the result attribute. Each element in the array contains the following:

• pathName. String. The pathname for the requested property.

• propertyValue. String. The value associated with the requested property.

Here is the structure:

{"result": [{
  "pathName": "String",
  "propertyValue": "String"
}]}