API Description for Extended Web Services

Subscriber Profile

The following sections provide detailed information about the Subscriber Profile service capability:

• Web Service
• Listener interface

 

---

Web Service

The subscriber profiles in are used for defining data on the subscriber, such as name, address, information on the terminal type and so on.

An applicationr with rights to use the subscriber profile service can perform the following tasks:

• Retrieve administrative and technical information for a subscriber
• Set administrative and technical information on a subscriber

getSubscriberProperty

Get a set of data, properties, for a subscriber in the subscriber profile database. Asynchronous request.

Table 9-1 getSubscriberProperty(endpoint, address, propertyTypes, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/SubscriberProfileListener
address	xsd:string	The address, in URI format (tel:<address>), of the subscriber to get properties. for.
propertyTypes	impl:ArrayOfPropertyTypes	See ArrayOfPropertyTypes. List of properties to fetch.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getSubscriberPropertyReturn	xsd:int	ID of the request. This ID is supplied in getSubscriberPropertyResult to keep track of the different request-response pairs.
Exceptions
SubscriberProfileException		See SubscriberProfileException.
GeneralException		See GeneralException.

getSubscriberPropertyWait

Get a set of data, properties, for a subscriber in the subscriber profile database. Synchronous request.

Table 9-2 getSubscriberPropertyWait(address, propertyTypes, waitTimeoutSeconds, serviceCode, requesterID)

Parameter Name	Type	Description
Input
address	xsd:string	The address, in URI format (tel:<address>), of the subscriber to get properties for.
propertyTypes	impl:ArrayOfPropertyTypes	See ArrayOfPropertyTypes. List of properties to fetch.
waitTimeoutSeconds	xsd:int	The time, in seconds, to wait for a response. If the response is not delivered within this time frame, and exception is thrown.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
getSubscriberPropertyWaitReturn	impl:ArrayOfProperty	See ArrayOfProperty. Array of the requested properties.
Exceptions
SubscriberProfileException		See SubscriberProfileException.
GeneralException		See GeneralException.

setSubscriberProperty

Set a set of data, properties, for a subscriber in the subscriber profile database. Asynchronous request.

Table 9-3 setSubscriberProperty(endpoint, address, properties, serviceCode, requesterID)

Parameter Name	Type	Description
Input
endpoint	xsd:string	The URL to the Web Service that implements the listener interface. See Listener interface. An example is http://www.acompany.com/axis/services/SubscriberProfileListener
address	xsd:string	The address, in URI format (tel:<address>), of the subscriber to set properties. for.
properties	impl:ArrayOfProperty	See ArrayOfProperty. Properties to set.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
setSubscriberPropertyReturn	xsd:int	ID of the request. This ID is supplied in setSubscriberProperty to keep track of the different request-response pairs.
Exceptions
SubscriberProfileException		See SubscriberProfileException.
GeneralException		See GeneralException.

setSubscriberPropertyWait

Get a certain data, property, for a subscriber in the subscriber profile database. Synchronous request.

Table 9-4 setSubscriberPropertyWait(address, properties, waitTimeoutSeconds, serviceCode, requesterID)

Parameter Name	Type	Description
Input
address	xsd:string	The address, in URI format (tel:<address>), of the subscriber to set properties. for.
properties	impl:ArrayOfProperty	See ArrayOfProperty. List of properties to fetch.
waitTimeoutSeconds	xsd:int	The time, in seconds, to wait for a response. If the response is not delivered within this time frame, and exception is thrown.
serviceCode	xsd:string	Used for charging purposes. Defined by the operator.
requesterID	xsd:string	The application ID as given by the operator.
Returns
Void.
Exceptions
SubscriberProfileException		See SubscriberProfileException.
GeneralException		See GeneralException.

Exceptions

SubscriberProfileException

Exceptions of this type are raised when there are error conditions related to the Subcriber Profile Web Service. Other error conditions are reported using the exception GeneralException. See SubscriberProfileException for a definition of the datatype.

GeneralException

This exception is raised when the applications session has expired or there are communication problems with the underlying platform.

Complex data types

ArrayOfProperty

Array of Properties. See ArrayOfProperty for information on each element in the array.

ArrayOfPropertyTypes

Array of PropertyTypes. See ArrayOfPropertyTypes for information on each element in the array.

PaymentMethod

Defines a payment method and the related value.

Table 9-5

Name	Type	Description
paymentType	intf:PaymentType	See PaymentType.
value	xsd:anyType	See PaymentType for which type to use. Depends on type defined in paymentType.

PaymentType

Type of payment method. Enumeration (xsd:string) with one of the following values.

Table 9-6

Name	Description
PAYMENT_TYPE_UNDEFINED	Undefined. Null.
CREDIT_CARD	Credit card. Use xsd:string in xsd:AnyType in PaymentMethod. Credit card number.
INVOICE	Invoice. Use xsd:short in xsd:AnyType in PaymentMethod. Customer number.

PropertyTypes

Type of property to set or get. Enumeration (xsd:string) with one of the following values.

Table 9-7

Value	Description
UNDEFINED	Undefined. Null.
NAME	Name.
ALIAS	Alias to be used to ensure anonymity between users of the application.
ADDRESS	Complete postal address.
HOME_PHONE	Home phone number.
OFFICE_PHONE	Office phone number.
PRIVATE_MAIL	Private e-mail address.
OFFICE_MAIL	Office e-mail address.
TERMINAL_ID	IMSI of the terminal.
TERMINAL_VENDOR	Vendor name, for example Ericsson, Nokia, or Siemens.
TERMINAL_MODEL	Model name of the terminal. For example T68i, 3210 or A55.
TERMINAL_SCREEN_SIZE	Screen size of the terminal. Character rows x columns.
COLOR_ENABLED_TERMINAL	Colour enabled-terminal. Yes/No.
MMS_ENABLED_TERMINAL	MMS enabled terminal. Yes/No.
FAX_NUMBER	Fax number.
GROUP_IDENTITY	For example family, office location or work group.
GENDER	Male/Female
BIRTH_DATE	Birth date. In format YYYY-MM-DD.
NATIONALITY	Nationality. Free text.
MOTHER_TOUNGE	Mother tongue. Free text.
CURRENCY	Currency. Free text.
MISCELLANEOUS	Any type of additional information.
LAST_UPDATED	Date and time the account was last updated (read-only).
LAST_UPDATED_BY	The user that updated the account (read-only).
SUBSCRIPTION_TYPE	Type of subscription, Prepaid, Postpaid, Time Limited, or Free.
PAYMENT_METHOD	Payment method: Credit card or Invoice.
BALANCE	Account balance. (read-only).
APPLICATION_SUBSCRIPTIONS	List of subscribed applications.

RowCol

Table 9-8

Name	Type	Description
co	xsd:short	Column size.
row	xsd:short	Row size.

SubscriberGender

Defines the gender. Enumeration (xsd:string) with the following values.

Table 9-9

Value	Description
MALE	-
FEMALE	-

SubscriberProfileException

Holder for exceptions.

Table 9-10

Name	Type	Description
exceptionMessage	xsd:string	Exception Message in plaint text.
errorCode	xsd:int	Unique error code.

SubscriptionType

Defines different subscription types for a subscriber. Enumeration (xsd:string) with the following values.

Table 9-11

Value	Name
SUBSCRIPTION_TYPE_UNDEFINED	Undefined.
PRE_PAID	Pre-paid account.
POST_PAID	Post paid account.
FREE	Free.
TIME_LIMITED	Time limited

 

---

Listener interface

The Subscriber profile listener interface defines the methods that the underlying platform invokes on a Web Service that is implemented by an application. When an application performs asynchronous requests from the location Web Service, the responses are delivered according to this interface.

deactivate

Used by the underlying system to inform the application that a session is no longer valid. The application can not use the session no more.

Table 9-12 deactivate(id)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the session to be deactivated. The ID was returned when getSubscriberProperty or setSubscriberProperty was invoked.
Returns
Void.
Exceptions
-

getSubscriberPropertyError

Errors related to requests invoked by getSubscriberProperty are reported using this method.

Table 9-13

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getSubscriberProperty was invoked.
address	xsd:string	Address, in URI format (tel:<address>), of the subscriber whose properties were requested.
errorMsg	xsd:string	Error message.
Returns
Void.
Exceptions
-

getSubscriberPropertyResult

The result of a successful invocation of getSubscriberProperty.

Table 9-14 getSubscriberPropertyResult(id, address, properties)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getSubscriberProperty was invoked.
address	xsd:string	Address, in URI format (tel:<address>), of the subscriber whose properties were requested.
properties	impl:ArrayOfProperty	See ArrayOfProperty. Array containing the requested information.
Returns
Void.
Exceptions
-

setSubscriberPropertyError

Errors related to requests invoked by setSubscriberProperty are reported using this method.

Table 9-15 getSubscriberPropertyError(id, address, errorMsg)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when setSubscriberProperty was invoked.
address	xsd:string	Address, in URI format (tel:<address>), of the subscriber whose properties were requested.
errorMsg	xsd:string	Error message.
Returns
Void.
Exceptions
-

setSubscriberPropertyResult

The result of a successful invocation of setSubscriberProperty.

Table 9-16 setSubscriberPropertyResult(id, address)

Parameter Name	Type	Description
Input
id	xsd:int	ID of the request. The ID was returned when getSubscriberProperty was invoked.
address	xsd:string	Address, in URI format (tel:<address>), of the subscriber whose properties were requested.
Returns
Void.
Exceptions
-

Complex data types

The data types are the same as the ones for the Subscriber profile Web Service, described in section Complex data types.