RESTful Application Development Guide

Subscriber Profile

Operations

The RESTful Subscriber Profile interfaces allow an application to query an operator’s database for individual subscriber profile attributes (such as a user’s terminal type) or entire subscriber profiles.

In the listings below, bold indicates a required attribute, <> a descriptive comment.

Get

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

Request

URI

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

${query}:

{

"address": "URI",<The address associated with the subscriber whose data is being accessed. Supported schemes include tel, id, imsi, and ipv4.>

"pathNames": ["String"]<The requested subsciber profile properties. These are expressed as a relative UNIX path, such as serviceName/accessControlId/accessControlId>

}

HTTP Method

GET

Response

Response Content-Type

application/json

Body

{"properties": [{<An array of the requested properties, as key value pairs>

"pathName": "String",<The pathname of the requested property>

"propertyValue": "String"<The value associated with the requested property>

}]}

Error Response

Service Exception

Policy Exception

Get Profile

Gets an entire subscriber profile.

Request

URI

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

${id}:

{

"profileID": "String",<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. May be ignored if Oracle Communications Services Gatekeeper connects to the network using certain protocols.>

"subscriberID": "String"<An ID that uniquely identifies the subscriber whose profile is being accessed>

}

HTTP Method

GET

Response

Response Content-Type

application/json

Body

{"result": [{<An array of properties from the requested profile>

"pathName": "String",<The pathname of the property>

"propertyValue": "String"<The value associated with that property>

}]}

Error Response

Service Exception

Policy Exception

Errors

The content of possible error messages.

Service Exception

{"error":{

"type":"com.bea.wlcp.wlng.schema.ews.common.ServiceException"

  "message":"String"

}}

Policy Exception

{"error":{

"type":"com.bea.wlcp.wlng.schema.ews.common.PolicyException"

"message":"String"

}}