Charging Provisioning over CAI3G
Ericsson Dynamic Activation 1

Contents

1Introduction
1.1Purpose and Scope
1.2Target Groups
1.3Typographic Conventions
1.4Prerequisites
1.5Namespaces
1.6Legends
1.7Operations
1.8Web Service Interface
1.9MOType
1.10MOId

2

Create AIR Subscription
2.1Request Data
2.2Response Data
2.3Examples

3

Get AIR Subscription
3.1Request Data
3.2Response Data
3.3Examples

4

Set AIR Subscription
4.1Request Data
4.2Response Data
4.3Examples

5

Delete AIR Subscription
5.1Request Data
5.2Response Data
5.3Examples

6

Get AIR Offer
6.1Request Data
6.2Response Data
6.3Examples

7

Set AIR Offer
7.1Request Data
7.2Response Data
7.3Examples

8

Delete AIR Offer
8.1Request Data
8.2Response Data
8.3Examples

9

Set AIR refill
9.1Request Data
9.2Response Data
9.3Examples

10

Set AIR Communication ID
10.1Request Data
10.2Response Data
10.3Examples

11

Get Accumulators
11.1Request Data
11.2Response Data
11.3Examples

12

Set Accumulators
12.1Request Data
12.2Response Data
12.3Examples

13

Delete Accumulators
13.1Request Data
13.2Response Data
13.3Examples

14

Set AIR Run Periodic Account Management
14.1Request Data
14.2Response Data
14.3Examples

15

Get AIR Capabilities
15.1Request Data
15.2Response Data
15.3Examples

16

Create AF Subscription
16.1Request Data
16.2Examples

17

Set AF Subscription
17.1Request Data
17.2Examples

18

Get AF Subscription
18.1Request Data
18.2Response Data
18.3Examples

19

Delete AF Subscription
19.1Request Data
19.2Examples

20

Create AF Identifier
20.1Request Data
20.2Examples

21

Set AF Identifier
21.1Request Data
21.2Examples

22

Get AF Identifier
22.1Request Data
22.2Response Data
22.3Examples

23

Delete AF Identifier
23.1Request Data
23.2Examples

24

Set PredefinedOffer
24.1Request Data
24.2Response Data
24.3Examples

25

Get PredefinedOffer
25.1Request Data
25.2Response Data
25.3Examples

26

Delete PredefinedOffer
26.1Request Data
26.2Response Data
26.3Examples

27

Faults and Errors
27.1AIR Error Codes
27.2AF Error Codes
27.3CAI3G Error Message Example

Reference List

1   Introduction

This section contains information about the prerequisites, purpose, scope, and target group for the document. This section also contains information about typographic conventions used in this document.

1.1   Purpose and Scope

This document describes the supported methods for Changing System. This document also declares the types and occurrences of the attributes used in the operations.

Note:  
This document is not a tutorial of CAI3G, it must be used together with document Generic CAI3G Interface 1.2, Reference [2], and CAI3G Implementation, Reference [3].

For more information about Charging System , refer to Solution Description Charging and CBiO, Reference [5].

1.2   Target Groups

The target group for this document is as follows:

For more information about the different target groups, see Library Overview, Reference [1].

1.3   Typographic Conventions

Typographic conventions are described in the document Library Overview, Reference [1].

1.4   Prerequisites

To use this document fully, users must meet the following prerequisites:

1.5   Namespaces

The following namespaces are referred to in this document:

1.6   Legends

The following table shows the legends used in Extensible Markup Language (XML) schema figures in this specification.

Table 1    Legends Used in XML Schema Figures in This Specification

Legend

Description

XML attribute

Optional XML element

Mandatory XML element

Structured element

Subobject element


The occurrence of this element is 0–15

User-defined type


This is not a standard XML schema type. It is introduced to describe Managed Object (MO) schema structure more clearly. In practice, this type is to be replaced by the corresponding elements.

1.7   Operations

1.7.1   AIR Service

One Managed Object (MO) with four operations are described in this document. See the following table for the commands and valid operations for AIR service:

Table 2    AIR Provisioning MOs

MO

Operation

Create

Get

Set

Delete

Subscription

x

x

x

x

Offer

 

x

x

x

CommunicationID

   

x

 

Refill

   

x

 

Accumulators

 

x

x

x

Capabilities

 

x

   

PredefinedOffer

 

x

x

x

RunPeriodicAccountManagement

   

x

 

1.7.2   AF Service

One Managed Object (MO) with four operations are described in this document. See the following table for the commands and valid operations for AF service:

Table 3    AF Provisioning MOs

MO

Operation

Create

Get

Set

Delete

Subscription

x

x

x

x

Identifier

x

x

x

x

1.8   Web Service Interface

The Web Services Definition Language (WSDL) and XML Schema Definition Language (XSD) files that describe the provisioning interface can be retrieved by following below instruction:

  1. Save the zip file, Multi_Activation_WSDL_ and_ XSD_ files.zip, to a local folder.
  2. Extract the zip file.
  3. Check the InterfacesPGNGN directory for PG NGN-related interfaces.

1.9   MOType

MOType is a plain text string based on the type xs:string. An MOType consists of two parts. One is the namespace of the MO, and the other is the MO name string that is always starting with an alphabetical character in either upper or lower case, followed by zero or more alphabetical characters, digits or underscores.

Those two parts are connected with symbol @. The syntax of the MOType string is MO_Name@MO_Namespace. The name string of an MOType must follow the regular expression: [A-Za-z][A-Za-z0-9]*

The MO name together with the MO namespace must be globally unique.

1.10   MOId

MOId is an XML fragment containing the MOId parameter-value pairs that are used to identify an MO instance in the interface data model. CAI3G 1.2 standard supports compound MO identifiers or multiple MO identifier. The following is an example of an MOId:

Example 1   Example of MOId

<MOId>
   <msisdn>46455395000</msisdn>
   <imsi>46234563545000</imsi>
</MOId>

The MOId is defined as a sequence of xs:any element in CAI3G schema file. It is the developers responsibility to define the real schema for this parameter.

The MOId is also the key attributes that must be defined in the top-level element, CreateMODefinition or SetMODefinition, within MOAttributes parameter.

Each implementation of CAI3G interface is to define own logic relationship of MOId. It is also the CAI3GAgents responsibility to interpret this parameter correctly by either the hard-coded logic or the dynamic parsing of the schema.

2   Create AIR Subscription

This section covers the AIR command createSubscription.

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AIR/

2.1   Request Data

2.1.1   Parameters

MOId

Table 4    Create Subscription MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 5 covers the parameters that can be used in a createSubscription request.

Table 5    Create Subscription Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time (in milliseconds) plus seven random digital numbers as the parameter to NEs.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer toUser Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Mandatory

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

serviceClassNew

Integer, 0 - 9999

Optional (0-1)

New service class for the refill.

temporaryBlockedFlag

Boolean {0, 1}


0 (false) = Default value. Unblocked


1 (true) = Temporary blocked

Optional (0-1)

Indicate whether the subscriber and operator has access to subscriber and account data.


A temporary blocked subscriber does not have access to the account, and any messages requesting changes in the account or subscriber data are rejected. Therefore in case temporary blocked is set, a temporary blocked indication is set in the response code of the response message and the action is rejected. It is always possible to read data, but the only way to change data again is to unblock the subscriber.

languageIDNew

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-1)

The new preferred language of the subscriber.

ussdEndOfCallNotificationID

Integer, 0 - 255


0–199 = As defined in the tariff trees


200–254 = Reserved


255 = No ID assigned (clears previously assigned ID)

Optional (0-1)

This parameter identifies which decision tree to use, when selecting the appropriate USSD text string for the End of Call Notification message to the subscriber.

accountGroupID

Integer, 0 – 2147483647

Optional (0-1)

The Account Group identity for the account.


0 indicate clearing of account group (when set to 0 the account does not belong to any account group).

serviceOfferings

Sub-MO

Optional (0-n)

The values of the service offerings defined on an account.

 

serviceOfferingID

Integer, 1 - 31

Mandatory

The identity of a current service offering defined on an account.

 

serviceOfferingActiveFlag

Boolean {0, 1}


0 (false) = The service offering is not active.


1 (true) = The service offering is active.

Mandatory

Indicates whether a specific service offering pointed out by the serviceOfferingID parameter is active or not.

serviceOfferingsValue

 

Optional (0-1)

The value of service offerings

promotionPlanID

String, 1 - 4 characters

Mandatory

The identity of one of the current promotion plans of a subscriber.

promotionStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

Start date of the associated promotion plan.

promotionEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

End date of the associated promotion plan.

accountHomeRegion

Integer, 0 - 999

Optional (0-1)

The home region for the account.


Zero means no home region set.

periodicAccountManagementData

Sub-MO

Optional (0-n)

Periodic account management data for a subscriber.

 

pamServiceID

Integer, 0 - 99

Mandatory

The id of the periodic account management service.

 

pamClassID

Integer, 0 - 9999

Mandatory

The periodic account management class used by the periodic account management service.

 

scheduleID

Integer, 0 - 9999

Mandatory

The schedule that is used by the periodic account management service.

 

currentPamPeriod

String, 1 - 30 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

periodic account management period that is currently used for the subscriber.

 

deferredToDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The deferred to date for the Periodic Account Management service.

 

pamServicePriority

Integer, 0 - 65535

Optional (0-1)

Indicate the priority between PAM services at PAM evaluation. Lower value gives higher priority.

transactionCurrency

String, Currency

Optional (0-1)

The ID to point out what currency is used for the transaction.


For example, SEK, EUR, USD, etc.

accountPrepaidEmptyLimit

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

This parameter is used to set a lowest allowed balance on an account.

masterAccountNumber

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the master subscriber in a multi user account.


The format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeros.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

offerUpdateInformation

Sub-MO

Optional (0-n)

Offer update information for a subscriber.

 

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

 

dateInformation

Sub-MO

Optional (0-1)

The date information of a request

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime.

   

startDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date. The adjustment can be positive or negative. It is expressed in number of days.

   

startPamPeriod

Sub-MO

Mandatory

The Periodic Account Management period

     

startPamPeriodIndicator

Integer, 0 - 99

Mandatory

The Periodic Account Management period when the offer and DA becomes valid. If the offer has the capability of date and time, the time stamp is set to 00:00:00 by default.


Update of the PAM period indicator on an existing offer will keep the current time stamp unchanged. Time stamp can however be changed by including currentTimeOffset.


Zero means the start date of an offer or a DA is the current date.

     

currentTimeOffset

Boolean {0 ,1}


0 (false) = Time stamp will not be set (default value apply if applicable).


1 (true) = Time stamp will be set to the current system time.

Optional (0-1)

Indicates whether the default time or current time can be used in time stamp.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

expiryDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to an expiry date. The adjustment can be positive or negative. It is expressed in number of days.

   

expiryPamPeriodIndicator

Integer, 1- 100 and 2147483647


2147483647 = no expiry.

Optional (0-1)

The Periodic Account Management period when the offer or DA becomes invalid. When the offer has the capability of storing date and time, the time stamp will be set to 00:00:00 or 23:59:59 depending on system configuration.

 

dateTimeInformation

Sub-MO

Optional (0-1)

The date and time information

   

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

startDateTimeRelative

Integer, -99 999 999 to 99 999 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date and time for an offer. The adjustment can be positive or negative. It is expressed in number of seconds. The parameter may also be used to define start date and time for other entities depending on the context where it is used.

   

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Element Value Range: DateMin to DateMax or DateInfinite

   

expiryDateTimeRelative

Integer, -99 999 999 to 99 999 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current expiry date and time. The adjustment can be positive or negative. It is expressed in number of seconds. The parameter may also be used to define expiry date and time for other entities depending on the context where it is used.

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerType

Integer, 0 - 7

Optional (0-1)

Identifies the offer type.

 

dedicatedAccountUpdateInformation

Sub-MO

Optional (0-n)

The information for updating balances and expiry date for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountPamPeriodInformation

Sub-MO

Optional (0-1)

 
     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

adjustmentAmountRelative

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 Unit

Optional (0-1)

The amount of the adjustment (positive or negative) to be applied to the account.

     

dedicatedAccountValueNew

String, 0 -9223372036854775807 Unit

Optional (0-1)

Value to assign to a dedicated account. This is not taking in consideration any ongoing chargeable events.

     

adjustmentDateRelative

Integer, -32767 to -1 and 1 to 32767

Optional (0-1)

This parameter is used to make a relative adjustment to the current expiry date. The adjustment can be positive or negative. It is expressed in number of days.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

expiryPamPeriodIndicator

Integer, 1- 100 and 2147483647


2147483647 = no expiry.

Optional (0-1)

The Periodic Account Management period when the offer or DA becomes invalid. When the offer has the capability of storing date and time, the time stamp will be set to 00:00:00 or 23:59:59 depending on system configuration.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime.

     

adjustmentStartDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date. The adjustment can be positive or negative. It is expressed in number of days.

     

startPamPeriodIndicator

Integer, 0 - 99

Optional (0-1)

The startPamPeriodIndicator parameter indicates the Periodic Account Management period when the offer and DA becomes valid. If the offer has the capability of date and time, the time stamp will default to 00:00:00.


Update of the PAM period indicator on an existing offer will keep the current time stamp unchanged. Time stamp can however be changed by including currentTimeOffset.


Zero means that the start date of an offer or a DA is the current date.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

     

expiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current start date for a dedicated account. Used for validation. No validation is performed if omitted.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

updateAction

String


Enumeration value="EXPIRE"

Optional (0-1)

Indicates which action to take on the resource.


EXPIRE = Expire the resource immediately.

 

updateAction

String


Enumeration value="EXPIRE"

Optional (0-1)

Indicates which action to take on the resource.


EXPIRE = Expire the resource immediately.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

attributeUpdateInformation

Sub-MO

Optional (0-n)

Update information of the attribute

   

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

   

attributeUpdateAction

String


Enumeration value="ADD"


Enumeration value="DELETE"


Enumeration value="CLEAR"


Enumeration value="SET"

Mandatory

The requested action for an attribute.


ADD: Add an entry to the set (for attributes storing a set of values).


DELETE: Delete an entry from the set (for attributes storing a set of values).


CLEAR: Clear all entries from the set (for attributes storing a set of values) or removes the value for a single value attribute.


SET: Sets the value for a single value attribute. Previous value, if existing, will be overwritten.

   

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

attributeValueDecimal

Sub-MO

Optional (0-1)

Information about a decimal value.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

attributeValueInteger

Integer, -2147483648 to 2147483648

Optional (0-1)

The integer value of an attribute.

2.2   Response Data

2.2.1   Parameters

MOId

Table 6    Create Subscription Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 7 covers the parameters that can be used in a createSubscription response.

Table 7    Create Subscription Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

periodicAccountManagementData

Sub-MO

Optional (0-n)

Information used for periodic account management.

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

currentPamPeriod

String, 1 - 33 characters


Characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

The periodic account management period that is currently used for the subscriber.

 

lastEvaluationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date of the last periodic account management evaluation.


Element Value Range: DateMin to DateMax

negotiatedCapabilities

Interger: array of <int> or <i4>


0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node.


The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

2.3   Examples

2.3.1   Example of Creating a Master Subscriber

This section gives an example of the createSubscription request and response message. This example shows how to create a Master subscriber

Request Example

Example 2   Create Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>55897214</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:createSubscription subscriberNumber="55897214">               
               <air:originNodeType>ADM</air:originNodeType>               
               <air:originHostName>emasa</air:originHostName>               
               <air:originTransactionID>20120304171831</air:originTransactionID>               
               <air:originTimeStamp>2005-04-22T14:15:21-06:00</air:originTimeStamp>               
               <air:subscriberNumber>55897214</air:subscriberNumber>               
               <air:originOperatorID>operator33</air:originOperatorID>               
               <air:serviceClassNew>5001</air:serviceClassNew>
               <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
               <air:negotiatedCapabilities>256</air:negotiatedCapabilities>
               <air:offerUpdateInformation>
                  <air:offerID>513</air:offerID>
                  <air:dateInformation>                                                          
                     <air:startDateRelative>111</air:startDateRelative>
                     <air:expiryDateRelative>111</air:expiryDateRelative>                     
                  </air:dateInformation>                  
                  <air:updateAction>EXPIRE</air:updateAction>
               </air:offerUpdateInformation>
            </air:createSubscription>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 3   Create Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>037c43b769fa4dce9d5fa5d74e651abd</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <CreateResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">55897214</air:subscriberNumber>
         </MOId>
         <MOAttributes>
            <air:createSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>55897214</air:subscriberNumber>
               <air:originTransactionID>20120304171831</air:originTransactionID>
               <air:originOperatorID>operator33</air:originOperatorID>
               <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
               <air:negotiatedCapabilities>256</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
               <air:availableServerCapabilities>16296</air:availableServerCapabilities>
            </air:createSubscriptionResponse>
         </MOAttributes>
      </CreateResponse>
   </S:Body>
</S:Envelope>

2.3.2   Example of Creating a Subordinate Subscriber

This section gives an example of the createSubscription request and response message. This example shows how to create a subordinate subscriber

Request Example

Example 4   Create Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>f1c5d6e5bc044a908622e02c565a3a9b</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:createSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:serviceClassNew>111</air:serviceClassNew>
            </air:createSubscription>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 5   Create Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>f1c5d6e5bc044a908622e02c565a3a9b</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <CreateResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
              xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
              xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000001
            </air:subscriberNumber>
         </MOId>
         <MOAttributes>
            <air:createSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14411764631589415223</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:createSubscriptionResponse>
         </MOAttributes>
      </CreateResponse>
   </S:Body>
</S:Envelope>

3   Get AIR Subscription

This section covers the AIR command getSubscription .

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AIR/

3.1   Request Data

3.1.1   Parameters

MOId

Table 8    Get Subscription MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 9 covers the parameters that can be used in a getSubscription request.

Table 9    Get Subscription Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

accountDetails

 

Optional (0-1)

A list of the account details.

 

messageCapabilityFlag

 

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

   

promotionNotificationFlag

Boolean {0, 1}


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

   

firstIVRCallSetFlag

Boolean {0, 1}


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

   

accountActivationFlag

Boolean {0, 1}


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance will be applied.

Optional (0-1)

Indicate whether pre-activated accounts may be or will not be activated due to the request.

 

requestedInformationFlags

 

Optional (0-1)

The elements to be returned or not returned in a response.

   

requestMasterAccountBalanceFlag

Boolean {0, 1}


0 (false) = Default value. Do not return.


1 (true) = Return.

Optional (0-1)

Indicate whether the currency1, accountValue1, aggregatedBalance1, currency2, accountvalue2 and aggregatedBalance2 parameters shall be returned or not.

   

allowedServiceClassChangeDateFlag

Boolean {0, 1}


0 (false) = Default value. Do not return.


1 (true) = Return.

Optional (0-1)

Indicate whether the serviceClassChangeUnbarDate parameter shall be returned or not.

   

requestLocationInformationFlag

Boolean {0, 1}


0 (false) = Default value. Do not return.


1 (true) = Return.

Optional (0-1)

Used to retrieve location information.

 

requestPamInformationFlag

Boolean {1}


1 (true) = Periodic Account Management information

Optional (0-1)

Indicate whether periodic account management information is to be included in the response.

 

requestActiveOffersFlag

Boolean {0, 1}


0 (false) = Default value. The response will contain the active as well as the inactive (or disabled)


1 (true) = The response will not contain the inactive (or disabled) offers for the subscriber. Only active offers will be returned

Optional (0-1)

Indicate whether the state of the offers that should be included in a response.

 

requestAttributesFlag

Boolean {0, 1}


0 (false) = Default value. The response will not contain attributes.


1 (true) = The response will contain attributes, if existing.

Optional (0-1)

Indicate whether the attribute stored for the offer is to be included in a response.

 

requestTreeParameterSetsFlag

Boolean {0, 1}


0 (false) = Default value. The response will not contain tree parameter sets.


1 (true) = The response will contain tree parameter sets, if existing.

Optional (0-1)

Indicates if tree parameter sets for all types of trees stored for the offer are to be included in a response.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.

allowedServiceClasses

Sub-MO

Optional (0-1)

The information of service classes the subscriber is allowed to change to.

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

balanceAndDate

 

Optional (0-1)

It is used to perform a balance enquiry on the account associated with a specific subscriber identity. Also lifecycle dates are presented. Information is given on both main and dedicated accounts.

 

messageCapabilityFlag

 

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

   

promotionNotificationFlag

Boolean { 0, 1 }


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

   

firstIVRCallSetFlag

Boolean { 0, 1 }


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

   

accountActivationFlag

Boolean { 0, 1 }


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance is applied.

Optional (0-1)

Indicate whether pre-activated accounts can be or cannot be activated due to the request. The possibility to activate a pre-activated account by this flag is configured in the account databases service class configuration. This results in that even if the flag is set to true the account may not be activated.

 

dedicatedAccountSelection

Sub-MO

Optional (0-n)

This parameter is used to select which dedicated accounts that will be returned.

   

dedicatedAccountIDFirst

Integer, 1 - 2147483647

Mandatory

The identity of the first dedicated account in a sequence of dedicated accounts, or the only dedicated account identity if a single dedicated account shall be obtained.

   

dedicatedAccountIDLast

Integer, 1 - 2147483647

Optional (0-1)

The identity of the last dedicated account in a sequence of dedicated accounts.

 

chargingRequestInformation

 

Optional (0-1)

This parameter contains request information for a charged end user communication event.

   

chargingType

Integer, 1 - 6


1 = Check order and make reservation


2 = Perform order and make deduction


3 = Perform order and commit reservation


4 = Rollback reservation


5 = Get allowed options


6 = Rate and check (reserved for future use)

Optional (0-1)

This parameter contains information how the request is to be charged and which mechanism to use.

   

chargingIndicator

Integer, 0 - 65535

Optional (0-1)

An indicator for rating differentiation.

   

reservationCorrelationID

Integer, 0 - 2147483647

Optional (0-1)

The id needed to correlate a reservation.

 

requestSubDedicatedAccountDetailsFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the associated subDedicatedAccountInformation structs.


1 (true) = The response will include the associated subDedicatedAccountInformation structs.

Optional (0-1)

Indicate the requested detail level of the content in the dedicatedAccountInformation.

 

requestFirstAccessibleAndExpiredBalanceAndDateFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the associated closestExpiryDate, closestExpiryValue1, closestExpi ryValue2, closestAccessibleDate, closestAccessibleValue1,closestAcc essibleValue2.


1 (true) = The response will include the associated closestExpiryDate, closestExpiryValue1, closestExpi ryValue2, closestAccessibleDate, closestAccessibleValue1,closestAcc essibleValue2.

Optional (0-1)

Indicate the requested detail level of the content in the dedicatedAccountInformation.

 

requestActiveOffersFlag

Boolean {0, 1}


0 (false) = Default value. The response will contain the active as well as the inactive (or disabled)


1 (true) = The response will not contain the inactive (or disabled) offers for the subscriber. Only active offers will be returned

Optional (0-1)

Indicate whether the state of the offers that should be included in a response.

 

requestAttributesFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not contain attributes.


1 (true) The response will contain attributes, if existing.

Optional (0-1)

Indicate whether the attribute stored for the offer is to be included in a response.

 

requestTreeParameterSetsFlag

Boolean {0, 1}


0 (false) = Default. The response will not contain tree parameter sets.


1 (true) = The response will contain tree parameter sets, if existing.

Optional (0-1)

Indicates if tree parameter sets for all types of trees stored for the offer are to be included in a response.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.

fafList

 

Optional (0-1)

Family and Friends List.

 

requestedOwner

Integer, 1- 3


1 = Subscriber


2 = Account


3 = Subscriber and account

Mandatory

Indicate whether the data is attached to the account or subscriber.

promotionCounters

 

Optional (0-1)

It returns the current accumulated values used as base for the calculation of when to give a promotion and when to progress a promotion plan.

promotionPlans

 

Optional (0-1)

It returns the promotion plans allocated to the subscribers account.

refillOptions

Integer, 1- 999

Optional (0-1)

It contains the value of a refill option

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

 

voucherActivationCode

String, 8 - 20 digits

Mandatory

The activation number which is the unique secret code on the voucher which the subscriber uses when performing a voucher based refill of the account. The format includes support of leading zeroes.

 

messageCapabilityFlag

 

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

   

promotionNotificationFlag

Boolean { 0, 1 }


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

   

firstIVRCallSetFlag

Boolean { 0, 1 }


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

   

accountActivationFlag

Boolean { 0, 1 }


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance is applied.

Optional (0-1)

Indicate whether pre-activated accounts can be or cannot be activated due to the request. The possibility to activate a pre-activated account by this flag is configured in the account databases service class configuration. This results in that even if the flag is set to true the account may not be activated.

usageThresholdsAndCounters

 

Optional (0-1)

Information of active usage thresholds and usage counters for a subscriber.

 

originOperatorID

String, 1- 255 characters

Optional (0-1)

Identity of the system user or the session from where the operation was initiated.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

3.2   Response Data

3.2.1   Parameters

MOId

Table 10    Get Subscription Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 11 covers the parameters that can be used in a getSubscription response.

Table 11    Get Subscription Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

accountDetails

 

Optional (0-1)

A list of the account details.

 

firstIVRCallFlag

Boolean, {1}


1 (true) = The current IVR session is the first IVR call.

Optional (0-1)

This flag is sent to inform the client that the current IVR session is the first IVR call.

 

languageIDCurrent

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-1)

The preferred language of subscriber.

 

serviceClassOriginal

Integer, 0 - 9999

Optional (0-1)

The identity of the original service class when a temporary service class is active for an account.

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

 

serviceClassTemporaryExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of a temporary service class of an account.


A temporary service class has precedence before the normally assigned service class, as long as the temporary service class date expiry date is not passed.

 

ussdEndOfCallNotificationID

Integer, 0 - 255


0–199 = As defined in the tariff trees


200–254 = Reserved


255 = No ID assigned (clears previously assigned ID)

Optional (0-1)

This parameter identifies which decision tree to use, when selecting the appropriate USSD text string for the End of Call Notification message to the subscriber.

 

accountGroupID

Integer, 0 - 2147483647

Optional (0-1)

The Account Group identity for the account.


0 indicate clearing of account group (when set to 0 the account does not belong to any account group).

 

serviceOfferings

Sub-MO

Optional (0-n)

The values of the service offerings defined on an account. It has to be matched to the definitions of the tariff tree.

   

serviceOfferingID

Integer, 1 - 31

Mandatory

The identity of a current service offering defined on an account.

   

serviceOfferingActiveFlag

Boolean { 0, 1 }


0 (false) = The service offering is not active.


1 (true) = The service offering is active.

Mandatory

Whether a specific service offering pointed out by the serviceOfferingID parameter is active or not.

 

communityInformationCurrent

String

Optional (0-1)

The community the subscriber currently belongs to.

 

temporaryBlockedFlag

Boolean {0, 1}


0 (false) = Default value. Unblocked


1 (true) = Temporary blocked

Optional (0-1)

Indicate whether the subscriber and operator has access to subscriber and account data.


A temporary blocked subscriber does not have access to the account, and any messages requesting changes in the account or subscriber data are rejected. Therefore in case temporary blocked is set, a temporary blocked indication is set in the response code of the response message and the action is rejected. It is always possible to read data, but the only way to change data again is to unblock the subscriber.

 

accountActivatedFlag

Boolean {1}


1 (true) = Account got activated as a result of the User Communication session.

Optional (0-1)

This flag is sent when the account got activated as a result of the User Communication session.

 

activationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The activation date of an account. Subordinate subscribers will contain the activation date of the master account.


Element Value Range: DateMin to DateToday

 

accountFlags

 

Optional (0-1)

The life cycle state flags of the account, indicating the actual status of the account.

   

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

 

masterSubscriberFlag

Boolean, { 1 }


1 (true) = The user is the master subscriber of the account.

Optional (0-1)

Indicate that the user is the master subscriber of the account.

 

masterAccountNumber

String, 1 - 28

Optional (0-1)

The subscriber identity of the master subscriber in a multi user account.


The format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeros.

 

refillUnbarDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time when a refill barred subscriber is unbarred and is allowed to do a new refill.

 

promotionAnnouncementCode

Integer, 0 - 99

Optional (0-1)

The promotional code for the announcement to be played.

 

promotionPlanID

String, 1 - 4

Optional (0-1)

The identity of one of the current promotion plans of a subscriber.

 

promotionStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Start date of the associated promotion plan.

 

promotionEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

End date of the associated promotion plan.

 

supervisionExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Expiry date of the supervision period.

 

creditClearanceDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the credit clearance period will expire.

 

serviceRemovalDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the account will be removed after the service removal period has expired.

 

serviceFeeExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the service fee period.

 

serviceClassChangeUnbarDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when a charged service class change will be unbarred, that is allowed again. If sent, a charged service class change is not allowed. Today's date and dates older than today's date will not be sent.


Element Value Range: DateTomorrow to DateMax.

 

serviceFeePeriod

Integer, -32767 to 32767

Optional (0-1)

Number of days until the service fee period expires.

 

supervisionPeriod

Integer, -32767 to 32767

Optional (0-1)

Number of days until the supervision period expires.

 

serviceRemovalPeriod

Integer, 0 - 1023

Optional (0-1)

The period until service removal.

 

creditClearancePeriod

Integer, 0 - 1023

Optional (0-1)

The period until credit clearance.

 

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

accountValue1

Sting, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the first currency.

 

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

accountValue2

Sting, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the second currency.

 

accountHomeRegion

Integer, 0 - 999

Optional (0-1)

The home region for the account.


Zero means no home region set.

 

periodicAccountManagementData

Sub-MO

Optional (0-n)

Information used for periodic account management.

   

pamServiceID

Integer, 0 - 99

Mandatory

The id of the periodic account management service.

   

pamClassID

Integer, 0 - 9999

Mandatory

The periodic account management class used by the periodic account management service.

   

scheduleID

Integer, 0 - 9999

Mandatory

The schedule that is used by the periodic account management service.

   

currentPamPeriod

String, 1 - 30 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Mandatory

The periodic account management period that is currently used for the subscriber.

   

deferredToDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The deferred to date for the Periodic Account Management service.

   

lastEvaluationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date of the last periodic account management evaluation.

   

pamServicePriority

Integer, 0 - 65535

Optional (0-1)

Indicate the priority between PAM services at PAM evaluation. Lower value gives higher priority.

 

maxServiceFeePeriod

Integer, 0 - 32767

Optional (0-1)

The maximum allowed duration of the service fee period in number of days until the period expires.

 

maxSupervisionPeriod

Integer, 0 - 32767

Optional (0-1)

The maximum allowed duration of the supervision period in number of days until the period expires.

 

negativeBalanceBarringDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when a subscriber is scheduled to be barred, or was barred, due to negative balance.


Element Value Range: DateMin to DateMax

 

accountFlagsBefore

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account before.

   

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

 

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

   

offerID

Integer, 0 - 2147483647

Optional (0-1)

The identity of an offer.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

   

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

   

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

   

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

     

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

     

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

     

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

     

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

     

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

     

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

       

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

       

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

       

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

       

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

       

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

       

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

       

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

       

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

       

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

       

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

       

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

     

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

This flag indicates that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts.

   

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

     

attributeName

String, 1 - 128 characters

Optional (0-1)

The name of the attribute.

     

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

     

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

     

attributeValueDecimal

 

Optional (0-1)

Information about a decimal value.

       

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

     

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

     

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

   

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

     

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rule determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

     

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

       

treeParameterName

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

       

treeParameterValueString

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

       

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

       

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals that are used.

         

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

         

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

       

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter.

       

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

         

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

         

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

         

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

         

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

         

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

         

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

         

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

         

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

       

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

treeParameterValueDateRange

 

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

         

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

         

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

       

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

       

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

 

cellIdentifier

String, 1 - 19


1 - 19 = Numeric


0 - 19 CAP = 14 CGI/SAI

Optional (0-1)

This parameter output the CellGlobal Identity (CGI) or Service Area Identity (SAI). It can be sent as an input parameter through UCIP. If not sent as parameter, this parameter is retrieved from the HLR using ATI request.


The cellIdentifier parameter can also be a return parameter through UCIP.

 

locationNumber

String, 1 - 20 digits

Optional (0-1)

The parameter contains the location of the subscriber. The default numbering format in the parameter is the same numbering format that is used for subscriber numbers in the Account Database. If another format is used, then it must be indicated by ‘‘Location Number NAI’’

 

accountPrepaidEmptyLimit1

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the first currency

 

accountPrepaidEmptyLimit2

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the second currency

allowedServiceClasses

 

Optional (0-1)

The information of service classes the subscriber is allowed to change to.

 

serviceClassCurrent

Integer, 0 - 9999

Mandatory

The service class currently used by the subscriber.

 

serviceClass

Integer, 0 - 9999

Optional (0-n)

The list of new service classes which the subscriber is allowed to change to.

promotionCounters

 

Optional (0-1)

It returns the current accumulated values used as base for the calculation of when to give a promotion and when to progress a promotion plan.

 

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

promotionRefillAccumulatedValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the first currency.

 

promotionRefillAccumulatedValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the second currency.

 

promotionRefillCounter

Integer, 0 - 255

Optional (0-1)

The accumulated number of account refills within the current promotion plan of a subscriber.

 

progressionRefillValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the first currency.

 

progressionRefillValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the second currency.

 

progressionRefillCounter

Integer, 0 - 255

Optional (0-1)

The value of the accumulated number of refills for promotion plan progression.

balanceAndDate

 

Optional (0-1)

It is used to perform a balance enquiry on the account associated with a specific subscriber identity. Also lifecycle dates are presented. Information is given on both main and dedicated accounts.

 

serviceClassCurrent

Integer, 0 - 9999

Mandatory

The service class currently used by the subscriber.

 

currency1

String, Currency

 

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

accountValue1

Sting, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the first currency. The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

accountValue2

Sting, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the second currency.


For example, SEK, EUR, USD, etc.

 

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

This flag indicates that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts.

 

supervisionExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the supervision period.

 

serviceFeeExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the service fee period.

 

creditClearanceDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the credit clearance period will expire.

 

serviceRemovalDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the account will be removed after the service removal period has expired.

 

languageIDCurrent

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-n)

The preferred language of subscriber.

 

temporaryBlockedFlag

Boolean {0, 1}


0 (false) = Default value. Unblocked


1 (true) = Temporary blocked

Optional (0-1)

Indicate whether the subscriber and operator has access to subscriber and account data.


A temporary blocked subscriber does not have access to the account, and any messages requesting changes in the account or subscriber data are rejected. Therefore in case temporary blocked is set, a temporary blocked indication is set in the response code of the response message and the action is rejected. It is always possible to read data, but the only way to change data again is to unblock the subscriber.

 

chargingResultInformation

 

Optional (0-1)

Information for a charged end user communication event.

   

cost1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the first currency.

   

currency1

String, ISO 4217 standard

Optional (0-1)

The first currency to be presented to the end user.

   

cost2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the second currency.

   

currency2

String, ISO 4217 standard

Optional (0-1)

The second currency to be presented to the end user.

   

chargingResultCode

Integer, 0 - 2


0 = or not present Successful


1 = No charge (free counter stepped)


2 = No charge (free counter not stepped)

Optional (0-1)

Information related to a charged event.

   

reservationCorrelationID

Integer, 0 - 2147483647

Optional (0-1)

The id needed to correlate a reservation.

   

chargingResultInformationService

 

Optional (0-1)

Result information regarding a service for a charged end user communication event

     

cost1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the first currency.

     

cost2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the second currency.

 

accountFlagsAfter

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account after.

   

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

 

accountFlagsBefore

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account before.

   

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

 

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

   

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

   

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

   

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

   

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

     

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

     

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

     

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

     

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

     

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

     

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

       

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

       

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

       

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

       

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

       

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

       

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

       

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

       

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

       

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

       

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

       

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

     

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

Indicate that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts

   

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

     

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

     

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

     

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

     

attributeValueDecimal

 

Optional (0-1)

Information about a decimal value.

       

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

     

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

     

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contains the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

   

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

     

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rule determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

     

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

       

treeParameterName

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

       

treeParameterValueString

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

       

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

       

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals that are used.

         

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

         

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

       

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter.

       

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

         

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

         

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

         

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

         

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

         

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

         

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

         

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

         

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

       

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

treeParameterValueDateRange

 

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

         

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

         

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

       

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

       

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

 

accountPrepaidEmptyLimit1

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the first currency

 

accountPrepaidEmptyLimit2

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the second currency

fafList

 

Optional (0-1)

Family and Friends List.

 

fafInformation

 

Optional (0-1)

The information of Family and Friends.

   

fafNumber

tring, 1 - 30 digits

Mandatory

A Family and Friends number

   

owner

String


Enumeration value="Subscriber"


Enumeration value="Account"

Mandatory

Indicate whether the data is attached to the account or subscriber.

   

fafIndicator

Integer, 1 - 65535

Optional (0-1)

This parameter is used for differentiated rating for traffic events to and from numbers in the Family and Friends (FaF) number list.

   

exactMatch

Boolean { 0, 1 }


0 = Default value. Match faf number partially.


1 = Match faf number exactly.

Optional (0-1)

Indicate whether the faf number should be matched partial or exact.

 

fafChangeUnbarDate

DateTime.iso8601

Optional (0-1)

The date when a family and friends change is allowed again.


DateTomorrow to DateMax

 

fafMaxAllowedNumbersReachedFlag

Boolean, {0, 1}


0 (false) = Default value. Maximum number of allowed FaF numbers is not reached.


1 (true) = Maximum number of allowed FaF numbers is reached.

Optional (0-1)

A flag indicating that it's not allowed to add more FaF numbers to the FaF-list for this subscriber.

 

fafChargingNotAllowedFlag

Boolean, {0, 1}


0 (false) = Default value. Charged FaF administration is allowed for service class.


1 (true) = Charged FaF administration is not allowed for service class.

Optional (0-1)

Indicate that charged Family and Friends (FaF) administration is not allowed for the current service class.

promotionPlans

 

Optional (0-1)

It returns the promotion plans allocated to the subscribers account.

 

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

 

promotionPlanInformation

 

Optional (0-1)

The information of promotion plan.

   

promotionPlanID

String, 1 - 4

Mandatory

The identity of one of the current promotion plans of a subscriber.

   

promotionStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

Start date of the associated promotion plan.

   

promotionEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

End date of the associated promotion plan.

refillOptions

Integer, 1- 999

Optional (0-1)

It contains the value of a refill option

 

serviceClassCurrent

Integer, 0 - 9999

Mandatory

The service class currently used by the subscriber.

 

refillOptions

Integer, 1- 999

Mandatory

It contains the value of a refill option

 

accountFlagsAfter

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account after.

   

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

 

accountFlagsBefore

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account before.

   

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

usageThresholdsAndCounters

 

Optional (0-1)

Information of active usage thresholds and usage counters for a subscriber.

 

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

 

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.

 

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.

 

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

   

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

   

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

   

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

   

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

   

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

   

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

     

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

     

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

     

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

     

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

     

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

3.3   Examples

3.3.1   Example of Retrieving the Account Details

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the account details of a subscriber.

Request Example

Example 6   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>${Properties#sessionId}</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>4955897213</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="4955897213">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:accountDetails>
                  <air:requestAttributesFlag>1</air:requestAttributesFlag>
                  <air:requestTreeParameterSetsFlag>1</air:requestTreeParameterSetsFlag>
               </air:accountDetails>
               <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
               <air:negotiatedCapabilities>168</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 7   Get Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>bf64107bff654bdeb82a25a01e260ce6</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010005</air:subscriberNumber>
               <air:originTransactionID>1445324795536584705</air:originTransactionID>
               <air:accountDetails>
                  <air:firstIVRCallFlag>1</air:firstIVRCallFlag>
                  <air:languageIDCurrent>1</air:languageIDCurrent>
                  <air:serviceClassCurrent>111</air:serviceClassCurrent>
                  <air:ussdEndOfCallNotificationID>0</air:ussdEndOfCallNotificationID>
                  <air:accountGroupID>1</air:accountGroupID>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>1</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>2</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>3</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>4</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>5</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>6</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>7</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>8</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>9</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>10</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>11</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>12</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>13</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>14</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>15</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>16</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>17</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>18</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>19</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>20</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>21</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>22</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>23</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>24</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>25</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>26</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>27</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>28</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>29</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>30</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:serviceOfferings>
                     <air:serviceOfferingID>31</air:serviceOfferingID>
                     <air:serviceOfferingActiveFlag>0</air:serviceOfferingActiveFlag>
                  </air:serviceOfferings>
                  <air:accountFlags>
                     <air:activationStatusFlag>0</air:activationStatusFlag>
                     <air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
                     <air:supervisionPeriodWarningActiveFlag>
                      0</air:supervisionPeriodWarningActiveFlag>
                     <air:serviceFeePeriodWarningActiveFlag>
                      0</air:serviceFeePeriodWarningActiveFlag>
                     <air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
                     <air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
                  </air:accountFlags>
                  <air:masterSubscriberFlag>1</air:masterSubscriberFlag>
                  <air:masterAccountNumber>465273152000010</air:masterAccountNumber>
                  <air:promotionPlanID>123</air:promotionPlanID>
                  <air:promotionStartDate>2015-08-26T12:00:00+00:00</air:promotionStartDate>
                  <air:promotionEndDate>2016-08-20T12:00:00+00:00</air:promotionEndDate>
                  <air:serviceRemovalPeriod>0</air:serviceRemovalPeriod>
                  <air:creditClearancePeriod>0</air:creditClearancePeriod>
                  <air:maxServiceFeePeriod>100</air:maxServiceFeePeriod>
                  <air:maxSupervisionPeriod>100</air:maxSupervisionPeriod>
                  <air:accountFlagsBefore>
                     <air:activationStatusFlag>0</air:activationStatusFlag>
                     <air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
                     <air:supervisionPeriodWarningActiveFlag>
                      0</air:supervisionPeriodWarningActiveFlag>
                     <air:serviceFeePeriodWarningActiveFlag>
                      0</air:serviceFeePeriodWarningActiveFlag>
                     <air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
                     <air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
                  </air:accountFlagsBefore>
                  <air:accountPrepaidEmptyLimit1>100</air:accountPrepaidEmptyLimit1>
               </air:accountDetails>
               <air:negotiatedCapabilities>8192</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

3.3.2   Example of Retrieving the Balance and Date Details

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the Balance and Date details of a subscriber.

Request Example

Example 8   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>e1d4bebfdd1e49c287654222abe4022a6</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000014</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000014">
               <air:originNodeType>ADM</air:originNodeType>
                <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>12345</air:originTransactionID>
               <air:originTimeStamp>2015-10-23T12:00:00+00:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:balanceAndDate>
                  <air:messageCapabilityFlag>
                     <air:promotionNotificationFlag>0</air:promotionNotificationFlag>
                     <air:firstIVRCallSetFlag>0</air:firstIVRCallSetFlag>
                     <air:accountActivationFlag>0</air:accountActivationFlag>
                  </air:messageCapabilityFlag>
                    <air:dedicatedAccountSelection>
                    <air:dedicatedAccountIDFirst>1</air:dedicatedAccountIDFirst>
                  </air:dedicatedAccountSelection>
                  <air:dedicatedAccountSelection>
                     <air:dedicatedAccountIDFirst>1</air:dedicatedAccountIDFirst>
                     <air:dedicatedAccountIDLast>2</air:dedicatedAccountIDLast>
                  </air:dedicatedAccountSelection>
                  <air:chargingRequestInformation>
                     <air:chargingType>5</air:chargingType>
                     <air:chargingIndicator>0</air:chargingIndicator>
                     <air:reservationCorrelationID>0</air:reservationCorrelationID>
                  </air:chargingRequestInformation>
                  <air:requestSubDedicatedAccountDetailsFlag>
                  1</air:requestSubDedicatedAccountDetailsFlag>
                  <air:requestFirstAccessibleAndExpiredBalanceAndDateFlag>
                   1</air:requestFirstAccessibleAndExpiredBalanceAndDateFlag>
                  <air:requestActiveOffersFlag>1</air:requestActiveOffersFlag>
                  <air:requestAttributesFlag>1</air:requestAttributesFlag>
               </air:balanceAndDate>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 9   Get Subscription Response Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>e1d4bebfdd1e49c287654222abe4022a6</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000014</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000014">
               <air:originNodeType>ADM</air:originNodeType> 
               <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>12345</air:originTransactionID>
               <air:originTimeStamp>2015-10-23T12:00:00+00:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:balanceAndDate>
                  <air:messageCapabilityFlag>
                     <air:promotionNotificationFlag>0</air:promotionNotificationFlag>
                     <air:firstIVRCallSetFlag>0</air:firstIVRCallSetFlag>
                     <air:accountActivationFlag>0</air:accountActivationFlag>
                  </air:messageCapabilityFlag>
                  <air:dedicatedAccountSelection>
                     <air:dedicatedAccountIDFirst>1</air:dedicatedAccountIDFirst>
                  </air:dedicatedAccountSelection>
                  <air:dedicatedAccountSelection>
                     <air:dedicatedAccountIDFirst>1</air:dedicatedAccountIDFirst>
                     <air:dedicatedAccountIDLast>2</air:dedicatedAccountIDLast>
                  </air:dedicatedAccountSelection>
                  <air:chargingRequestInformation>
                     <air:chargingType>5</air:chargingType>
                     <air:chargingIndicator>0</air:chargingIndicator>
                     <air:reservationCorrelationID>0</air:reservationCorrelationID>
                  </air:chargingRequestInformation>
                  <air:requestSubDedicatedAccountDetailsFlag>
                   1</air:requestSubDedicatedAccountDetailsFlag>
                  <air:requestFirstAccessibleAndExpiredBalanceAndDateFlag>
                   1</air:requestFirstAccessibleAndExpiredBalanceAndDateFlag>
                    <air:requestActiveOffersFlag>1</air:requestActiveOffersFlag>
                  <air:requestAttributesFlag>1</air:requestAttributesFlag>
               </air:balanceAndDate>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope> 

3.3.3   Example of Retrieving the Promotion Plan Details

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the promotion plan details of a subscriber.

Request Example

Example 10   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>f62b6df1ff14466e8fc9a0882a2af237</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000292</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
           <air:getSubscription subscriberNumber="465273152000292">               
               <air:originNodeType>ADM</air:originNodeType>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:promotionPlans/>               
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 11   Get Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>f62b6df1ff14466e8fc9a0882a2af237</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000292</air:subscriberNumber>
               <air:originTransactionID>14461541312756764732</air:originTransactionID>
               <air:promotionPlans>
                  <air:promotionPlanInformation>
                     <air:promotionPlanID>2</air:promotionPlanID>
                     <air:promotionStartDate>2013-09-26T12:00:00+00:00</air:promotionStartDate>
                     <air:promotionEndDate>2015-12-26T12:00:00+00:00</air:promotionEndDate>
                  </air:promotionPlanInformation>
               </air:promotionPlans>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope> 

3.3.4   Example of Retrieving the Promotion Counters Details

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the promotion counters information of a subscriber.

Request Example

Example 12   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8fba5eecbd754021a4f6f2c464eac3c3</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000001">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>12345</air:originTransactionID>
               <air:originTimeStamp>2015-10-23T12:00:00+00:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:promotionCounters/>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>               
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 13   Get Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8fba5eecbd754021a4f6f2c464eac3c3</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getSubscriptionResponse 
               xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>12345</air:originTransactionID>
               <air:promotionCounters>
                  <air:currency1>SEK</air:currency1>
<air:promotionRefillAccumulatedValue1>999999999999</air:promotionRefillAccumulatedValue1>
                  <air:promotionRefillCounter>255</air:promotionRefillCounter>
<air:progressionRefillValue1>999999999999</air:progressionRefillValue1>
<air:progressionRefillCounter>255</air:progressionRefillCounter>
               </air:promotionCounters>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
<air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

3.3.5   Example of Retrieving the FaF List

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the FaF list information of a subscriber.

Request Example

Example 14   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>3da2c60a07064e83ac9372e258e6ae5d</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000001">
               <air:fafList>
                  <air:requestedOwner>3</air:requestedOwner>
               </air:fafList>
<air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 15   Get Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>3da2c60a07064e83ac9372e258e6ae5d</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getSubscriptionResponse 
              xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
<air:originTransactionID>14461546553265469772</air:originTransactionID>
               <air:fafList>
                  <air:fafInformation>
                     <air:fafNumber>0703105001</air:fafNumber>
                     <air:owner>Account</air:owner>
                     <air:fafIndicator>5004</air:fafIndicator>
                  </air:fafInformation>
                  <air:fafInformation>
                     <air:fafNumber>0703105999</air:fafNumber>
                     <air:owner>Subscriber</air:owner>
                     <air:fafIndicator>5003</air:fafIndicator>
                  </air:fafInformation>
               </air:fafList>
<air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
<air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope> 

3.3.6   Example of Retrieving the Refill Options

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the Refill Options of a subscriber.

Request Example

Example 16   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>80b8cc5cc20b477dbd3d7e05d3320424</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000001">
               <air:refillOptions>
                  <air:serviceClassCurrent>0</air:serviceClassCurrent>
<air:voucherActivationCode>00000000</air:voucherActivationCode>
                  <air:messageCapabilityFlag>
<air:promotionNotificationFlag>1</air:promotionNotificationFlag>
                     <air:firstIVRCallSetFlag>1</air:firstIVRCallSetFlag>
                     <air:accountActivationFlag>1</air:accountActivationFlag>
                  </air:messageCapabilityFlag>
               </air:refillOptions>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 17   Get Subscription Response Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>80b8cc5cc20b477dbd3d7e05d3320424</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000001">
               <air:refillOptions>
                  <air:serviceClassCurrent>0</air:serviceClassCurrent>
<air:voucherActivationCode>00000000</air:voucherActivationCode>
                  <air:messageCapabilityFlag>
<air:promotionNotificationFlag>1</air:promotionNotificationFlag>
                     <air:firstIVRCallSetFlag>1</air:firstIVRCallSetFlag>
                     <air:accountActivationFlag>1</air:accountActivationFlag>
                  </air:messageCapabilityFlag>
               </air:refillOptions>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

3.3.7   Example of Retrieving the Usage Thresholds and Counters

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the Usage Thresholds and Counters information of a subscriber.

Request Example

Example 18   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8762d368b14d408bb9e36ef81a8bfffb</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000009</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000009">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:usageThresholdsAndCounters>
               </air:usageThresholdsAndCounters>              
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 19   Get Subscription Response Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8762d368b14d408bb9e36ef81a8bfffb</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>    
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000009</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000009">               
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>         
               <air:usageThresholdsAndCounters>
               </air:usageThresholdsAndCounters>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

3.3.8   Example of Retrieving the Allowed Service Class

This section gives an example of the getSubscription request and response message. This example shows how to retrieve the Allowed Service Class details of a subscriber.

Request Example

Example 20   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8298219224044d389372c5850deeef8e</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000001">
               <air:allowedServiceClasses>
                  <air:serviceClassCurrent>100</air:serviceClassCurrent>
               </air:allowedServiceClasses>
<air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 21   Get Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8298219224044d389372c5850deeef8e</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
<air:originTransactionID>14462116962525038412</air:originTransactionID>
               <air:allowedServiceClasses>
                  <air:serviceClassCurrent>111</air:serviceClassCurrent>
               </air:allowedServiceClasses>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
<air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

4   Set AIR Subscription

This section covers the AIR command SetSubscription .

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AIR/

4.1   Request Data

4.1.1   Parameters

MOId

Table 12    Set Subscription MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 13 covers the parameters that can be used in a setSubscription request.

Table 13    Set Subscription Parameter

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time milliseconds plus seven random digital numbers as the parameter to NEs.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

accountDetails

Sub-MO

Optional (0-1)

A list of the account details.

 

accountPrepaidEmptyLimitAction

String


Enumeration value="SET"


Enumeration value="DELETE"

Optional (0-1)

This parameter contains the requested action for changing the Account Prepaid Empty Limit.


SET = Update the Account Prepaid Empty Limit.


DELETE = Delete the Account Prepaid Empty Limit.

 

messageCapabilityFlag

Sub-MO

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

   

promotionNotificationFlag

Boolean { 0, 1 }


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

   

firstIVRCallSetFlag

Boolean { 0, 1 }


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

   

accountActivationFlag

Boolean { 0, 1 }


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance is applied.

Optional (0-1)

Indicate whether pre-activated accounts can be or cannot be activated due to the request. The possibility to activate a pre-activated account by this flag is configured in the account databases service class configuration. This results in that even if the flag is set to true the account may not be activated.

 

languageIDNew

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-1)

The new preferred language of the subscriber.

 

firstIVRCallDoneFlag

Boolean { 1 }


1 (true) = First IVR call has been done.

Optional (0-1)

Indicate that the first IVR call has been done.

 

externalData1

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

externalData2

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

accountHomeRegion

Integer, 0 - 999

Optional (0-1)

The home region for the account.


Zero means no home region set.

 

ussdEndOfCallNotificationID

Integer, 0 - 255


0–199 = As defined in the tariff trees


200–254 = Reserved


255 = No ID assigned (clears previously assigned ID)

Optional (0-1)

This parameter identifies which decision tree to use, when selecting the appropriate USSD text string for the End of Call Notification message to the subscriber.

 

languageIDCurrent

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-1)

The preferred language of subscriber.

 

transactionCurrency

String, currency

Optional (0-1)

The ID to point out what currency is used for the transaction.


For example, SEK, EUR, USD, etc.

 

accountPrepaidEmptyLimit

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

This parameter is used to set a lowest allowed balance on an account.

periodicAccountManagementData

Sub-MO

Optional (0-n)

Periodic account management data for a subscriber.

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

pamClassID

Integer, 0 - 9999

Optional (0-1)

The periodic account management class used by the periodic account management service.

 

scheduleID

Integer, 0 - 9999

Optional (0-1)

The schedule that is used by the periodic account management service.

 

currentPamPeriod

String, 1 - 30 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

periodic account management period that is currently used for the subscriber.

 

deferredToDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The deferred to date for the Periodic Account Management service.

 

pamServicePriority

Integer, 0 - 65535

Optional (0-1)

Indicate the priority between PAM services at PAM evaluation. Lower value gives higher priority.

 

pamClassIDCurrent

Integer, 0 - 9999

Optional (0-1)

The current periodic account management class used by the periodic account management service.

 

scheduleIDCurrent

Integer, 0 - 9999

Optional (0-1)

 
 

pamServicePriorityCurrent

Integer, 0 - 65535

Optional (0-1)

 

accountGroupID

Integer, 0 - 2147483647

Optional (0-1)

The Account Group identity for the account.


0 indicate clearing of account group (when set to 0 the account does not belong to any account group).

serviceOfferings

Sub-MO

Optional (0-n)

The values of the service offerings defined on an account. It has to be matched to the definitions of the tariff tree.

 

serviceOfferingID

Integer, 1 - 31

Mandatory

The identity of a current service offering defined on an account.

 

serviceOfferingActiveFlag

Boolean { 0, 1 }


0 (false) = The service offering is not active.


1 (true) = The service offering is active.

Mandatory

Whether a specific service offering pointed out by the serviceOfferingID parameter is active or not.

serviceOfferingsValue

Sub-MO

Optional (0-1)

An array of the service offering value in decimal.

 

serviceOfferingsValueAdd

String

Optional (0-1)

The service offerings which is to be added to the subscriber.

 

serviceOfferingsValueDelete

String

Optional (0-1)

The service offerings which is to be deleted from the subscriber.

 

serviceOfferingsValueCurrent

String

Mandatory

The current value of service offerings value.

PromotionPlan

Sub-MO

Optional (0-n)

A list of promotion plan.

 

promotionPlanID

String, 1 - 4 characters

Optional (0-1)

The identity of one of the current promotion plans of a subscriber.

 

promotionPlanIDCurrent

String, 1 - 4 characters

Optional (0-1)

The identity of one of the current promotion plans of a subscriber.

 

promotionOldStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The old start date of the associated promotion plan.

 

promotionOldEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The old end date of the associated promotion plan.

 

promotionStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date of the associated promotion plan.

 

promotionEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The end date of the associated promotion plan.

temporaryBlockedFlag

Boolean { 0, 1 }


0 (false) = Default value. Unblocked


1 (true) = Temporary blocked

Optional (0-1)

Indicate whether the subscriber and operator have access to subscriber and account data.

serviceClass

Sub-MO

Optional (0-1)

A list information of service class

 

serviceClassAction

String


Enumeration value="SET"


Enumeration value="SetOriginal"


Enumeration value="SetTemporary"


Enumeration value="DeleteTemporary"

Mandatory

Indicate which action to take when updating the service class.


Set = Update ordinary (original) and temporary Service classes


SetOriginal = Update ordinary (original) Service class


SetTemporary = Update temporary Service class


DeleteTemporary = Remove temporary Service class

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

 

serviceClassNew

Integer, 0 - 9999

Optional (0-1)

The new service class for the refill.

 

serviceClassTemporary

Integer, 0 - 9999

Optional (0-1)

The service class to be used by the subscriber.

 

serviceClassTemporaryExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of a temporary service class of an account.

 

serviceClassTemporaryNew

Integer, 0 - 9999

Optional (0-1)

The new temporary service class when changing an already assigned temporary service class.

 

serviceClassTemporaryNewExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

 
 

serviceClassValidationFlag

Boolean { 0, 1 }


0 (false) = Default value. Do not perform validation.


1 (true) = Perform validation.

Optional (0-1)

Indicate whether validation regarding if a service class update is made within the range of allowed service classes shall be performed or not.

 

externalData1

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

externalData2

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

chargingRequestInformation

Sub-MO

Optional (0-1)

This parameter contains request information for a charged end user communication event.

   

chargingType

Integer, 1 - 6


1 = Check order and make reservation


2 = Perform order and make deduction


3 = Perform order and commit reservation


4 = Rollback reservation


5 = Get allowed options


6 = Rate and check (reserved for future use)

Optional (0-1)

This parameter contains information how the request is to be charged and which mechanism to use.

   

chargingIndicator

Integer, 0 - 65535

Optional (0-1)

An indicator for rating differentiation.

   

reservationCorrelationID

Integer, 0 - 2147483647

Optional (0-1)

The id needed to correlate a reservation.

FaF

Sub-MO

Optional (0-n)

Information about family and friends function

 

fafNumber

tring, 1 - 30 digits

Optional (0-1)

A Family and Friends number

 

owner

String


Enumeration value="Subscriber"


Enumeration value="Account"

Optional (0-1)

Indicate whether the data is attached to the account or subscriber.

 

fafIndicator

Integer, 1 - 65535

Optional (0-1)

This parameter is used for differentiated rating for traffic events to and from numbers in the Family and Friends (FaF) number list.

 

exactMatch

Boolean { 0, 1 }


0 = Default value. Match faf number partially.


1 = Match faf number exactly.

Optional (0-1)

Indicate whether the faf number should be matched partial or exact.

 

selectedOption

Integer, 1 - 999

Optional (0-1)

The value of the selected option. The values are configurable by the operator.

 

chargingRequestInformation

Sub-MO

Optional (0-1)

This parameter contains request information for a charged end user communication event.

   

chargingType

Integer, 1 - 6


1 = Check order and make reservation


2 = Perform order and make deduction


3 = Perform order and commit reservation


4 = Rollback reservation


5 = Get allowed options


6 = Rate and check (reserved for future use)

Optional (0-1)

This parameter contains information how the request is to be charged and which mechanism to use.

   

chargingIndicator

Integer, 0 - 65535

Optional (0-1)

An indicator for rating differentiation.

   

reservationCorrelationID

Integer, 0 - 2147483647

Optional (0-1)

The id needed to correlate a reservation.

 

enableFafMNPFlag

Boolean { 0, 1 }


0 = No check of FaF number towards NPDB will be performed.


1 = Check of FaF number towards NPDB will be performed.

Optional (0-1)

This parameter is sent if the check of FaF number towards NPDB should be performed.

communityInformationCurrent

String

Optional (0-1)

The community the subscriber currently belongs to.

communityInformationNew

String

Optional (0-1)

The community which is to be assigned to the subscriber.

communityInformationUpdate

Sub-MO

Optional (0-1)

Contains the community which is to be added to the subscriber and the community which is to be deleted from the subscriber.

 

communityInformationAdd

String

Optional (0-1)

The community which is to be added to the subscriber.

 

communityInformationDelete

String

Optional (0-1)

The community which is to be deleted from the subscriber.

balanceAndDate

Sub-MO

Optional (0-1)

It is used to perform a balance enquiry on the account associated with a specific subscriber identity. Also lifecycle dates are presented. Information is given on both main and dedicated accounts.

 

messageCapabilityFlag

Sub-MO

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

   

promotionNotificationFlag

Boolean { 0, 1 }


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

   

firstIVRCallSetFlag

Boolean { 0, 1 }


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

   

accountActivationFlag

Boolean { 0, 1 }


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance is applied.

Optional (0-1)

Indicate whether pre-activated accounts can be or cannot be activated due to the request. The possibility to activate a pre-activated account by this flag is configured in the account databases service class configuration. This results in that even if the flag is set to true the account may not be activated.

 

transactionCurrency

String, currency

Optional (0-1)

The ID to point out what currency is used for the transaction.

 

adjustmentAmountRelative

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The amount of the adjustment (positive or negative) to be applied to the account.

 

dedicatedAccountUpdateInformation

Sub-MO

Optional (0-n)

Information for updating balances and expiry date for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

adjustmentAmountRelative

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 Unit

Optional (0-1)

The amount of the adjustment (positive or negative) to be applied to the account.

   

dedicatedAccountValueNew

String, 0 - 999 999 999 999 Unit

Optional (0-1)

Value to assign to a dedicated account. This is not taking in consideration any ongoing chargeable events.

   

adjustmentDateRelative

Integer, -32767 to -1 and 1 to 32767

Optional (0-1)

This parameter is used to make a relative adjustment to the current expiry date. The adjustment can be positive or negative. It is expressed in number of days.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

expiryPamPeriodIndicator

Integer, 1- 100 and 2147483647


2147483647 = no expiry.

Optional (0-1)

the Periodic Account Management period when the offer or DA becomes invalid. When the offer has the capability of storing date and time the time stamp will be set to 00:00:00 or 23:59:59 depending on system configuration.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime.

   

adjustmentStartDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date. The adjustment can be positive or negative. It is expressed in number of days.

   

startPamPeriodIndicator

Integer, 0 - 99

Optional (0-1)

The startPamPeriodIndicator parameter indicates the Periodic Account Management period when the offer and DA becomes valid. If the offer has the capability of date and time the time stamp will default to 00:00:00.


Update of the PAM period indicator on an existing offer will keep the current time stamp unchanged. Time stamp can however be changed by including currentTimeOffset.


Zero means that the start date of an offer or a DA is the current date.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

expiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current start date for a dedicated account. Used for validation. No validation is performed if omitted.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

updateAction

String


Enumeration value="EXPIRE"

Optional (0-1)

Indicate which action to take on the resource.


EXPIRE = Expire the resource immediately.

 

allowCropOfCompositeDedicatedAccounts

Boolean { 0, 1 }


0 (false) = Default value. Do not allow crop.


1 (true) = Allow crop.

Optional (0-1)

Indicate whether it shall be allowed to crop a composite dedicated account

 

supervisionExpiryDateRelative

Integer, -32767 to -1 and 1 to 32767

Optional (0-1)

Used to make a relative adjustment to the current supervision expiry date. The adjustment can be positive or negative. It is expressed in number of days.

 

supervisionExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the supervision period.

 

serviceFeeExpiryDateRelative

Integer, -32767 to -1 and 1 to 32767

Optional (0-1)

Used to make a relative adjustment to the current service fee expiry date. The adjustment can be positive or negative. It is expressed in number of days.

 

serviceFeeExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the service fee period.

 

creditClearancePeriod

Integer, 0 - 1023

Optional (0-1)

The period until credit clearance.

 

serviceRemovalPeriod

Integer, 0 - 1023

Optional (0-1)

The period until service removal.

 

transactionType

String, 1 - 30 characters

Optional (0-1)

Specify the operation in more detail. It associate a description of a certain operation along with transactionCode.

 

transactionCode

String, 1 - 30 characters

Optional (0-1)

Specify the operation in more detail. It associate a description of a certain operation along with transactionType.

 

externalData1

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

externalData2

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

serviceFeeExpiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current expiry date of the service fee period.

 

supervisionExpiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current expiry date of the supervision period.

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

 

cellIdentifier

String, 1 - 19


1 - 19 = Numeric


0 - 19 CAP = 14 CGI/SAI

Optional (0-1)

This parameter output the CellGlobal Identity (CGI) or Service Area Identity (SAI). It can be sent as an input parameter through UCIP. If not sent as parameter, this parameter is retrieved from the HLR using ATI request.


The cellIdentifier parameter can also be a return parameter through UCIP.

deleteDedicatedAccounts

Sub-MO

Optional (0-1)

The information about the dedicated account to be deleted.

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

 

dedicatedAccountIdentifier

Sub-MO

Mandatory

The identifier of the dedicated account to be deleted.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

promotionCounters

Sub-MO

Optional (0-1)

It returns the current accumulated values used as base for the calculation of when to give a promotion and when to progress a promotion plan.

 

transactionCurrency

String, currency

Optional (0-1)

The ID to point out what currency is used for the transaction.

 

promotionRefillAmountRelative

String, - 999 999 999 999 to 999 999 999 999

Optional (0-1)

Specifies an amount to be adjusted to the accumulated value of account refills made within the current promotion plan of a subscriber.

 

promotionRefillCounterStepRelative

String, -255 to 255

Optional (0-1)

Contains the number of steps to be adjusted to the accumulated number of account refills within the current promotion plan of a subscriber.

 

progressionRefillAmountRelative

String, - 999 999 999 999 to 999 999 999 999

Optional (0-1)

Specifies an amount to be adjusted to the accumulated value of account refill for promotion plan progression.

 

progressionRefillCounterStepRelative

String, -255 to 255

Optional (0-1)

Contains the number of steps to be adjusted on the accumulated number of account refills for promotion plan progression.

refillBarring

Sub-MO

Optional (0-1)

The information about the refill to be barred.

 

refillBarAction

String


Enumeration value="CLEAR"


Enumeration value="STEP"


Enumeration value="BAR"

Mandatory

Describes what action to apply to the refill bar counter.


Network Element Type:


CLEAR: Clear the counter


STEP: Increase counter by one


BAR: Immediate barring of refill

 

refillUnbarDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time when a refill barred subscriber is unbarred and is allowed to do a new refill.

subDedicatedAccount

Sub-MO

Optional (0-n)

The information about balances and dates for dedicated accounts.

 

transactionCurrency

String, currency

Optional (0-1)

The ID to point out what currency is used for the transaction.

 

subDedicatedAccountUpdateInformation

Sub-MO

Mandatory

The information for updating balances and expiry date for sub dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

subDedicatedAccountIdentifier

Sub-MO

Mandatory

The information for identifying a unique sub dedicated account.

     

startDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

The current start date for a dedicated account. Used for validation. No validation is performed if omitted.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

expiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

The current expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

adjustmentAmountRelative

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 Unit

Optional (0-1)

The amount of the adjustment (positive or negative) to be applied to the account.

   

subDedicatedAccountValueAbsolute

String, 0 - 9 223 372 036 854 775 807

Optional (0-1)

The units to assign to a sub dedicated account.

   

adjustmentDateRelative

Integer, -32767 to -1 and 1 to 32767

Optional (0-1)

This parameter is used to make a relative adjustment to the current expiry date. The adjustment can be positive or negative. It is expressed in number of days.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

expiryPamPeriodIndicator

Integer, 1- 100 and 2147483647


2147483647 = no expiry.

Optional (0-1)

the Periodic Account Management period when the offer or DA becomes invalid. When the offer has the capability of storing date and time the time stamp will be set to 00:00:00 or 23:59:59 depending on system configuration.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

adjustmentStartDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date. The adjustment can be positive or negative. It is expressed in number of days.

   

startPamPeriodIndicator

Integer, 0 - 99

Optional (0-1)

The Periodic Account Management period when the offer and DA becomes valid. If the offer has the capability of date and time the time stamp will default to 00:00:00.


Update of the PAM period indicator on an existing offer will keep the current time stamp unchanged. Time stamp can however be changed by including currentTimeOffset.


Zero means that the start date of an offer or a DA is the current date.

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

expiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current start date for a dedicated account. Used for validation. No validation is performed if omitted.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

 

transactionType

String, 1 - 30 characters

Optional (0-1)

Specify the operation in more detail. It associate a description of a certain operation along with transactionCode.

 

transactionCode

String, 1 - 30 characters

Optional (0-1)

Specify the operation in more detail. It associate a description of a certain operation along with transactionType.

 

externalData1

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

 

externalData2

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

usageThresholdsAndCounters

Sub-MO

Optional (0-1)

Information of active usage thresholds and usage counters for a subscriber.

 

transactionCurrency

String, currency

Optional (0-1)

The ID to point out what currency is used for the transaction.

 

updateUsageCounterForMultiUser

Integer, 1

Optional (0-1)

Indicates that the request should be performed for all subscribers in a multi user account or for the provider and all consumers.

 

usageCounterUpdateInformation

Sub-MO

Optional (0-n)

The updated information of the usage counter data

   

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

   

usageCounterValueNew

Integer, 0 - 9 223 372 036 854 775 807

Optional (0-1)

The updated value of a non-monetary usage counter.

   

adjustmentUsageCounterValueRelative

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 digits

Optional (0-1)

The adjustment value of a non-monetary usage counter.

   

usageCounterMonetaryValueNew

String, 0 - 999 999 999 999 price

Optional (0-1)

The updated value of a monetary usage counter.

   

adjustmentUsageCounterMonetaryValueRelative

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

Indicates the adjustment value of a monetary usage counter.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

usageThresholdUpdateInformation

Sub-MO

Optional (0-n)

The update information of the usage threshold.

   

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

   

usageThresholdValueNew

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The new value of a non-monetary usage threshold.

   

usageThresholdMonetaryValueNew

String, 0 - 999 999 999 999 price

Optional (0-1)

The updated value of a monetary usage threshold.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

4.2   Response Data

4.2.1   Parameters

MOId

Table 14    Set Subscription Parameter

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 15 covers the parameters that can be used in a setSubscription response.

Table 15    Set Subscription Parameter

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

accountFlagsAfter

Sub-MO

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account after.

 

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

 

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

 

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

 

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

 

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

 

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

accountFlagsBefore

Sub-MO

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account before.

 

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

 

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

 

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

 

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

 

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

 

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

accountPrepaidEmptyLimit1

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the first currency

accountPrepaidEmptyLimit2

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the second currency

chargingResultInformation

Sub-MO

Optional (0-1)

Information for a charged end user communication event.

 

Cost1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the first currency.

 

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

Cost 2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the second currency.

 

currency2

String,Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

chargingResultCode

Integer, 0 - 2


0 = or not present Successful


1 = No charge (free counter stepped)


2 = No charge (free counter not stepped)

Optional (0-1)

Information related to a charged event.

 

reservationCorrelationID

Integer, 0 - 2147483647

Optional (0-1)

The id needed to correlate a reservation.

 

chargingResultInformationService

   

Result information regarding a service for a charged end user communication event

   

cost1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the first currency.

   

cost2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the second currency.

periodicAccountManagementData

Sub-MO

Optional (0-n)

Information used for periodic account management.

 

pamServiceID

Integer, 0 - 99

Mandatory

The id of the periodic account management service.

 

pamClassID

Integer, 0 - 9999

Optional (0-1)

The periodic account management class used by the periodic account management service.

 

scheduleID

Integer, 0 - 9999

Optional (0-1)

The schedule that is used by the periodic account management service.

 

currentPamPeriod

String, 1 - 30 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Mandatory

The periodic account management period that is currently used for the subscriber.

 

deferredToDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The deferred to date for the Periodic Account Management service.

 

lastEvaluationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date of the last periodic account management evaluation.

 

pamServicePriority

Integer, 0 - 65535

Optional (0-1)

Indicate the priority between PAM services at PAM evaluation. Lower value gives higher priority.

allowedOptions

Integer, 1- 999


1 = Both incoming and outgoing direction allowed.


2 = Incoming direction allowed.


3 = Outgoing direction allowed.

Optional (0-8)

The value of an allowed option


The allowedOption can be repeated up to 8 times for UpdateFaFList Response.

fafMaxAllowedNumbersReachedFlag

Boolean, {0, 1}


0 (false) = Default value. Maximum number of allowed FaF numbers is not reached


1 (true) = Maximum number of allowed FaF numbers is reached.

Optional (0-1)

A flag indicating that it's not allowed to add more FaF numbers to the FaF-list for this subscriber.

fafChangeUnbarDate

DateTime.iso8601

Optional (0-1)

The date when a family and friends change is allowed again.


DateTomorrow to DateMax

negativeBalanceBarringDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when a subscriber is scheduled to be barred, or was barred, due to negative balance.


Element Value Range: DateMin to DateMax

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

 

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

 

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

 

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

 

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

 

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

 

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

 

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

 

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

 

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

 

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

 

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

   

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

   

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

   

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

   

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

   

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

   

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

   

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

 

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

accountValue1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the first currency.

accountValue2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the second currency.

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

 

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

 

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

 

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

 

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

 

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

 

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

 

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

 

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

   

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

   

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

   

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

   

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

   

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

 

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

 

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

 

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

 

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

 

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

promotionRefillAccumulatedValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the first currency.

promotionRefillAccumulatedValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the second currency.

promotionRefillCounter

Integer, 0 - 255

Optional (0-1)

The accumulated number of account refills within the current promotion plan of a subscriber.

progressionRefillValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the first currency.

progressionRefillValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the second currency.

progressionRefillCounter

Integer, 0 - 255

Optional (0-1)

The value of the accumulated number of refills for promotion plan progression.

refillUnbarDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time when a refill barred subscriber is unbarred and is allowed to do a new refill.

refillFraudCount

Integer, 0 - 255

Optional (0-1)

Contain the number of fraudulent refill attempts left, before the account becomes barred from refill.

dedicatedAccountDeleteInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

 

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

 

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

 

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

 

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

4.3   Examples

4.3.1   Example of Updating Account Details

This section gives an example of the setSubscription request and response message. This example shows how to update Account Details for a subscriber.

Request Example

Example 22   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8298219224044d389372c5850deeef8e</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getSubscription subscriberNumber="465273152000001">
               <air:allowedServiceClasses>
                  <air:serviceClassCurrent>100</air:serviceClassCurrent>
               </air:allowedServiceClasses>
<air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
            </air:getSubscription>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 23   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8298219224044d389372c5850deeef8e</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
<air:originTransactionID>14462116962525038412</air:originTransactionID>
               <air:allowedServiceClasses>
                  <air:serviceClassCurrent>111</air:serviceClassCurrent>
               </air:allowedServiceClasses>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
<air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

4.3.2   Example of Adding Promotion Plan

This section gives an example of the setSubscription request and response message. This example shows how to add Promotion Plan for a subscriber.

Request Example

Example 24   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8353a8293d454b4a98945e85eadb0ef2</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:promotionPlan promotionPlanID="3">
                  <air:promotionPlanID>3</air:promotionPlanID>
                  <air:promotionPlanIDCurrent>2</air:promotionPlanIDCurrent>
                  <air:promotionOldStartDate>2013-09-26T06:44:01+01:00
                   </air:promotionOldStartDate>
                  <air:promotionOldEndDate>2015-09-26T06:44:01+01:00
                   </air:promotionOldEndDate>
                  <air:promotionStartDate>2019-09-26T06:44:01+01:00
                  </air:promotionStartDate>
                  <air:promotionEndDate>2020-09-26T06:44:01+01:00
                  </air:promotionEndDate>
               </air:promotionPlan>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 25   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8353a8293d454b4a98945e85eadb0ef2</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010</air:subscriberNumber>
               <air:originTransactionID>14416985238478365358</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.3   Example of Setting Promotion Plan

This section gives an example of the setSubscription request and response message. This example shows how to set the Promotion Plan for a subscriber.

Request Example

Example 26   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8353a8293d454b4a98945e85eadb0ef2</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:promotionPlan promotionPlanID="2">
                  <air:promotionOldStartDate>
                     2013-09-26T06:44:01+01:00
                  </air:promotionOldStartDate>
                  <air:promotionOldEndDate>
                     2015-09-26T06:44:01+01:00
                  </air:promotionOldEndDate>
                  <air:promotionStartDate>
                     2014-09-26T06:44:01+01:00
                  </air:promotionStartDate>
                  <air:promotionEndDate>
                     2015-09-26T06:44:01+01:00
                  </air:promotionEndDate>
               </air:promotionPlan>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 27   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8353a8293d454b4a98945e85eadb0ef2</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010</air:subscriberNumber>
               <air:originTransactionID>14416999892341471075</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.4   Example of Deleting Promotion Plan

This section gives an example of the setSubscription request and response message. This example shows how to delete the Promotion Plan from a subscriber.

Request Example

Example 28   Set Subscription Request Message

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>8353a8293d454b4a98945e85eadb0ef2</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010024</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010024">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:promotionPlan promotionPlanID="2" xsi:nil="true"></air:promotionPlan>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 29   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8353a8293d454b4a98945e85eadb0ef2</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010024</air:subscriberNumber>
               <air:originTransactionID>14417862771269132072</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.5   Example of Adding Family and Friends Number List

This section gives an example of the setSubscription request and response message. This example shows how to add Family and Friends Number List for a subscriber.

Request Example

Example 30   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>ffc1b6d5068447b5b674d85602cc13b4</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:faf fafNumber="0703105000" owner="Account">
                  <air:fafNumber>0703105000</air:fafNumber>
                  <air:owner>Account</air:owner>
                  <air:fafIndicator>65535</air:fafIndicator>
               </air:faf>
               <air:faf fafNumber="0703105000" owner="Subscriber">
                  <air:fafNumber>0703105000</air:fafNumber>
                  <air:owner>Subscriber</air:owner>
                  <air:fafIndicator>65535</air:fafIndicator>
               </air:faf>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 31   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>ffc1b6d5068447b5b674d85602cc13b4</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14419583159563036520</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.6   Example of Setting Family and Friends Number List

This section gives an example of the setSubscription request and response message. This example shows how to set Family and Friends Number List for a subscriber.

Request Example

Example 32   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" >
   <soapenv:Header>
      <cai3:SessionId>ffc1b6d5068447b5b674d85602cc13b4</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>16100001001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="16100001001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>               
               <air:faf fafNumber="0703101003" owner="Subscriber">
                  <air:fafIndicator>1003</air:fafIndicator>
               </air:faf>              
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 33   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>ffc1b6d5068447b5b674d85602cc13b4</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>16100001001</air:subscriberNumber>
               <air:originTransactionID>14419583171941301003</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.7   Example of Deleting Family and Friends Number List

This section gives an example of the setSubscription request and response message. This example shows how to delete Family and Friends Number List from a subscriber.

Request Example

Example 34   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header>
      <cai3:SessionId>ffc1b6d5068447b5b674d85602cc13b4</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:faf fafNumber="0703105000" owner="Account" xsi:nil="true"/>
               <air:faf fafNumber="0703105000" owner="Subscriber" xsi:nil="true"/>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 35   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>ffc1b6d5068447b5b674d85602cc13b4</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14419583180022020087</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.8   Example of Updating Service Classes

This section gives an example of the setSubscription request an d response message. This example shows how to update Service Classes for a subscriber.

Request Example

Example 36   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>e77cc74b16374525ac89dff7fd3ca4c6</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010">
               <air:originNodeType>ADM</air:originNodeType>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:serviceClass>
                  <air:serviceClassAction>SetOriginal</air:serviceClassAction>
                  <air:serviceClassCurrent>111</air:serviceClassCurrent>
                  <air:serviceClassNew>112</air:serviceClassNew>
                  <air:serviceClassValidationFlag>0</air:serviceClassValidationFlag>
                  <air:externalData1>externaldata1</air:externalData1>
                  <air:externalData2>externaldata2</air:externalData2>
                  <air:chargingRequestInformation>
                     <air:chargingType>1</air:chargingType>
                     <air:chargingIndicator>1</air:chargingIndicator>
                     <air:reservationCorrelationID>2147483647</air:reservationCorrelationID>
                  </air:chargingRequestInformation>
               </air:serviceClass>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 37   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>e77cc74b16374525ac89dff7fd3ca4c6</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010</air:subscriberNumber>
               <air:originTransactionID>14400530413366575140</air:originTransactionID>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.9   Example of Updating Temporary Service Classes

This section gives an example of the setSubscription request and response message. This example shows how to update Temporary Service Classes for a subscriber.

Request Example

Example 38   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>e77cc74b16374525ac89dff7fd3ca4c6</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>14400530413366575140</air:originTransactionID>
               <air:originTimeStamp>2015-08-20T06:44:01+01:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:originOperatorID>operator</air:originOperatorID>
               <air:serviceClass>
                  <air:serviceClassAction>SetTemporary</air:serviceClassAction>
                  <air:serviceClassTemporary>113</air:serviceClassTemporary>
                  <air:serviceClassTemporaryExpiryDate>
                     2015-10-20T06:44:01+01:00
                  </air:serviceClassTemporaryExpiryDate>
                  <air:serviceClassTemporaryNew>114</air:serviceClassTemporaryNew>
                  <air:serviceClassTemporaryNewExpiryDate>
                     2015-10-20T06:44:01+01:00
                  </air:serviceClassTemporaryNewExpiryDate>
                  <air:serviceClassValidationFlag>0</air:serviceClassValidationFlag>
                  <air:externalData1>external1</air:externalData1>
                  <air:externalData2>external2</air:externalData2>
                  <air:chargingRequestInformation>
                     <air:chargingType>1</air:chargingType>
                     <air:chargingIndicator>1</air:chargingIndicator>
                     <air:reservationCorrelationID>2147483647</air:reservationCorrelationID>
                  </air:chargingRequestInformation>
               </air:serviceClass>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 39   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>e77cc74b16374525ac89dff7fd3ca4c6</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010</air:subscriberNumber>
               <air:originTransactionID>14400530413366575140</air:originTransactionID>
               <air:originOperatorID>operator</air:originOperatorID>
               <air:accountFlagsAfter>
                  <air:activationStatusFlag>0</air:activationStatusFlag>
                  <air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
                  <air:supervisionPeriodWarningActiveFlag>0</air:supervisionPeriodWarningActiveFlag>
                  <air:serviceFeePeriodWarningActiveFlag>0</air:serviceFeePeriodWarningActiveFlag>
                  <air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
                  <air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
               </air:accountFlagsAfter>
               <air:accountFlagsBefore>
                  <air:activationStatusFlag>0</air:activationStatusFlag>
                  <air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
                  <air:supervisionPeriodWarningActiveFlag>0</air:supervisionPeriodWarningActiveFlag>
                  <air:serviceFeePeriodWarningActiveFlag>0</air:serviceFeePeriodWarningActiveFlag>
                  <air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
                  <air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
               </air:accountFlagsBefore>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.10   Example of Updating Community List

This section gives an example of the setSubscription request and response message. This example shows how to update Community List for a subscriber.

Request Example 1

Example 40   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>f35c9c9541064704bdacf099e88fed10</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010">
               <air:communityInformationCurrent>2,1</air:communityInformationCurrent>
               <air:communityInformationNew>1,2,3</air:communityInformationNew>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example 1

Example 41   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>f35c9c9541064704bdacf099e88fed10</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010</air:subscriberNumber>
               <air:originTransactionID>14423792128496507931</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

Request Example 2

Example 42   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>f35c9c9541064704bdacf099e88fed10</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000010">
               <air:communityInformationCurrent>3,2,5</air:communityInformationCurrent>
               <air:communityInformationUpdate>              
                  <air:communityInformationAdd>15</air:communityInformationAdd>
                  <air:communityInformationDelete>2,3</air:communityInformationDelete>
               </air:communityInformationUpdate>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 43   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>f35c9c9541064704bdacf099e88fed10</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000010</air:subscriberNumber>
               <air:originTransactionID>14423847482453593884</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.11   Example of Updating Temporary Blocked

This section gives an example of the setSubscription request and response message. This example shows how to update Temporary Blocked for a subscriber.

Request Example

Example 44   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>b1d212056dfb458e95daf0f652817e26</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:temporaryBlockedFlag>1</air:temporaryBlockedFlag>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 45   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>b1d212056dfb458e95daf0f652817e26</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14417897176209634802</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.12   Example of Updating Subscriber Segment

This section gives an example of the setSubscription request and response message. This example shows how to update Subscriber Segment for a subscriber.

Request Example 1

Example 46   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>75738e5d12544f1f90417f5359229ffe</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:accountGroupID>11</air:accountGroupID>
               <air:serviceOfferings>
                  <air:serviceOfferingID>1</air:serviceOfferingID>
                  <air:serviceOfferingActiveFlag>1</air:serviceOfferingActiveFlag>
               </air:serviceOfferings>
               <air:serviceOfferings>
                  <air:serviceOfferingID>2</air:serviceOfferingID>
                  <air:serviceOfferingActiveFlag>1</air:serviceOfferingActiveFlag>
               </air:serviceOfferings>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example1

Example 47   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>75738e5d12544f1f90417f5359229ffe</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>1442389963776495208</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

Request Example 2

Example 48   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>75738e5d12544f1f90417f5359229ffe</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:accountGroupID>22</air:accountGroupID>
               <air:serviceOfferingsValue>
                  <air:serviceOfferingsValueAdd>8,16</air:serviceOfferingsValueAdd>
                  <air:serviceOfferingsValueDelete>2,8</air:serviceOfferingsValueDelete>
                  <air:serviceOfferingsValueCurrent>15</air:serviceOfferingsValueCurrent>
               </air:serviceOfferingsValue>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example 2

Example 49   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>75738e5d12544f1f90417f5359229ffe</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14423899734202446566</air:originTransactionID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.13   Example of Adding Periodic Account Management Data

This section gives an example of the setSubscription request and response message. This example shows how to add Periodic Account Management Data for a subscriber.

Request Example

Example 50   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>aec38f67bb85422cadf1256a73ccdbaa</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:originOperatorID>operator111</air:originOperatorID>
               <air:periodicAccountManagementData pamServiceID="11">
                  <air:pamServiceID>11</air:pamServiceID>
                  <air:pamClassID>21</air:pamClassID>
                  <air:scheduleID>21</air:scheduleID>
               </air:periodicAccountManagementData>
               <air:periodicAccountManagementData pamServiceID="99">
                  <air:pamServiceID>99</air:pamServiceID>
                  <air:pamClassID>99</air:pamClassID>
                  <air:scheduleID>222</air:scheduleID>
                  <air:currentPamPeriod>pid-2015-10-1/a/b/c</air:currentPamPeriod>
                  <air:deferredToDate>2015-10-08T12:00:00+00:00</air:deferredToDate>
                  <air:pamServicePriority>65535</air:pamServicePriority>
               </air:periodicAccountManagementData>              
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 51   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>aec38f67bb85422cadf1256a73ccdbaa</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14416947487057163409</air:originTransactionID>
               <air:originOperatorID>operator111</air:originOperatorID>
               <air:periodicAccountManagementData>
                  <air:pamServiceID>11</air:pamServiceID>
                  <air:currentPamPeriod>pid-21-20160907</air:currentPamPeriod>
               </air:periodicAccountManagementData>
               <air:periodicAccountManagementData>
                  <air:pamServiceID>99</air:pamServiceID>
                  <air:currentPamPeriod>pid-2015-10-1/a/b/c</air:currentPamPeriod>
               </air:periodicAccountManagementData>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.14   Example of Setting Periodic Account Management Data

This section gives an example of the setSubscription request and response message. This example shows how to set the Periodic Account Management Data for a subscriber.

Request Example

Example 52   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header>
      <cai3:SessionId>aec38f67bb85422cadf1256a73ccdbaa</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000002</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000002">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:periodicAccountManagementData pamServiceID="99">
                  <air:currentPamPeriod>pid-1003-1//x/y/z</air:currentPamPeriod>
                  <air:deferredToDate>2019-12-31T12:12:31-06:00</air:deferredToDate>
                  <air:pamServicePriority>99</air:pamServicePriority>
                  <air:pamServicePriorityCurrent>222</air:pamServicePriorityCurrent>
               </air:periodicAccountManagementData>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 53   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>aec38f67bb85422cadf1256a73ccdbaa</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000002</air:subscriberNumber>
               <air:originTransactionID>14416947501628497009</air:originTransactionID>
               <air:periodicAccountManagementData>
                  <air:pamServiceID>99</air:pamServiceID>
                  <air:currentPamPeriod>pid-1003-1//x/y/z</air:currentPamPeriod>
               </air:periodicAccountManagementData>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.15   Example of Deleting Periodic Account Management Data

This section gives an example of the setSubscription request and response message. This example shows how to delete Periodic Account Management Data for a subscriber.

Request Example

Example 54   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header>
      <cai3:SessionId>bd149057ac0941dfb77b53e198c6b3f0</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:originOperatorID>operator111</air:originOperatorID>
               <air:periodicAccountManagementData pamServiceID="11" xsi:nil="true"/>
               <air:periodicAccountManagementData pamServiceID="99" xsi:nil="true"/>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 55   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>bd149057ac0941dfb77b53e198c6b3f0</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14416947490109139963</air:originTransactionID>
               <air:originOperatorID>operator111</air:originOperatorID>
               <air:periodicAccountManagementData>
                  <air:pamServiceID>11</air:pamServiceID>
                  <air:pamClassID>21</air:pamClassID>
                  <air:scheduleID>21</air:scheduleID>
                  <air:currentPamPeriod>pid-21-20160907</air:currentPamPeriod>
                  <air:pamServicePriority>0</air:pamServicePriority>
               </air:periodicAccountManagementData>
               <air:periodicAccountManagementData>
                  <air:pamServiceID>99</air:pamServiceID>
                  <air:pamClassID>99</air:pamClassID>
                  <air:scheduleID>222</air:scheduleID>
                  <air:currentPamPeriod>pid-2015-10-1/a/b/c</air:currentPamPeriod>
                  <air:deferredToDate>2015-10-08T12:00:00+00:00</air:deferredToDate>
                  <air:pamServicePriority>65535</air:pamServicePriority>
               </air:periodicAccountManagementData>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.16   Example of Updating the Balance and Date Information

This section gives an example of the setSubscription request and response message. This example shows how to update Balance and Date Information for a subscriber.

Request Example

Example 56   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>b4255a3261484ba4989daf4dbecd4aa8</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:balanceAndDate>
                  <air:messageCapabilityFlag>
<air:promotionNotificationFlag>1</air:promotionNotificationFlag>
                     <air:firstIVRCallSetFlag>1</air:firstIVRCallSetFlag>
                     <air:accountActivationFlag>1</air:accountActivationFlag>
                  </air:messageCapabilityFlag>
                  <air:transactionCurrency>SEK</air:transactionCurrency>
                  <air:adjustmentAmountRelative>-1000</air:adjustmentAmountRelative>
<air:supervisionExpiryDateRelative>1</air:supervisionExpiryDateRelative>
<air:serviceFeeExpiryDateRelative>1</air:serviceFeeExpiryDateRelative>
                  <air:creditClearancePeriod>0</air:creditClearancePeriod>
                  <air:serviceRemovalPeriod>0</air:serviceRemovalPeriod>
                  <air:transactionType>SCC</air:transactionType>
                  <air:transactionCode>EUC</air:transactionCode>
                  <air:externalData1>exData1</air:externalData1>
                  <air:externalData2>exData2</air:externalData2>
               </air:balanceAndDate>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 57   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>b4255a3261484ba4989daf4dbecd4aa8</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
          <air:originTransactionID>14467063394586463924</air:originTransactionID>
               <air:accountFlagsAfter>
                  <air:activationStatusFlag>1</air:activationStatusFlag>
<air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
<air:supervisionPeriodWarningActiveFlag>0</air:supervisionPeriodWarningActiveFlag>
                  <air:serviceFeePeriodWarningActiveFlag>0</air:serviceFeePeriodWarningActiveFlag>
<air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
<air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
               </air:accountFlagsAfter>
               <air:accountFlagsBefore>
                  <air:activationStatusFlag>1</air:activationStatusFlag>
<air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
<air:supervisionPeriodWarningActiveFlag>0</air:supervisionPeriodWarningActiveFlag>
<air:serviceFeePeriodWarningActiveFlag>0</air:serviceFeePeriodWarningActiveFlag>
<air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
<air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
               </air:accountFlagsBefore>
               <air:currency1>SEK</air:currency1>
               <air:accountValue1>12000</air:accountValue1>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
<air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope> 

4.3.17   Example of Updating Usage Thresholds and Counters

This section gives an example of the setSubscription request and response message. This example shows how to update Usage Thresholds and Counters for a subscriber.

Request Example

Example 58   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>fdcda745c7bc42c4b2aff709c66b5879</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:usageThresholdsAndCounters>
                  <air:transactionCurrency>SEK</air:transactionCurrency>
                  <air:updateUsageCounterForMultiUser>1</air:updateUsageCounterForMultiUser>
                  <air:usageCounterUpdateInformation>
                     <air:usageCounterID>1</air:usageCounterID>
                     <air:usageCounterValueNew>0</air:usageCounterValueNew>
                     <air:associatedPartyID>001</air:associatedPartyID>
                     <air:productID>1</air:productID>
                  </air:usageCounterUpdateInformation>
                  <air:usageCounterUpdateInformation>
                     <air:usageCounterID>2</air:usageCounterID>
                     <air:adjustmentUsageCounterValueRelative>-100</air:adjustmentUsageCounterValueRelative>
                     <air:associatedPartyID>002</air:associatedPartyID>
                    </air:usageCounterUpdateInformation>
                  <air:usageCounterUpdateInformation>
                     <air:usageCounterID>3</air:usageCounterID>
                     <air:usageCounterMonetaryValueNew>0</air:usageCounterMonetaryValueNew>
                     <air:productID>2</air:productID>
                  </air:usageCounterUpdateInformation>
                  <air:usageCounterUpdateInformation>
                     <air:usageCounterID>4</air:usageCounterID>
                     <air:adjustmentUsageCounterMonetaryValueRelative>
                       -999999999999
                     </air:adjustmentUsageCounterMonetaryValueRelative>
                  </air:usageCounterUpdateInformation>                                                      
                  <air:usageThresholdUpdateInformation usageThresholdID="1">
                     <air:usageThresholdValueNew>0</air:usageThresholdValueNew>
                     <air:associatedPartyID>1</air:associatedPartyID>
                  </air:usageThresholdUpdateInformation>
                  <air:usageThresholdUpdateInformation usageThresholdID="2">
                     <air:usageThresholdMonetaryValueNew>0</air:usageThresholdMonetaryValueNew>
                  </air:usageThresholdUpdateInformation>
               </air:usageThresholdsAndCounters>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 59   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>fdcda745c7bc42c4b2aff709c66b5879</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14476335267953221512</air:originTransactionID>
               <air:currency1>SEK</air:currency1>
               <air:usageCounterUsageThresholdInformation>
                  <air:usageCounterID>1</air:usageCounterID>
                  <air:usageCounterValue>100</air:usageCounterValue>
                  <air:usageCounterNominalValue>0</air:usageCounterNominalValue>
                  <air:usageThresholdInformation>
                     <air:usageThresholdID>1</air:usageThresholdID>
                     <air:usageThresholdValue>0</air:usageThresholdValue>
                     <air:usageThresholdSource>1</air:usageThresholdSource>
                     <air:associatedPartyID>1</air:associatedPartyID>
                  </air:usageThresholdInformation>
                  <air:usageThresholdInformation>
                     <air:usageThresholdID>2</air:usageThresholdID>
                     <air:usageThresholdMonetaryValue1>0</air:usageThresholdMonetaryValue1>
                     <air:usageThresholdMonetaryValue2>999999999999</air:usageThresholdMonetaryValue2>
                     <air:usageThresholdSource>1</air:usageThresholdSource>
                  </air:usageThresholdInformation>
                  <air:associatedPartyID>001</air:associatedPartyID>
                  <air:productID>1</air:productID>
               </air:usageCounterUsageThresholdInformation>
               <air:usageCounterUsageThresholdInformation>
                  <air:usageCounterID>2</air:usageCounterID>
                  <air:usageCounterMonetaryValue1>0</air:usageCounterMonetaryValue1>
                  <air:usageCounterMonetaryNominalValue1>0</air:usageCounterMonetaryNominalValue1>
                  <air:usageCounterMonetaryValue2>999999999999</air:usageCounterMonetaryValue2>
                  <air:usageCounterMonetaryNominalValue2>999999999999</air:usageCounterMonetaryNominalValue2>
                  <air:usageThresholdInformation>
                     <air:usageThresholdID>3</air:usageThresholdID>
                     <air:usageThresholdMonetaryValue1>0</air:usageThresholdMonetaryValue1>
                     <air:usageThresholdSource>1</air:usageThresholdSource>
                  </air:usageThresholdInformation>
               </air:usageCounterUsageThresholdInformation>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.18   Example of Deleting a Usage Thresholds

This section gives an example of the setSubscription request and response message. This example shows how to delete a Usage Thresholds of a subscriber.

Request Example

Example 60   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>e8d576f2cfbe4c339db0e4bfc741df29</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:usageThresholdsAndCounters>
                  <air:transactionCurrency>SEK</air:transactionCurrency>
                  <air:updateUsageCounterForMultiUser>1</air:updateUsageCounterForMultiUser>
                    <air:usageThresholdUpdateInformation usageThresholdID="1" xsi:nil="true"/>
                  <air:usageThresholdUpdateInformation usageThresholdID="2" xsi:nil="true"/>                  
               </air:usageThresholdsAndCounters>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 61   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>e8d576f2cfbe4c339db0e4bfc741df29</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14476337020188483188</air:originTransactionID>
               <air:currency1>SEK</air:currency1>
               <air:usageThresholdInformation>
                  <air:usageThresholdID>1</air:usageThresholdID>
                  <air:usageThresholdMonetaryValue1>0</air:usageThresholdMonetaryValue1>
                  <air:usageThresholdSource>1</air:usageThresholdSource>
               </air:usageThresholdInformation>
               <air:usageThresholdInformation>
                  <air:usageThresholdID>2</air:usageThresholdID>
                  <air:usageThresholdValue>0</air:usageThresholdValue>
                  <air:usageThresholdSource>1</air:usageThresholdSource>
               </air:usageThresholdInformation>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.19   Example of Updating Promotion Counters

This section gives an example of the setSubscription request and response message. This example shows how to update Promotion Counters for a subscriber.

Request Example

Example 62   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>40550c9774f142a9ac0fdaf40c207b98</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000001">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:promotionCounters>
                  <air:transactionCurrency>SEK</air:transactionCurrency>
                  <air:promotionRefillAmountRelative>
                     999999999999
                  </air:promotionRefillAmountRelative>               
                  <air:progressionRefillAmountRelative>
                     999999999999
                  </air:progressionRefillAmountRelative>
               </air:promotionCounters>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 63   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>40550c9774f142a9ac0fdaf40c207b98</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14471328837187422743</air:originTransactionID>
               <air:originOperatorID>sdz</air:originOperatorID>
               <air:currency1>SEK</air:currency1>
               <air:promotionRefillAccumulatedValue1>
                  999999999999
               </air:promotionRefillAccumulatedValue1>
               <air:promotionRefillCounter>0</air:promotionRefillCounter>
               <air:progressionRefillValue1>999999999999</air:progressionRefillValue1>
               <air:progressionRefillCounter>0</air:progressionRefillCounter>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.20   Example of Updating Refill Barring

This section gives an example of the setSubscription request and response message. This example shows how to update Refill Barring for a subscriber.

Request Example

Example 64   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
	<soapenv:Header>
		<cai3:SessionId>e240d11d047a49aaa04e1d4959a8fd69</cai3:SessionId>
	</soapenv:Header>
	<soapenv:Body>
		<cai3:Set>
			<cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
			<cai3:MOId>
	<air:subscriberNumber>465273152000003</air:subscriberNumber>
			</cai3:MOId>
			<cai3:MOAttributes>
				<air:setSubscription subscriberNumber="465273152000003">
	<air:subscriberNumberNAI>1</air:subscriberNumberNAI>
					<air:refillBarring>
	<air:refillBarAction>BAR</air:refillBarAction>
						<air:refillUnbarDateTime>2016-11-20T06:44:01+01:00</air:refillUnbarDateTime>
					</air:refillBarring>
					<air:negotiatedCapabilities>0</air:negotiatedCapabilities>
				</air:setSubscription>
			</cai3:MOAttributes>
		</cai3:Set>
	</soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 65   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>e240d11d047a49aaa04e1d4959a8fd69</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000003</air:subscriberNumber>
               <air:originTransactionID>14478359630645647626</air:originTransactionID>
               <air:refillUnbarDateTime>2016-11-20T06:44:01+01:00</air:refillUnbarDateTime>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.21   Example of Updating the SubDedicate Account

This section gives an example of the setSubscription request and response message. This example shows how to update the SubDedicate Account for a subscriber.

Request Example

Example 66   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>238ea94132af49bea24dd2a9f97c00c2</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000002</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000002">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:subDedicatedAccount>
                  <air:transactionCurrency>SEK</air:transactionCurrency>
                  <air:subDedicatedAccountUpdateInformation>
                     <air:dedicatedAccountID>21</air:dedicatedAccountID>
                     <air:subDedicatedAccountIdentifier>
                        <air:startDateCurrent>2015-11-01T01:00:00+00:00</air:startDateCurrent>
                        <air:expiryDateCurrent>2015-12-20T01:00:00+00:00</air:expiryDateCurrent>
                     </air:subDedicatedAccountIdentifier>
<air:adjustmentAmountRelative>999</air:adjustmentAmountRelative>
<air:adjustmentDateRelative>1000</air:adjustmentDateRelative>
                     <air:startDate>2015-10-08T12:12:12+02:00</air:startDate>
                     <air:pamServiceID>99</air:pamServiceID>
                     <air:expiryDateCurrent>2015-12-20T12:00:00+00:00</air:expiryDateCurrent>
                     <air:startDateCurrent>2015-10-23T12:00:00+00:00</air:startDateCurrent>
                     <air:dedicatedAccountUnitType>1</air:dedicatedAccountUnitType>
                  </air:subDedicatedAccountUpdateInformation>
                  <air:transactionType>SCC</air:transactionType>
                  <air:transactionCode>EUC</air:transactionCode>
                  <air:externalData1>exData1</air:externalData1>
                  <air:externalData2>exData2</air:externalData2>
               </air:subDedicatedAccount>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 67   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>238ea94132af49bea24dd2a9f97c00c2</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000002</air:subscriberNumber>
               <air:originTransactionID>14471328837187422743</air:originTransactionID>
               <air:originOperatorID>sdz</air:originOperatorID>
               <air:currency1>SEK</air:currency1>
               <air:dedicatedAccountChangeInformation>
                  <air:dedicatedAccountID>21</air:dedicatedAccountID>
                  <air:productID>21</air:productID>
                  <air:dedicatedAccountValue1>21</air:dedicatedAccountValue1>
                  <air:dedicatedAccountValue2>22</air:dedicatedAccountValue2>
                  <air:expiryDate>2015-12-20T12:00:00+00:00</air:expiryDate>
                  <air:startDate>2015-10-08T12:12:12+02:00</air:startDate>
                  <air:pamServiceID>99</air:pamServiceID>
                  <air:offerID>99</air:offerID>
                  <air:closestExpiryDate>2015-10-08T12:12:12+02:00</air:closestExpiryDate>
                  <air:closestExpiryValue1>99</air:closestExpiryValue1>
                  <air:closestExpiryValue2>100</air:closestExpiryValue2>
                  <air:closestAccessibleDate>2015-11-01T01:00:00+00:00</air:closestAccessibleDate>
                  <air:closestAccessibleValue1>103</air:closestAccessibleValue1>
                  <air:closestAccessibleValue2>102</air:closestAccessibleValue2>
                  <air:dedicatedAccountActiveValue1>105</air:dedicatedAccountActiveValue1>
                  <air:dedicatedAccountActiveValue2>106</air:dedicatedAccountActiveValue2>
                  <air:subDedicatedAccountChangeInformation>
                     <air:changedAmount1>110</air:changedAmount1>
                     <air:changedAmount2>112</air:changedAmount2>
                     <air:dedicatedAccountValue1>21</air:dedicatedAccountValue1>
                     <air:dedicatedAccountValue2>22</air:dedicatedAccountValue2>
                     <air:changedExpiryDate>25</air:changedExpiryDate>
                     <air:newExpiryDate>2011-01-18T14:15:21+02:00</air:newExpiryDate>
                     <air:clearedExpiryDate>2015-11-01T01:00:00+00:00</air:clearedExpiryDate>
                     <air:changedStartDate>25</air:changedStartDate>
                     <air:newStartDate>2011-01-18T14:15:21+02:00</air:newStartDate>
                     <air:clearedStartDate>2015-11-01T01:00:00+00:00</air:clearedStartDate>
                  </air:subDedicatedAccountChangeInformation>
                  <air:dedicatedAccountUnitType>1</air:dedicatedAccountUnitType>
               </air:dedicatedAccountChangeInformation>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

4.3.22   Example of Deleting the Dedicate Account

This section gives an example of the setSubscription request and response message. This example shows how to update the Dedicate Account for a subscriber.

Request Example

Example 68   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>2c9389000c2c4af0b2a5977e41704954</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000002</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setSubscription subscriberNumber="465273152000002">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:deleteDedicatedAccounts>
                  <air:serviceClassCurrent>21</air:serviceClassCurrent>
                  <air:dedicatedAccountIdentifier>
                     <air:dedicatedAccountID>21</air:dedicatedAccountID>
                     <air:expiryDate>2015-12-20T01:00:00+00:00</air:expiryDate>
                     <air:productID>21</air:productID>
                  </air:dedicatedAccountIdentifier>
               </air:deleteDedicatedAccounts>
               <air:negotiatedCapabilities>64</air:negotiatedCapabilities>
            </air:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope> 

Response Example

Example 69   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>2c9389000c2c4af0b2a5977e41704954</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000002</air:subscriberNumber>
               <air:originTransactionID>14416947486266349809</air:originTransactionID>
               <air:originOperatorID>gzg</air:originOperatorID>
               <air:currency1>SEK</air:currency1>
               <air:dedicatedAccountDeleteInformation>
                  <air:dedicatedAccountID>21</air:dedicatedAccountID>
                  <air:productID>21</air:productID>
                  <air:dedicatedAccountValue1>211</air:dedicatedAccountValue1>
                  <air:dedicatedAccountValue2>212</air:dedicatedAccountValue2>
                  <air:expiryDate>2015-12-01T01:00:00+00:00</air:expiryDate>
                  <air:startDate>2015-11-01T01:00:00+00:00</air:startDate>
                  <air:pamServiceID>21</air:pamServiceID>
                  <air:offerID>213</air:offerID>
                  <air:subDedicatedAccountInformation>
                     <air:dedicatedAccountValue1>21</air:dedicatedAccountValue1>
                     <air:dedicatedAccountValue2>212</air:dedicatedAccountValue2>
                     <air:startDate>2015-11-01T01:00:00+00:00</air:startDate>
                     <air:expiryDate>2015-12-01T01:00:00+00:00</air:expiryDate>
                  </air:subDedicatedAccountInformation>
                  <air:dedicatedAccountUnitType>1</air:dedicatedAccountUnitType>
               </air:dedicatedAccountDeleteInformation>
               <air:negotiatedCapabilities>64</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setSubscriptionResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

5   Delete AIR Subscription

This section covers the AIR command deleteSubscription.

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AIR/

5.1   Request Data

5.1.1   Parameters

MOId

Table 16    Delete Subscription MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 17 covers the parameters that can be used in a deleteSubscription request.

Table 17    Delete Subscription Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate PGN node name, which the character "-" replaced by "" as the parameter to NEs

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time milliseconds plus seven ramdon digital numbers as the parameter to NEs.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

deleteReasonCode

Integer, 0 - 255

Optional (0-1)

This parameter allows the user to set a reason to why an account and/or subscriber is deleted.


Zero reserved for Service expired, as defined by the life cycle of the account

barring

Boolean, { 0,1 }


0 (false) = No barring


1 (true) = Barring (default)

Optional (0-1)

Indicate whether barring in HLR is to be performed prior to deletion.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

5.2   Response Data

5.2.1   Parameters

MOId

Table 18    Delete Subscription Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 19 covers the parameters that can be used in a deleteSubscription response.

Table 19    Delete Subscription Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

balanceCleared1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

This parameter contain amount cleared for the subscriber's main account when deleted.


It indicates that the balance is in the first currency.

balanceCleared2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

This parameter contain amount cleared for the subscriber's main account when deleted.


It indicates that the balance is in the first currency.

communityInformationCurrent

String

Optional (0-1)

The community the subscriber currently belongs to.

accountGroupID

Integer, 0 – 2147483647

Optional (0-1)

The Account Group identity for the account.


0 indicate clearing of account group (when set to 0 the account does not belong to any account group).

serviceOfferings

Sub-MO

Optional (0-n)

The values of the service offerings defined on an account. It has to be matched to the definitions of the tariff tree.

 

serviceOfferingID

Integer, 1 - 31

Mandatory

The identity of a current service offering defined on an account.

 

serviceOfferingActiveFlag

Boolean { 0, 1 }


0 (false) = The service offering is not active.


1 (true) = The service offering is active.

Mandatory

Whether a specific service offering pointed out by the serviceOfferingID parameter is active or not.

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

languageIDCurrent

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-1)

The preferred language of subscriber.

ussdEndOfCallNotificationID

Integer, 0 - 255


0–199 = As defined in the tariff trees


200–254 = Reserved


255 = No ID assigned (clears previously assigned ID)

Optional (0-1)

This parameter identifies which decision tree to use, when selecting the appropriate USSD text string for the End of Call Notification message to the subscriber.

serviceFeeExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the service fee period.

supervisionExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the supervision period.

creditClearancePeriod

Integer, 0 - 1023

Optional (0-1)

The period until credit clearance.

serviceRemovalPeriod

Integer, 0 - 1023

Optional (0-1)

The period until service removal.

refillUnbarDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time when a refill barred subscriber is unbarred and is allowed to do a new refill.

accountFlags

Sub-MO

Optional (0-1)

The life cycle state flags of the account, indicating the actual status of the account.

 

activationStatusFlag

Boolean { 0, 1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

 

negativeBarringStatusFlag

Boolean { 0, 1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

 

supervisionPeriodWarningActiveFlag

Boolean { 0, 1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

 

serviceFeePeriodWarningActiveFlag

Boolean { 0, 1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

 

supervisionPeriodExpiryFlag

Boolean { 0, 1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

 

serviceFeePeriodExpiryFlag

Boolean { 0, 1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate if the service fee period date has expired or not.

serviceClassOriginal

Integer, 0 - 9999

Optional (0-1)

The identity of the original service class when a temporary service class is active for an account.


In case serviceClassOriginal is returned then the serviceClassCurrent will contain the temporary service class currently active for the account. When a temporary service class is active and a Return Service Class ID is specified, the serviceClassOriginal parameter will contain the identity of the return service class instead of the original service class. The account will then return to the specified Return Service Class ID when the temporary service class expires.

serviceClassTemporaryExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

 

The expiry date of a temporary service class of an account.


A temporary service class has precedence before the normally assigned service class, as long as the temporary service class date expiry date is not passed.

activationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The activation date of an account. Subordinate subscribers will contain the activation date of the master account.


Element Value Range: DateMin to DateToday

promotionPlanID

String, 1 - 4

Optional (0-1)

The identity of one of the current promotion plans of a subscriber.

promotionStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Start date of the associated promotion plan.

promotionEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

End date of the associated promotion plan.

promotionRefillCounter

Integer, 0 - 255

Optional (0-1)

The accumulated number of account refills within the current promotion plan of a subscriber.

promotionRefillAccumulatedValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the first currency.

promotionRefillAccumulatedValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the second currency.

progressionRefillValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the first currency.

progressionRefillValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the second currency.

progressionRefillCounter

Integer, 0 - 255

Optional (0-1)

The value of the accumulated number of refills for promotion plan progression.

dedicatedAccountDeleteInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

 

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

 

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

 

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

expiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

 

offerID

Integer, 0 - 2147483647

Optional (0-1)

The identity of an offer.

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

 

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

 

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

 

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

   

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

   

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

   

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

   

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

   

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

   

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

     

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

     

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

     

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

     

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

     

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

     

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

     

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

     

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

     

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

     

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

     

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

 

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

This flag indicates that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts.

 

attributeInformation

Sub-MO

Mandatory

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

   

attributeName

String, 1 - 128 characters

Optional (0-1)

The name of the attribute.

   

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

attributeValueDecimal

Sub-MO

Optional (0-1)

Information about a decimal value.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

   

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

 

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

   

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

   

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

     

treeParameterName

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

     

treeParameterValueString

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

     

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

     

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals that are used.

       

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

     

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter.

     

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

       

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

       

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

       

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

       

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

       

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

       

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

       

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

     

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

       

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

       

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

     

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

     

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

accountHomeRegion

Integer, 0 - 999

Optional (0-1)

The home region for the account.


Zero means no home region set.

periodicAccountManagementData

Sub-MO

Optional (0-n)

Information used for periodic account management.

 

pamServiceID

Integer, 0 - 99

Mandatory

The id of the periodic account management service.

 

pamClassID

Integer, 0 - 9999

Mandatory

The periodic account management class used by the periodic account management service.

 

scheduleID

Integer, 0 - 9999

Mandatory

The schedule that is used by the periodic account management service.

 

currentPamPeriod

String, 1 - 30 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Mandatory

The periodic account management period that is currently used for the subscriber.

 

deferredToDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The deferred to date for the Periodic Account Management service.

 

lastEvaluationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date of the last periodic account management evaluation.

 

pamServicePriority

Integer, 0 - 65535

Optional (0-1)

Indicate the priority between PAM services at PAM evaluation. Lower value gives higher priority.

usageCounterDeleteInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

 

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

 

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

 

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

 

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage threshold amount in the second currency.

 

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

   

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

   

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

   

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

   

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

   

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

5.3   Examples

5.3.1   Example of Deleting a Master Subscriber

This section gives an example of the deleteSubscription request and response message. This example shows how to delete a Master Subscriber.

Request Example

Example 70   Delete Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>7b505785ba4945c6930c99988401d06f</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000005</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:deleteSubscription subscriberNumber="465273152000001">
            <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
            </air:deleteSubscription>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 71   Delete Subscription Response Message

message.
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>7b505785ba4945c6930c99988401d06f</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000005</air:subscriberNumber>
         </MOId>
         <MOAttributes>
            <air:deleteSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>1441178898568250340</air:originTransactionID>
               <air:originOperatorID>operator</air:originOperatorID>
               <air:currency1>SEK</air:currency1>
               <air:balanceCleared1>0</air:balanceCleared1>
               <air:accountGroupID>0</air:accountGroupID>
               <air:serviceClassCurrent>22</air:serviceClassCurrent>
               <air:languageIDCurrent>1</air:languageIDCurrent>
               <air:ussdEndOfCallNotificationID>255</air:ussdEndOfCallNotificationID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:deleteSubscriptionResponse>
         </MOAttributes>
      </DeleteResponse>
   </S:Body>
</S:Envelope>

5.3.2   Example of Deleting a Subordinate Subscriber

This section gives an example of the deleteSubscription request and response message. This example shows how to delete a Subordinate Subscriber.

Request Example

Example 72   Delete Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>7b505785ba4945c6930c99988401d06f</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000006</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:deleteSubscription subscriberNumber="465273152000006">
            <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
            </air:deleteSubscription>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 73   Delete Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>7b505785ba4945c6930c99988401d06f</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000006</air:subscriberNumber>
         </MOId>
         <MOAttributes>
            <air:deleteSubscriptionResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000006</air:subscriberNumber>
               <air:originTransactionID>1441178895393568592</air:originTransactionID>
               <air:originOperatorID>operator</air:originOperatorID>
               <air:languageIDCurrent>1</air:languageIDCurrent>
               <air:ussdEndOfCallNotificationID>255</air:ussdEndOfCallNotificationID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>536879616</air:availableServerCapabilities>
            </air:deleteSubscriptionResponse>
         </MOAttributes>
      </DeleteResponse>
   </S:Body>
</S:Envelope>

6   Get AIR Offer

This section covers the AIR subscriber command getOffer.

MOType

Offer@http://schemas.ericsson.com/ma/CS/AIR/

6.1   Request Data

6.1.1   Parameters

MOId

Table 20    Get Offer Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 21 covers the parameters that can be used in a getOffer request.

Table 21    Get Offer Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

offerSelection

Sub-MO

Optional (0-n)

Used to define offer identifiers to retrieve.

 

offerIDFirst

Integer, 1 - 2147483647

Mandatory

The identity of the first offer in a sequence of offers, or the only offer identity if a single offer shall be obtained.

 

offerIDLast

Integer, 1 - 2147483647

Optional (0-1)

The identity of the last offer in a sequence of offers, or the only offer identity if a single offer shall be obtained.

productSelection

Sub-MO

Optional (0-n)

Used to define product identifiers to retrieve for a given offer.

 

offerID

Integer, 1 - 2147483647

Mandatory

The identity of an offer.

 

productID

Integer, 0 - 2147483647

Optional

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

requestInactiveOffersFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not contain the inactive (or disabled) offers for the subscriber. Only active offers will be returned.


1 (true) = The response will contain all offers for the subscriber (including expired offers within their removal protection period).

Optional (0-1)

Indicate the state of the offers that should be included in a response.

offerRequestedTypeFlag

String, 8 digits


Example string: For '10xxxxxx' digit 1 is set and for '01xxxxxx' digit 2 is set.


Index 1: Account


0 = Do not return Account offers


1 = Return Account offers


Index 2: Multi User Identification


0 = Do not return Multi User Identification offers


1 = Return Multi User Identification offers


Index 3: Timer


0 = Do not return high resolution offers for Timer charging


1 = Return high resolution offers for Timer charging


Index 4: Provider Account


0 = Do not return Provider Account offers


1 = Return Provider Account offers


Index 4: Shared Account


0 = Do not return Shared Account offers


1 = Return Shared Account offers


Index 6-8: For future use

Optional (0-1)

The type or types of offers to return in a GetOffers request. If omitted, only Account offers are returned.

requestDedicatedAccountDetailsFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the dedicatedAccountInformation structs which are associated with the offer.


1 (true) = The response will include the dedicatedAccountInformation structs which are associated with the offer.

Optional (0-1)

Indicate the requested detail level of the content in the dedicatedAccountInformation.

requestSubDedicatedAccountDetailsFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the associated subDedicatedAccountInformation structs.


1 (true) = The response will include the associated subDedicatedAccountInformation structs.

Optional (0-1)

Indicate the requested detail level of the content in the dedicatedAccountInformation.

requestFirstAccessibleAndExpiredBalanceAndDateFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the associated closestExpiryDate, closestExpiryValue1, closestExpi ryValue2, closestAccessibleDate, closestAccessibleValue1,closestAcc essibleValue2.


1 (true) = The response will include the associated closestExpiryDate, closestExpiryValue1, closestExpi ryValue2, closestAccessibleDate, closestAccessibleValue1,closestAcc essibleValue2.

Optional (0-1)

Indicate the requested detail level of the content in the dedicatedAccountInformation.

requestUsageCountersAndThresholdsFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the associated offerInformation structs.


1 (true) = The response will include the associated offerInformation structs.

Optional (0-1)

Indicate the requested detail level of the content in the offerInformation.

requestTreeParameterSetsFlag

Boolean { 0, 1 }


0 (false) (default value): The response will not contain tree parameter sets.


1 (true): The response will contain tree parameter sets, if existing.

Optional (0-1)

Indicates if the tree parameter sets for all types of trees stored for the offer are to be included in a response.

productOfferingName

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

requestAttributesFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not contain attributes.


1 (true) The response will contain attributes, if existing.

Optional (0-1)

Indicate whether the attribute stored for the offer is to be included in a response.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same as the numbering format used by the account database, which also includes support of leading zeroes.

requestOfferResourcesFlag

Boolean { 0, 1 }


0 (false) (default value) = Do not return.


1 (true) = return

Optional (0-1)

The parameter is used to request whether offer resources (DAs and UCs with their UTs) for both non-product-private and product-private resources for an offer is to be returned or not.

6.2   Response Data

6.2.1   Parameters

MOId

Table 22    Get Offer Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 23 covers the parameters that can be used in a getOffer response.

Table 23    Get Offer Response

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

 

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

 

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

 

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

 

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

   

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

   

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

   

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

   

usageCounterMonetaryValue1

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryValue2

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

   

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

   

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

     

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

     

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

     

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

     

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

     

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

usageCounterResourceConnected

Boolean {1}


1 (true): The usage counter is a non-product-private connected resource

Optional (0-1)

Indicates if the usage counter is a non-product-private connected resource.

 

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Contain information of changes done to balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

     

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

     

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

     

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

     

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

     

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

     

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

dedicatedAccountResourceConnected

Boolean {1}


1 (true): The dedicated account is a non-product-private connected resource

Optional (0-1)

Indicates if the dedicated account is a non-product-private connected resource.

 

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Contain balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

Indicate that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts

   

dedicatedAccountResourceConnected

Boolean {1}


1 (true): The dedicated account is a non-product-private connected resource

Optional (0-1)

Indicates if the dedicated account is a non-product-private connected resource.

 

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

   

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

   

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

attributeValueDecimal

 

Optional (0-1)

Information about a decimal value.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

   

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contains the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

 

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

   

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

   

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

     

treeParameterName

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

     

treeParameterValueString

String, 1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

     

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

     

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals that are used.

       

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

     

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter.

     

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

       

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

       

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

       

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

       

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

       

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

       

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

       

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

     

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-n)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

treeParameterValueDateRange

 

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

       

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

       

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

     

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

     

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

negotiatedCapabilities

Interger: array of <int> or <i4>


0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node.


The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

 

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

 

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

 

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

 

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

   

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

   

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter contains information about where to put the decimal sign counted in positions from the right.

 

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

 

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

   

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

   

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

   

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

   

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

   

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

   

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

   

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

 

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

 

treeParameterValueDateRange

 

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

   

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

   

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

 

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

 

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

 

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

6.3   Examples

This section gives an example of the getOffer request and response message. This example shows how to get an AIR offer.

Request Example

Example 74   Get Offer Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>481651e281824a4681d7184320e75986</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Offer@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000009</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getOffer subscriberNumber="465273152000009">
               <air:offerSelection>
                  <air:offerIDFirst>101</air:offerIDFirst>
                  
                  <air:offerIDLast>103</air:offerIDLast>
               </air:offerSelection>
 		  </air:getOffer>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 75   Get Offer Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>481651e281824a4681d7184320e75986</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getOfferResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000009</air:subscriberNumber>
               <air:originTransactionID>14465353343564436411</air:originTransactionID>
               <air:offerInformation>
                  <air:offerID>101</air:offerID>
                  <air:startDate>2015-10-08T12:00:00+00:00</air:startDate>
                  <air:expiryDate>2017-10-08T12:00:00+00:00</air:expiryDate>
               </air:offerInformation>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:getOfferResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

7   Set AIR Offer

This section covers the command setOffer .

MOType

Offer@http://schemas.ericsson.com/ma/CS/AIR/

7.1   Request Data

7.1.1   Parameters

MOId

Table 24    Set Offer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

MOAttributes

Table 25 covers the parameters that can be used in a setOffer request.

Table 25    Set Offer Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time milliseconds plus seven ramdon digital numbers as the parameter to NEs.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

transactionCurrency

String, currency

Optional (0-1)

The ID to point out what currency is used for the transaction.


For example, SEK, EUR, USD, etc.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

offerRequestInformation

Sub-MO

Optional (0-1)

Information about an offer request

 

dateInformation

Sub-MO

Optional (0-1)

The date information of a request

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime.

   

startDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date. The adjustment can be positive or negative. It is expressed in number of days.

   

startPamPeriod

Sub-MO

Mandatory

The Periodic Account Management period

     

startPamPeriodIndicator

Integer, 0 - 99

Mandatory

The Periodic Account Management period when the offer and DA becomes valid. If the offer has the capability of date and time the time stamp will default to 00:00:00.


Update of the PAM period indicator on an existing offer will keep the current time stamp unchanged. Time stamp can however be changed by including currentTimeOffset.


Zero means that the start date of an offer or a DA is the current date.

     

currentTimeOffset

Boolean {0 ,1}


0 (false) = Time stamp will not be set (default value apply if applicable).


1 (true) = Time stamp will be set to current system time.

Optional (0-1)

Indicates whether the default time or current time should be used in time stamp.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

expiryDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to an expiry date. The adjustment can be positive or negative. It is expressed in number of days.

   

expiryPamPeriodIndicator

Integer, 1- 100 and 2147483647


2147483647 = no expiry.

Optional (0-1)

the Periodic Account Management period when the offer or DA becomes invalid. When the offer has the capability of storing date and time the time stamp will be set to 00:00:00 or 23:59:59 depending on system configuration.

 

dateTimeInformation

Sub-MO

Optional (0-1)

The date and time information

   

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

startDateTimeRelative

Integer, -99 999 999 to 99 999 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date and time for an offer. The adjustment can be positive or negative. It is expressed in number of seconds. The parameter may also be used to define start date and time for other entities depending on the context where it is used.

   

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Element Value Range: DateMin to DateMax or DateInfinite

   

expiryDateTimeRelative

Integer, -99 999 999 to 99 999 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current expiry date and time. The adjustment can be positive or negative. It is expressed in number of seconds. The parameter may also be used to define expiry date and time for other entities depending on the context where it is used.

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

 

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

 

dedicatedAccountUpdateInformation

Sub-MO

Optional (0-n)

Information for updating balances and expiry date for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountPamPeriodInformation

Sub-MO

Optional (0-1)

 
     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

adjustmentAmountRelative

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 Unit

Optional (0-1)

The amount of the adjustment (positive or negative) to be applied to the account.

     

dedicatedAccountValueNew

String, 0 - 999 999 999 999 Unit

Optional (0-1)

Value to assign to a dedicated account. This is not taking in consideration any ongoing chargeable events.

     

adjustmentDateRelative

Integer, -32767 to -1 and 1 to 32767

Optional (0-1)

This parameter is used to make a relative adjustment to the current expiry date. The adjustment can be positive or negative. It is expressed in number of days.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

expiryPamPeriodIndicator

Integer, 1- 100 and 2147483647


2147483647 = no expiry.

Optional (0-1)

the Periodic Account Management period when the offer or DA becomes invalid. When the offer has the capability of storing date and time the time stamp will be set to 00:00:00 or 23:59:59 depending on system configuration.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime.

     

adjustmentStartDateRelative

Integer, -999 to -1 and 1 to 999

Optional (0-1)

This parameter is used to make a relative adjustment to the current start date. The adjustment can be positive or negative. It is expressed in number of days.

     

startPamPeriodIndicator

Integer, 0 - 99

Optional (0-1)

The startPamPeriodIndicator parameter indicates the Periodic Account Management period when the offer and DA becomes valid. If the offer has the capability of date and time the time stamp will default to 00:00:00.


Update of the PAM period indicator on an existing offer will keep the current time stamp unchanged. Time stamp can however be changed by including currentTimeOffset.


Zero means that the start date of an offer or a DA is the current date.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

     

expiryDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDateCurrent

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The current start date for a dedicated account. Used for validation. No validation is performed if omitted.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

updateAction

String


Enumeration value="EXPIRE"

Optional (0-1)

Indicate which action to take on the resource.


EXPIRE = Expire the resource immediately.

 

attributeUpdateInformation

Sub-MO

Optional (0-n)

Update information of the attribute

   

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

   

attributeUpdateAction

String


Enumeration value="ADD"


Enumeration value="DELETE"


Enumeration value="CLEAR"


Enumeration value="SET"

Mandatory

The requested action for an attribute.


ADD : Add an entry to the set (for attributes storing a set of values).


DELETE : Delete an entry from the set (for attributes storing a set of values).


CLEAR :Clear all entries from the set (for attributes storing a set of values) or removes the value for a single value attribute.


SET :Sets the value for a single value attribute. Previous value, if existing, will be overwritten.

   

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

attributeValueDecimal

Sub-MO

Optional (0-1)

Information about a decimal value.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

updateAction

String


Enumeration value="EXPIRE"

Mandatory

Indicate which action to take on the resource.


EXPIRE = Expire the resource immediately.

treeParameterSetUpdateInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names.

 

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

 

treeParameterUpdateInformation

Sub-MO

Optional (0-n)

Contains information about the changes made to a treeParameter.

   

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Mandatory

Contains the name of the tree parameter.

   

treeParameterUpdateAction

String


Enumeration value="ADD"


Enumeration value="DELETE"


Enumeration value="CLEAR"


Enumeration value="SET"

Mandatory

Contains the requested action for a tree parameter.


ADD: Adds an entry to the set (for tree parameters storing a set of values).


DELETE: Deletes an entry from the set (for tree parameters storing a set of values).


CLEAR: Clears all entries from the set (for tree parameters storing a set of values) or removes the value for a single value tree parameter.


SET: Sets the value for a single value tree parameter. Previous value, if existing, will be overwritten.

   

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

   

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

   

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

   

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

     

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

     

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

   

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

   

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

     

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

     

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

     

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

     

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

     

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

     

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

     

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

7.2   Response Data

7.2.1   Parameters

MOId

Table 26    Set Offer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 27 covers the parameters that can be used in a setOffer response.

Table 27    Set Offer Response

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

 

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

 

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

 

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

 

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

 

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

 

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

 

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

 

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

 

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

 

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

 

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

   

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

   

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

   

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

   

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

   

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

   

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

   

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

 

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

 

dedicatedAccountResourceConnected

Boolean {1}


1 (true): The dedicated account is a non-product-private connected resource

Optional (0-1)

Indicates if the dedicated account is a non-product-private connected resource.

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

 

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

 

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

 

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

 

attributeValueDecimal

Sub-MO

Optional (0-1)

Information about a decimal value.

   

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

   

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

 

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

 

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

 

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

 

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

   

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

   

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

   

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

   

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

     

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter contains information about where to put the decimal sign counted in positions from the right.

   

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

   

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

     

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

     

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

     

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

     

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

     

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

     

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

     

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

   

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

     

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

     

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

   

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

   

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

productOfferingName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

7.3   Examples

This section gives an example of the setOffer request and response message. This example shows how to set an AIR offer.

Request Example

Example 76   Set Offer Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>5b96b03b62c9445fac3862d4632aabeb</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Offer@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
            <air:offerID>102</air:offerID>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setOffer subscriberNumber="465273152000001" offerID="102">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:transactionCurrency>SEK</air:transactionCurrency>
               <air:offerRequestInformation>
                  <air:offerProviderID>465273152000001</air:offerProviderID>
               </air:offerRequestInformation>
               <air:negotiatedCapabilities>64</air:negotiatedCapabilities>
            </air:setOffer>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 77   Set Offer Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>5b96b03b62c9445fac3862d4632aabeb</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setOfferResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>14430814093956082332</air:originTransactionID>
               <air:offerID>102</air:offerID>
               <air:startDateTime>2015-09-24T09:56:49+02:00</air:startDateTime>
               <air:offerType>3</air:offerType>
               <air:offerProviderID>465273152000001</air:offerProviderID>
               <air:negotiatedCapabilities>64</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setOfferResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

8   Delete AIR Offer

This section covers the AIR command deleteOffer.

MOType

Offer@http://schemas.ericsson.com/ma/CS/AIR/

8.1   Request Data

8.1.1   Parameters

MOId

Table 28    Delete Offer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

offerID

Integer, 1 - 2147483647

Mandatory

The identity of an offer.

MOAttributes

Table 29 covers the parameters that can be used in a deleteOffer request.

Table 29    Delete Offer Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in the originTransactionID parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time milliseconds plus seven ramdon digital numbers as the parameter to NEs.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

productID

Integer, 1 - 2147483647

Optional (0-1)

The identity of a product.

negotiatedCapabilities

Interger: array of <int> or <i4>


0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node. The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

8.2   Response Data

8.2.1   Parameters

MOId

Table 30    Delete Offer Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 31 covers the parameters that can be used in a deleteOffer response.

Table 31    Delete Offer Response

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

 

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

 

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

 

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

 

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

 

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

 

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

   

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

   

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

   

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

   

usageCounterMonetaryValue1

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

   

usageCounterMonetaryValue2

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

   

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

   

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

     

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

     

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

     

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

     

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

     

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

usageCounterResourceConnected

Boolean {1}


1 (true): The usage counter is a non-product-private connected resource

Optional (0-1)

Indicates if the usage counter is a non-product-private connected resource.

 

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Contain information of changes done to balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

     

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

     

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

     

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

     

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

     

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

     

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

dedicatedAccountResourceConnected

Boolean {1}


1 (true): The dedicated account is a non-product-private connected resource

Optional (0-1)

Indicates if the dedicated account is a non-product-private connected resource.

 

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Contain balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

Indicate that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts

   

dedicatedAccountResourceConnected

Boolean {1}


1 (true): The dedicated account is a non-product-private connected resource

Optional (0-1)

Indicates if the dedicated account is a non-product-private connected resource.

 

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

   

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

   

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

attributeValueDecimal

Sub-MO

Optional (0-n)

Information about a decimal value.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

   

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contains the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

 

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

   

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

   

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

     

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

     

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

     

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

     

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

       

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter contains information about where to put the decimal sign counted in positions from the right.

     

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

     

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

       

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

       

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

     

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

     

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

       

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

       

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

       

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

       

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

       

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

       

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

       

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

     

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

productOfferingName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

pamServiceID

Integer, 0 - 99

Optional (0-1)

The identity of the periodic account management service.

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

dedicatedAccountDeleteInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

 

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

 

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

 

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

 

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

 

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

 

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

 

pamServiceID

Integer, 0 - 99

Optional (0-1)

The identity of the periodic account management service.

 

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

 

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

 

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional

fafInformation

Sub-MO

Optional (0-n)

Information about family and friends function

 

fafNumber

String, 1 - 30 digits

Mandatory

A Family and Friends number

 

owner

String


Enumeration value="Subscriber"


Enumeration value="Account"

Mandatory

Indicate whether the data is attached to the account or subscriber.

 

fafIndicator

Integer, 1 - 65535

Optional (0-1)

This parameter is used for differentiated rating for traffic events to and from numbers in the Family and Friends (FaF) number list.

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

 

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

 

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

 

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

The date value of an attribute.


DateMin to DateMax or DateInfinite

 

attributeValueDecimal

Sub-MO

Mandatory

Information about a decimal value.

   

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

   

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

 

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

 

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contains the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

 

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

 

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

   

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

   

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

   

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

   

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

     

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter contains information about where to put the decimal sign counted in positions from the right.

   

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

   

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

     

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

     

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

     

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

     

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

     

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

     

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

     

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

   

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

     

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

     

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

   

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

   

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

productOfferingName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

8.3   Examples

This section gives an example of the deleteOffer request and response message. This example shows how to delete an AIR offer.

Request Example

Example 78   Delete Offer Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>5b96b03b62c9445fac3862d4632aabeb</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>Offer@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
            <air:offerID>102</air:offerID>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:deleteOffer subscriberNumber="465273152000001" offerID="102">
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:originOperatorID>operator1997</air:originOperatorID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:deleteOffer>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 79   Delete Offer Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>5b96b03b62c9445fac3862d4632aabeb</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000001
            </air:subscriberNumber>
            <air:offerID xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
             102</air:offerID>
         </MOId>
         <MOAttributes>
            <deleteOfferResponse:deleteOfferResponse 
xmlns="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:deleteOfferResponse="http://schemas.ericsson.com/ma/CS/AIR/">
               <subscriberNumber>465273152000001</subscriberNumber>
               <originTransactionID>14430815310782731534</originTransactionID>
               <originOperatorID>operator1997</originOperatorID>
               <offerID>102</offerID>
               <startDateTime>2015-09-24T09:56:49+02:00</startDateTime>
               <expiryDateTime>9999-12-31T12:00:00+00:00</expiryDateTime>
               <offerType>3</offerType>
               <offerProviderID>465273152000001</offerProviderID>
               <negotiatedCapabilities>0</negotiatedCapabilities>
               <availableServerCapabilities>805646916</availableServerCapabilities>
            </deleteOfferResponse:deleteOfferResponse>
         </MOAttributes>
      </DeleteResponse>
   </S:Body>
</S:Envelope>

9   Set AIR refill

This section covers the AIR command setRefill.

MOType

Refill@http://schemas.ericsson.com/ma/CS/AIR/

9.1   Request Data

9.1.1   Parameters

MOId

Table 32    Set Refill MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 33 covers the parameters that can be used in a setRefill request.

Table 33    Set Refill Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time milliseconds plus seven ramdon digital numbers as the parameter to NEs.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

externalData1

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

externalData2

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

externalData3

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

externalData4

String, 1 - 128

Optional (0-1)

A spare parameter for customizations to include in data records.

transactionType

String, 1 - 30 characters

Optional (0-1)

Specify the operation in more detail. It associate a description of a certain operation along with transactionCode.

transactionCode

String, 1 - 30 characters

Optional (0-1)

Specify the operation in more detail. It associate a description of a certain operation along with transactionType.

messageCapabilityFlag

Sub-MO

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

 

promotionNotificationFlag

Boolean { 0, 1 }


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

 

firstIVRCallSetFlag

Boolean { 0, 1 }


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

 

accountActivationFlag

Boolean { 0, 1 }


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance is applied.

Optional (0-1)

Indicate whether pre-activated accounts can be or cannot be activated due to the request. The possibility to activate a pre-activated account by this flag is configured in the account databases service class configuration. This results in that even if the flag is set to true the account may not be activated.

requestRefillAccountBeforeFlag

Boolean { 0, 1 }


0 (false) = Request account details before refill is not applied.


1 (true) = Request account details before refill is applied.

Optional (0-1)

The parameter contains the optional information that is requested.

requestRefillAccountAfterFlag

Boolean { 0, 1 }


0 (false) = Request account details after refill is not applied.


1 (true) = Request account details after refill is applied.

Optional (0-1)

The parameter contains optional information that is requested.

requestRefillDetailsFlag

Boolean { 0, 1 }


0 (false) = Request refill information is not applied.


1 (true) = Request refill information is applied.

Optional (0-1)

The parameter contains optional information that is requested.

requestSubDedicatedAccountDetailsFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not include the associated subDedicatedAccountInformation structs.


1 (true) = The response will include the associated subDedicatedAccountInformation structs.

Optional (0-1)

Indicate the requested detail level of the content in the dedicatedAccountInformation.

transactionAmount

String, 0 - 999 999 999 999

Optional (0-1)

The nominal value of the refill.

transactionCurrency

String, Currency

Optional (0-1)

The ID to point out what currency is used for the transaction.


For example, SEK, EUR, USD, etc.

refillProfileID

String, 1 - 4 characters

Optional (0-1)

The parameter contains a refill profile that is converted into a segmentation identity by the AIR server.

voucherActivationCode

String, 8 - 20 digits

Optional (0-1)

The activation number which is the unique secret code on the voucher which the subscriber uses when performing a voucher based refill of the account. The format includes support of leading zeroes.

selectedOption

Integer, 1- 999

Optional (0-1)

The value of the selected option. The values are configurable by the operator. The value is primarily used for Option Refill.

locationNumber

String, 1 - 20 digits

Optional (0-1)

The parameter contains the location of the subscriber. The default numbering format in the parameter is the same numbering format that is used for subscriber numbers in the Account Database. If another format is used, then it must be indicated by ‘‘Location Number NAI’’

locationNumberNAI

Integer, 0 -2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The locationNumberNAI (Nature of Address Indicator) parameter identifies the format of the ‘‘location Number’’.

refillType

Integer, 1-999


1 = Value Refill


2 = Account Refill


3 = Premium Refill


4~99 = Reserved for future use


100~999 = Operator defined

Optional (0-1)

The refillType parameter specifies the kind of refill, it is part of both the refill request and refill response.


The refillType parameter in a request specifies the wanted type of refill; this parameter can be validated or ignored depending of the configuration.

cellIdentifier

String, 1 - 19


1 - 19 = Numeric


10 - 19 CAP = 14 CGI/SAI

Optional (0-1)

The parameter output the CellGlobal Identity (CGI) or Service Area Identity (SAI). It can be sent as an input parameter through UCIP. If not sent as parameter, this parameter is retrieved from the HLR using ATI request.


The cellIdentifier parameter can also be a return parameter through UCIP.

validateSubscriberLocation

Boolean { 0, 1 }


0 (false) = Default value. Do not perform validation.


1 (true) = Perform validation

Optional (0-1)

Indicates whether a validation of the subscriber location should be performed or not.

treeDefinedField

Sub-MO

Optional (0-1)

 
 

treeDefinedFieldName

String, 1 - 15 characters

Mandatory

The defined name of the TDF.

 

treeDefinedFieldType

String

Mandatory

The treeDefinedFieldType parameter holds the defined type of the TDF.


Possible value are list as below:


Boolean


String


Long

 

treeDefinedFieldValue

String


Alphanumeric


Ranger: Depends on treeDefinedFieldType


Boolean "true", "false"


String Allowed characters: All

Mandatory

The treeDefinedFieldValue parameter contains the defined value of the TDF.

requestAttributesFlag

Boolean { 0, 1 }


0 (false) = Default value. The response will not contain attributes.


1 (true) The response will contain attributes, if existing.

Optional (0-1)

Indicate whether the attribute stored for the offer is to be included in a response.

negotiatedCapabilities

Interger: array of <int> or <i4>


0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node. The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active..

9.2   Response Data

9.2.1   Parameters

MOAttributes

The following tables cover the parameters that can be used in a setRefill response.

Table 34    Set Refill Parameters (Part I)

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

masterAccountNumber

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the master subscriber in a multi user account. The format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeros.

languageIDCurrent

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Optional (0-1)

The preferred language of the subscriber.

promotionAnnouncementCode

Integer, 0 - 99

Optional (0-1)

The promotional code for the announcement to be played.

voucherAgent

String, 1 - 8 characters

Optional (0-1)

The dealer who received the vouchers from the service provider (as defined when creating the vouchers).

voucherSerialNumber

String, 8 - 20 digits

Optional (0-1)

The vouchers serial number. Mandatory for voucher based refill and not needed for voucherless refill.

voucherGroup

String, 1 - 4 characters

Optional (0-1)

The unique identity of the card group that is associated to the voucher.

transactionCurrency

String, Currency

Optional (0-1)

The ID to point out what currency is used for the transaction.


For example, SEK, EUR, USD, etc.

transactionAmount

String, 0 - 999 999 999 999

Optional (0-1)

The nominal value of the refill. A transaction parameter includes data regarding a requested change.

transactionAmountConverted

String, 0 - 999 999 999 999

Optional (0-1)

The ‘Transaction Amount Refill’ that has been converted into the currency of the account.

currency1

String, Currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

currency2

String, Currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

refillInformation

Sub-MO

Optional (0-1)

Contain information the refillvalue Total and Promotion.

 

refillValueTotal

Sub-MO

Mandatory

The total values applied to account (including market segmentation and promotion). It contains the resulting values that will be applied to the account, both for the added amounts and dates.

   

refillAmount1

Sting, 0 - 9 223 372 036 854 775 807

Mandatory

Refill value towards the main account in the first currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

   

refillAmount2

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the second currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

   

supervisionDaysExtended

Integer, 0 - 2147483647

Optional (0-1)

Number of days the supervision period has been extended as a result of the refill. The part is given in number of days.

   

serviceFeeDaysExtended

Integer, 0 - 2147483647

Optional (0-1)

Number of days the service fee period has been extended as a result of the refill. The part is given in number of days.

   

dedicatedAccountRefillInformation

Sub-MO

Optional (0-n)

The Refill information of dedicated Account.

     

dedicatedAccountID

Integer, 0 - 2147483647

Optional (0-1)

Identity of the dedicated account in order to be able to distinguish between the various dedicated accounts.

     

refillAmount1

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the first currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

     

refillAmount2

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the second currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

     

expiryDateExtended

Integer, 0 - 65535


0 = Expiry date has been changed to no expiry date.


1 - 65535 = Expiry date has been extended.

Optional (0-1)

The expiry date for a dedicated account has been extended. The part is given in number of days.

     

clearedValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the first currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

     

clearedValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the second currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

subDedicatedAccountRefillInformation

Sub-MO

Optional (0-1)

The refill information of sub dedicated account.

       

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

       

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

       

refillAmount1

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the first currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

       

refillAmount2

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the second currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

       

clearedValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the first currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

       

clearedValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the second currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional

   

usageAccumulatorInformation

Sub-MO

Optional (0-n)

Information of usage accumulator.

     

accumulatorID

Integer, 1 - 2147483647

Optional (0-1)

The identity of accumulator.

     

accumulatorValue

Integer, -2147483648 to 2147483647

Optional (0-1)

The value of accumulator.

 

refillValuePromotion

Sub-MO

Optional (0-1)

The resulting promotion values that is applied to the account (including market segmentation and promotion). It contains the resulting values that will be applied to the account, both for the added amounts and dates.

   

refillAmount1

Sting, 0 - 9 223 372 036 854 775 807

Mandatory

Refill value towards the main account in the first currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

   

refillAmount2

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the second currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

   

supervisionDaysExtended

Integer, 0 - 2147483647

Optional (0-1)

Number of days the supervision period has been extended as a result of the refill. The part is given in number of days.

   

serviceFeeDaysExtended

Integer, 0 - 2147483647

Optional (0-1)

Number of days the service fee period has been extended as a result of the refill. The part is given in number of days.

   

dedicatedAccountRefillInformation

Sub-MO

Optional (0-n)

The Refill information of dedicated Account.

     

dedicatedAccountID

Integer, 1 - 2147483647

Optional (0-1)

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts.

     

refillAmount1

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the first currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

     

refillAmount2

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the second currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

     

expiryDateExtended

Integer, 0 - 65535


0 = Expiry date has been changed to no expiry date.


1 - 65535 = Expiry date has been extended.

Optional (0-1)

The expiry date for a dedicated account has been extended. The part is given in number of days.

     

clearedValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the first currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

     

clearedValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the second currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

subDedicatedAccountRefillInformation

Sub-MO

Optional (0-1)

The refill information of sub dedicated account.

       

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

       

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

       

refillAmount1

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the first currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

       

refillAmount2

Sting, 0 - 9 223 372 036 854 775 807

Optional (0-1)

Refill value towards the main account in the second currency.


If the unit type is other than money the refillAmount1 contains the amount of the valid units and refillAmount2 is omitted.

       

clearedValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the first currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

       

clearedValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807

Optional (0-1)

The units cleared for the dedicated account of subscriber when the dedicated account is removed. For example, a dedicated account might be removed at a service class change, or when the account is deleted.


It indicates that the units cleared is in the second currency to be announced


If the unit type is other than money the clearedValue1 contains the amount of the valid units and clearedValue2 is omitted.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4= The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

usageAccumulatorInformation

Sub-MO

Optional (0-n)

Information of usage accumulator.

     

accumulatorID

Integer, 1 - 2147483647

Optional (0-1)

The identity of accumulator.

     

accumulatorValue

Integer, -2147483648 to 2147483647

Optional (0-1)

The value of accumulator.

   

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

   

serviceClassTemporaryExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of a temporary service class of an account. A temporary service class has precedence before the normally assigned service class, as long as the temporary service class date expiry date is not passed.

   

promotionPlanProgressed

Boolean { 0, 1 }


0 (false) = Default value. No progress


1 (true) = Progression of promotion

Optional (0-1)

Indicate whether the result of the refill was a progression of promotion plan.

   

supervisionDaysSurplus

Integer, 0 - 2147483647

Optional (0-1)

The number of days that was not possible to add (including any promotional part) as the date has exceed the maximum period allowed. The accounts actual supervision date will be set equal to the maximum allowed date.

   

serviceFeeDaysSurplus

Integer, 0 - 2147483647

Optional (0-1)

The number of days that was not possible to add (including any promotional part) as the date has exceed the maximum period allowed. The accounts actual supervision date will be set equal to the maximum allowed date.

   

promotionRefillAccumulatedValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the first currency.

   

promotionRefillAccumulatedValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of account refills made within the current promotion plan of a subscriber.


It indicates the value in the second currency.

   

promotionRefillCounter

Integer, 0 - 255

Optional (0-1)

The accumulated number of account refills within the current promotion plan of a subscriber.

   

progressionRefillValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the first currency.

   

progressionRefillValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The accumulated value of refills for promotion plan progression.


It indicates the value in the second currency.

   

progressionRefillCounter

Integer, 0 - 255

Optional (0-1)

The value of the accumulated number of refills for promotion plan progression.

Table 35    Set Refill Parameters (Part II)

Parameter

Type

Occurrence

Description

accountBeforeRefill

Sub-MO

Optional (0-1)

The financial and lifecycle data of the account before the refill is applied.

 

serviceClassTemporaryExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of a temporary service class of an account. A temporary service class has precedence before the normally assigned service class, as long as the temporary service class date expiry date is not passed.

 

serviceClassOriginal

Integer, 0 - 9999

Optional (0-1)

The identity of the original service class when a temporary service class is active for an account.


In case serviceClassOriginal is returned then the serviceClassCurrent will contain the temporary service class currently active for the account. When a temporary service class is active and a Return Service Class ID is specified, the serviceClassOriginal parameter will contain the identity of the return service class instead of the original service class. The account will then return to the specified Return Service Class ID when the temporary service class expires.

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber. This might be a temporary Service Class, which is controlled by a temporary Service Class expiry date (separate parameter).

 

accountFlags

Sub-MO

Optional (0-1)

The life cycle state flags of the account, indicating the actual status of the account.

   

activationStatusFlag

Boolean { 0, 1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0, 1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean { 0, 1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean { 0, 1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean { 0, 1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean { 0, 1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate if the service fee period date has expired or not.

 

promotionPlanID

String, 1 - 4 characters

Optional (0-1)

The identity of one of the current promotion plans of a subscriber.

 

serviceFeeExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the service fee period.

 

supervisionExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of the supervision period.

 

creditClearanceDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the credit clearance period will expire.

 

serviceRemovalDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the account will be removed after the service removal period has expired.

 

accountValue1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the first currency.

 

accountValue2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the second currency.

 

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 Unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 Unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The identity of the periodic account management service.

   

offerID

Integer, 0 - 2147483647

Optional (0-1)

The identity of an offer.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


Value Range: DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


Value Range: DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Value Range: DateMin to DateMax or DateInfinite

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4= The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

This flag indicates that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts.

 

usageAccumulatorInformation

Sub-MO

Optional (0-n)

Information of usage accumulator.

   

accumulatorID

Integer, 1 - 2147483647

Optional (0-1)

The identity of accumulator.

   

accumulatorValue

Integer, -2147483648 to 2147483647

Optional (0-1)

The value of accumulator.

 

serviceOfferings

Sub-MO

Optional (0-n)

The values of the service offerings defined on an account. It has to be matched to the definitions of the tariff tree.

   

serviceOfferingID

Integer, 1 - 31

Mandatory

The identity of a current service offering defined on an account.

   

serviceOfferingActiveFlag

Boolean { 0, 1 }


0 (false) = The service offering is not active.


1 (true) = The service offering is active.

Mandatory

Whether a specific service offering pointed out by the serviceOfferingID parameter is active or not.

 

communityID

String

Mandatory (1-n)

The identity of the community the subscriber belong to.

 

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

   

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

   

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

   

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

   

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

     

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

     

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

     

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

     

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

     

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

     

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

       

usageThresholdID

Integer, 1 - 2147483647

Mandatory

The ID of a usage threshold.

       

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

       

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

       

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

       

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

       

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

       

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

       

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

       

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

       

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

       

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

     

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

Indicate that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts

   

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

     

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

     

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

     

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

     

attributeValueDecimal

Sub-MO

Optional (0-1)

Information about a decimal value.

       

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

     

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

     

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contains the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

   

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

     

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

     

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

       

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

       

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

       

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

       

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

         

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

         

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter contains information about where to put the decimal sign counted in positions from the right.

       

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

       

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

         

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

         

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

         

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

         

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

         

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

         

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

         

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

         

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

       

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

         

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

         

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

       

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

       

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productOfferingName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

Table 36    Set Refill Parameters (Part III)

Parameter

Type

Occurrence

Description

accountAfterRefill

Sub-MO

Optional (0-1)

Contain financial and lifecycle data that affected during a refill.

 

serviceClassTemporaryExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date of a temporary service class of an account. A temporary service class has precedence before the normally assigned service class, as long as the temporary service class date expiry date is not passed.

 

serviceClassOriginal

Integer, 0 - 9999

Optional (0-1)

The identity of the original service class when a temporary service class is active for an account.


In case serviceClassOriginal is returned then the serviceClassCurrent will contain the temporary service class currently active for the account. When a temporary service class is active and a Return Service Class ID is specified, the serviceClassOriginal parameter will contain the identity of the return service class instead of the original service class. The account will then return to the specified Return Service Class ID when the temporary service class expires.

 

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

 

accountFlags

Sub-MO

Optional (0-1)

The life cycle state flags of the account, indicating the actual status of the account.

   

activationStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

   

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

   

supervisionPeriodWarningActiveFlag

Boolean { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

   

serviceFeePeriodWarningActiveFlag

Boolean { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

   

supervisionPeriodExpiryFlag

Boolean { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

   

serviceFeePeriodExpiryFlag

Boolean { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

 

promotionPlanID

String, 1 - 4 characters

Optional (0-1)

The identity of one of the current promotion plans of a subscriber.

 

serviceFeeExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Expiry date of the service fee period.

 

supervisionExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Expiry date of the supervision period.

 

creditClearanceDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the credit clearance period will expire.

 

serviceRemovalDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date when the account will be removed after the service removal period has expired.

 

accountValue1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the first currency.

 

accountValue2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The account value for the master account of subscriber. This is not taking in consideration any ongoing chargeable events.


It indicates an account value in the second currency.

 

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

   

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

   

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

   

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

   

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

   

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

   

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

   

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

   

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

This flag indicates that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts.

 

usageAccumulatorInformation

Sub-MO

Optional (0-n)

Information of usage accumulator.

   

accumulatorID

Integer, 1 - 2147483647

Optional (0-1)

The identity of accumulator.

   

accumulatorValue

Integer, -2147483648 to 2147483647

Optional (0-1)

The value of accumulator.

 

serviceOfferings

Sub-MO

Optional (0-n)

The values of the service offerings defined on an account. It has to be matched to the definitions of the tariff tree.

   

serviceOfferingID

Integer, 1 - 31

Mandatory

The identity of a current service offering defined on an account.

   

serviceOfferingActiveFlag

Boolean { 0, 1 }


0 (false) = The service offering is not active.


1 (true) = The service offering is active.

Mandatory

Whether a specific service offering pointed out by the serviceOfferingID parameter is active or not.

 

communityID

Integer, 1- 9 999 999

Mandatory (1-n)

The identity of the community the subscriber belong to.

 

offerInformation

Sub-MO

Optional (0-n)

Dates (or dates and time) for offers.

   

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

   

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account,


Value Range: DateMin to DateMax or DateInfinite

   

startDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The start date and time for an offer.


Value Range: DateMin to DateMax or DateBeginningOfTime

   

expiryDateTime

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date and time.


Value Range: DateMin to DateMax or DateInfinite

   

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

   

offerType

Integer, 0 - 7

Optional (0-1)

The identifies the offer type.

   

offerState

Integer, 0 - 99


0 = Enabled offer state


1 = Disabled offer state


2-99 = Reserved for future use

Optional (0-1)

Specifies the actual offer state to return in a GetOfferrequest.

   

offerProviderID

String, 1 - 28 digits

Optional (0-1)

The subscriber number as represented in the SDP database for the provider.

   

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

usageCounterUsageThresholdInformation

Sub-MO

Optional (0-n)

All active usage counters with their thresholds for a subscriber.

     

usageCounterID

Integer, 1 - 2147483647

Mandatory

The id of a usage counter.

     

usageCounterValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter.

     

usageCounterNominalValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage counter, without any factor.

     

usageCounterMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryNominalValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the first currency.

     

usageCounterMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter.


It indicates a usage counter amount in the second currency.

     

usageCounterMonetaryNominalValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage counter, without any factor.


It indicates a usage counter amount in the second currency.

     

usageThresholdInformation

Sub-MO

Optional (0-n)

All information about a usage threshold. Depending on the usage counted the threshold value is represented either in the usageThresholdValue parameter or the usage ThresholdMonetaryValue1 or usageThresholdMonetaryValue2 parameter. The usageThresholdSource parameter can not be updated but is included in responses.

       

usageThresholdID

Integer, 1 - 2147483647

Optional (0-1)

The ID of a usage threshold.

       

usageThresholdValue

String, 0 - 9 223 372 036 854 775 807 digits

Optional (0-1)

The value of a non-monetary usage threshold.

       

usageThresholdMonetaryValue1

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the first currency.

       

usageThresholdMonetaryValue2

String, 0 - 999 999 999 999 price

Optional (0-1)

The value of a monetary usage threshold.


It indicates a usage threshold amount in the second currency.

       

usageThresholdSource

Integer, 1 - 3


1 = Personal - The threshold has been changed to a value other than the usage counter definition and is fetched from the subscriber.


2 = Common - The threshold has been changed to an individual value for a provider shared by all consumers.


3 = Default - The threshold value fetched from the usage counter definition.

Optional (0-1)

The source of a usage threshold.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

   

dedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information of changes done to balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

subDedicatedAccountChangeInformation

Sub-MO

Optional (0-n)

Information about the changes made to a sub dedicated account.

       

changedAmount1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the first currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

changedAmount2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The parameter defines changed values on a main or dedicated account.


It indicates a changed amount in the second currency.


If the unit type is other than money the changedAmount1 contains the amount of the valid units and changedAmount2 is omitted.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the first currency.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.


It indicates the balance in the second currency.

       

changedExpiryDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the expiry date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new expiry date for a dedicated account.

       

clearedExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous expiry date for a cleared dedicated account.


DateMin to DateMax or DateInfinite

       

changedStartDate

Integer, -65535 to 65535

Optional (0-1)

The number of days the start date for a dedicated account has been changed as a result of the operation. The value is given in number of days.

       

newStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The new start date for a dedicated account.


DateMin to DateMax or DateBeginningOfTime

       

clearedStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The previous start date for a cleared dedicated account.


DateMin to DateMax or DateBeginningOfTime

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

   

dedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for dedicated accounts.

     

dedicatedAccountID

Integer, 1 - 2147483647

Mandatory

The identity of the dedicated account in order to be able to distinguish between the various dedicated accounts in an array of dedicated accounts.

     

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

     

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

     

pamServiceID

Integer, 0 - 99

Optional (0-1)

The id of the periodic account management service.

     

offerID

Integer, 1 - 2147483647

Optional (0-1)

The identity of an offer.

     

productID

Integer, 0 - 2147483647

Optional (0-1)

The identity of a product.


Zero can only be received in a response where it indicates that a personal usage threshold value exists for the usage counter and there may exist zero or more additional product local usage counters which have not been used yet.

     

closestExpiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will expire, this include both active and inactive sub dedicated accounts.


DateToday to DateMax

     

closestExpiryValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the first currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestExpiryValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest expiry date, this include both active and in active sub dedicated accounts.


It indicates the balance of the second currency.


If the unit type is other than money the closestExpiryValue1 contains the amount of the valid units and closestExpiryValue2 is omitted.

     

closestAccessibleDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when the next sub dedicated account(s) will be accessible. This parameter is only valid for composite dedicated accounts.


DateToday to DateMax

     

closestAccessibleValue1

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the first currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

closestAccessibleValue2

String, -9 223 372 036 854 775 807 to 9 223 372 036 854 775 807 unit

Optional (0-1)

The balance of the sub dedicated account(s) with the closest start date. This parameter is only valid for composite dedicated accounts.


It indicates the balance in the second currency.


If the unit type is other than money the closestAccessibleValue1 contains the sum of the valid units and closestAccessibleValue2 is omitted.

     

subDedicatedAccountInformation

Sub-MO

Optional (0-n)

Balances and dates for sub dedicated accounts.

       

dedicatedAccountValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the first currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

dedicatedAccountValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

The total balance of the dedicated account, this includes all currently active and not yet active balances of the dedicated account if applicable. This is not taking in consideration any ongoing chargeable events.


It indicates that the balance is in the second currency.


If the unit type is not money the dedicatedAccountValue1 contains the sum of the valid units and dedicatedAccountValue2 is omitted.


When dedicatedAccountUnitType is Money, the parameter can contain both an integer part and a decimal part. There is no decimal separator, the decimal part is given directly to the right of the integer part. The number of digits in the decimal part is configured in the currency configuration. The integer part range is: 0-9223372036854. The decimal part can consist of 0 to 6 digits, that is maximum value is 999999. If the maximum value of the integer part is reached the maximum decimal part is 775807.

       

startDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date when a dedicated account, FaF entry or offer will be considered as active. The parameter may also be used to define start date for other entities depending on the context where it is used.


Element Value Range: DateMin to DateMax or DateBeginningOfTime

       

expiryDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The expiry date for a dedicated account.


Element Value Range: DateMin to DateMax or DateInfinite

     

dedicatedAccountActiveValue1

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the first currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountActiveValue2

String, 0 - 9 223 372 036 854 775 807 unit

Optional (0-1)

This parameter contains a dedicated account balance that can be consumed right now. This is not taking in consideration any ongoing chargeable events. The active value is only valid for composite dedicated account as they can have resources that becomes accessible later.


It indicates that the balance is in the second currency.


If the unit type is other than money the dedicatedAccountActiveValue1 contains the sum of the valid units and dedicatedAccountActiveValue2 is omitted.

     

dedicatedAccountUnitType

Integer, 0 - 6


0 = The account contains time.


1 = The account contains money.


2 - 4 = The account contains total octets (Not used, reserved for future use).


5 = The account contains service specific units.


6 = The account contains volume.

Optional (0-1)

The unit of the dedicated account values and is mandatory if the function "multi unit" is active, in other case it is optional.

     

compositeDedicatedAccountFlag

Boolean { 1 }

Optional (0-1)

This flag indicates that a dedicated account is a composite dedicated account. It is used to identify a composite dedicated account that does not have any sub dedicated accounts.

   

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

     

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

     

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

     

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

     

attributeValueDecimal

Sub-MO

Optional (0-1)

Information about a decimal value.

       

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

     

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute.

     

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

   

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

     

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

     

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about a treeParameter.

       

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

       

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

       

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

       

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

         

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

         

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter contains information about where to put the decimal sign counted in positions from the right.

       

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

       

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

         

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

         

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

         

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

         

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

         

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

         

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

         

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

         

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

       

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

         

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

         

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

       

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

       

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

       

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

   

productOfferingName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

refillFraudCount

Integer, 0 - 255

Optional (0-1)

Contain the number of fraudulent refill attempts left, before the account becomes barred from refill.

selectedOption

Integer, 1 - 999

Optional (0-1)

The value of the selected option. The values are configurable by the operator. The value is primarily used for Option Refill.

segmentationID

String, 1 - 4 characters

Optional (0-1)

The value that was used for the branching in the refill trees.

refillType

Integer, 1-999


1 = Value Refill


2 = Account Refill


3 = Premium Refill


4~99 = Reserved for future use


100~999 = Operator defined

Optional (0-1)

The refillType parameter specifies the kind of refill, it is part of both the refill request and refill response.

accountPrepaidEmptyLimit1

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the first currency

accountPrepaidEmptyLimit2

String, -999 999 999 999 to 999 999 999 999

Optional (0-1)

The lowest allowed balance on an account.


It indicates an account balance in the second currency

treeDefinedField

Sub-MO

Optional (0-1)

Information about the Tree Defined Field values.

 

treeDefinedFieldName

String, 1-200 characters

Mandatory

The name of the TDF.

 

treeDefinedFieldType

String


Enumeration value="Boolean"


Enumeration value="String"


Enumeration value="Long"


Enumeration value="Amount"

Mandatory

The defined type of the TDF.

 

treeDefinedFieldValue

String, depends on treeDefinedFieldType


If treeDefinedFieldType is Boolean, then the value is "true" or "false"


If treeDefinedFieldType is String, then the value is all allowed characters.


If treeDefinedFieldType is Long, then the value is 1 - 9 digits.


If treeDefinedFieldType is Amount, then the value is the Decimal value and currency code to hold a monetary amount.

Mandatory

The defined value of the TDF.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

9.3   Examples

9.3.1   Example of Refilling with Voucher

This section gives an example of the setRefill request and response message. This example shows how to refill with voucher.

Request Example

Example 80   Set Refill Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
           <cai3:SessionId>e64d81502bc741bf9b2d9b8babec3ce2</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Refill@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000005</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setRefill subscriberNumber="465273152000005">
               <air:originNodeType>ADM</air:originNodeType>
               <air:voucherActivationCode>11111111</air:voucherActivationCode>
            </air:setRefill>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 81   Set Refill Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>e64d81502bc741bf9b2d9b8babec3ce2</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setRefillResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000005</air:subscriberNumber>
               <air:originTransactionID>43061763180304238</air:originTransactionID>
               <air:masterAccountNumber>465273152000005</air:masterAccountNumber>
               <air:languageIDCurrent>1</air:languageIDCurrent>
               <air:voucherAgent>1</air:voucherAgent>
               <air:voucherSerialNumber>11111111</air:voucherSerialNumber>
               <air:voucherGroup>1</air:voucherGroup>
               <air:currency1>SEK</air:currency1>
               <air:segmentationID>01</air:segmentationID>
               <air:refillType>0</air:refillType>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setRefillResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

9.3.2   Example of Refilling without Voucher

This section gives an example of the setRefill request and response message. This example shows how to refill without voucher.

Request Example

Example 82   Set Refill Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
           <cai3:SessionId>07581bf0857345109d3b24e6d2928258</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Refill@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000005</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setRefill subscriberNumber="465273152000005">
               <air:originNodeType>ADM</air:originNodeType>
               <air:transactionAmount>13</air:transactionAmount>
               <air:transactionCurrency>SEK</air:transactionCurrency>
               <air:refillProfileID>1</air:refillProfileID>
            </air:setRefill>
        </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 83   Set Refill Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>07581bf0857345109d3b24e6d2928258</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setRefillResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000005</air:subscriberNumber>
               <air:originTransactionID>43061763180304238</air:originTransactionID>
               <air:masterAccountNumber>465273152000005</air:masterAccountNumber>
               <air:languageIDCurrent>1</air:languageIDCurrent>
               <air:transactionCurrency>SEK</air:transactionCurrency>
               <air:transactionAmount>13</air:transactionAmount>
               <air:currency1>SEK</air:currency1>
               <air:segmentationID>MA</air:segmentationID>
               <air:refillType>0</air:refillType>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646916</air:availableServerCapabilities>
            </air:setRefillResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

10   Set AIR Communication ID

This section covers the AIR subscriber command setCommunicationID.

MOType

CommunicationID@http://schemas.ericsson.com/ma/CS/AIR/

10.1   Request Data

10.1.1   Parameters

MOId

Table 37    Set Communication ID Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 38 covers the parameters that can be used in a setCommunicationID request.

Table 38    Set Communication ID Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Mandatory

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Mandatory

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Mandatory

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.


If this parameter is absent from the request, Dynamic Activation will generate System time milliseconds plus seven ramdon digital numbers as the parameter to NEs.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

msisdnCurrent

String, 1 - 28 digits

Optional (0-1)

This parameter contains the existing subscriber identity of the subscriber. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

msisdnCurrentNAI

Integer, 0 - 7


0 = Unknown


1 = International number


2 = National significant number


3 = Network specific number


4 = Subscriber number


5 = Reserved


6 = Abbreviated Number


7 = Reserved for extension

Optional (0-1)

Nature of Address Indicator identifies the format of the msisdnCurrent parameter.

msisdnNew

String, 1 - 28 digits

Optional (0-1)

The MSISDN format of the msisdnNew parameter

msisdnNewNAI

Integer, 0 - 7


0 = Unknown


1 = International number


2 = National significant number


3 = Network specific number


4 = Subscriber number


5 = Reserved


6 = Abbreviated Number


7 = Reserved for extension

Optional (0-1)

Nature of Address Indicator identifies the format of the msisdnNew parameter.

imsiCurrent

String, 1 - 15 digits

Optional (0-1)

The subscriber's existing IMSI.

imsiNew

String, 1 - 15 digits

Optional (0-1)

The subscriber's new IMSI.

naiCurrent

String, 1-128 characters

Optional (0-1)

The subscriber's existing Network Access Identifier (NAI).

naiNew

String, 1-128 characters

Optional (0-1)

The subscriber's new Network Access Identifier (NAI).

sipUriCurrent

String, 1-128 characters

Optional (0-1)

The subscriber's existing SIP-URI.

sipUriNew

String, 1-128 characters

Optional (0-1)

The subscriber's new SIP-URI.

privateCurrent

String, 1-128 characters

Optional (0-1)

The subscriber's existing address in Private format.

privateNew

String, 1-128 characters

Optional (0-1)

The subscriber's new address in Private format.

chargingInformation

Sub-MO

Mandatory

Information for an charged Online Communication ID Change.

 

chargingIndicator

Integer, 0 - 65535

Optional (0-1)

An indicator for rating differentiation.

 

specifiedPrice

String, 0 - 999 999 999 999

Optional (0-1)

The price that shall be used to charge for the operation, instead of using the rating function normally used.

 

transactionCurrency

String, Currency

Optional (0-1)

The ID to point out what currency is used for the transaction.


For example, SEK, EUR, USD, etc.

 

suppressDeduction

Boolean {0, 1}


0 (false) = Default value. Not suppressed deduction


1 (true) = Suppressed deduction

Optional (0-1)

Indicates if the calculated cost is to be withdrawn from the account or not.

externalContract

Boolean {0, 1}


0 (false) = Not an external contract, that is, the account resides in Charging Compound.


1 (true) = An external contract, the account resides outside Charging Compound.

Optional (0-1)

Indicate if the account resides in Charging Compound or in an external system in a convergent solution.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

10.2   Response Data

10.2.1   Parameters

MOAttributes

Table 39 covers the parameters that can be used in a setCommunicationID response.

Table 39    Set Communication ID Parameters

Parameter

Type

Occurrence

Description

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Mandatory

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

cleanupDate

DateTime.iso8601

Optional (0-1)

Information of how long an old Identifier is kept in parallel during an Online Communication ID change.


DateToday to DateMax

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

deductionSuppressed

Boolean {0, 1}


0 (false) = Default value. Not suppressed deduction


1 (true) = Suppressed deduction

Optional (0-1)

Indicates if the calculated cost has not been withdrawn from the account or not.

chargingResultInformation

Sub-MO

Optional (0-1)

Information for a charged end user communication event.

 

cost1

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the first currency.

 

currency1

String, currency

Optional (0-1)

The first currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

cost2

String, -999 999 999 999 to 999 999 999 999 price

Optional (0-1)

The cost for an event.


It indicates a cost in the second currency.

 

currency2

String, currency

Optional (0-1)

The second currency to be presented to the end user.


For example, SEK, EUR, USD, etc.

 

chargingResultCode

Integer, 0 - 2


0 = or not present Successful


1 = No charge (free counter stepped)


2 = No charge (free counter not stepped)

Optional (0-1)

Information related to a charged event.

 

reservationCorrelationID

Integer, 0 - 2147483647

Optional (0-1)

The id needed to correlate a reservation.

negotiatedCapabilities

Interger: array of <int> or <i4>


0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node.


The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

10.3   Examples

This section gives an example of the setCommunicationID request and response message. This example shows how to set the communication ID .

Request Example

Example 84   Set Communication ID Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>12b27d765da5490b87a864dbb9a5a7fd</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>CommunicationID@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setCommunicationID subscriberNumber="465273152000010">
               <air:imsiCurrent>46001111222</air:imsiCurrent>
               <air:imsiNew>46001111223</air:imsiNew>
               <air:externalContract>1</air:externalContract>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setCommunicationID>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 85   Set Communication ID Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>12b27d765da5490b87a864dbb9a5a7fd</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setCommunicationIDResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:originTransactionID>1442804667204430352</air:originTransactionID>
               <air:cleanupDate>2015-12-20T12:00:00+00:00</air:cleanupDate>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646852</air:availableServerCapabilities>
            </air:setCommunicationIDResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

11   Get Accumulators

This section covers the AIR command getAccumulators.

MOType

Accumulators@http://schemas.ericsson.com/ma/CS/AIR/

11.1   Request Data

11.1.1   Parameters

MOId

Table 40    Get Accumulators MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 41 covers the parameters that can be used in a getAccumulatorsResponse request.

Table 41    Get Accumulators Parameter

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

messageCapabilityFlag

 

Optional (0-1)

The possible actions that may be performed on the account due to an operation initiated over this protocol.

 

promotionNotificationFlag

Boolean { 0, 1 }


0 (false) = Default value. Promotion notification code will not be cleared after delivery in response.


1 (true) = Promotion notification code will be cleared after delivery in response.

Optional (0-1)

Indicate whether the promotion notification code shall be cleared or not after delivery in response.

 

firstIVRCallSetFlag

Boolean { 0, 1 }


0 (false) = Do not set first IVR call done flag.


1 (true) = Set first IVR call done flag.

Optional (0-1)

Indicate whether the first IVR call done flag shall be set or not.

 

accountActivationFlag

Boolean { 0, 1 }


0 (false) = Default value. Pre-activated accounts will not be activated due to the request. Account can however be activated if service fee and supervision expiry dates are set as a result of this request. In this case neither the initial balance nor the life-cycle dates from the pre-activation configuration will not be given.


1 (true) = Pre-activated accounts may be activated due to the request. If service fee and supervision expiry dates are explicitly received in the request these days will used and initial balance will be applied (but no additional days from the pre-activation configuration will be given). If service fee and supervision expiry dates are not explicitly set in the request initial life-cycle days and initial balance is applied.

Optional (0-1)

Indicate whether pre-activated accounts can be or cannot be activated due to the request. The possibility to activate a pre-activated account by this flag is configured in the account databases service class configuration. This results in that even if the flag is set to true the account may not be activated.

accumulatorSelection

Sub-Mo

Optional (0-n)

This parameter is used to select which usage accumulators that will be returned.

 

accumulatorIDFirst

Interger, 1 - 2147483647

Mandatory

The first accumulator identity in a sequence of usage accumulators or the only accumulator identity if a single usage accumulator shall be obtained.

 

accumulatorIDLast

Interger, 1 - 2147483647

Optional (0-1)

The last accumulator identity in a sequence of usage accumulators.

negotiatedCapabilities

Interger, 0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node. The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active..

11.2   Response Data

11.2.1   Parameters

MOId

Table 42    Get Accumulators Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 43 covers the parameters that can be used in a getAccumulators response.

Table 43    Get Accumulators Parameter

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

languageIDCurrent

Integer, 1 - 4


1 = Operator specific language 1


2 = Operator specific language 2


3 = Operator specific language 3


4 = Operator specific language 4

Mandatory

The preferred language of the subscriber.

serviceClassCurrent

Integer, 0 - 9999

Mandatory

The service class currently used by the subscriber.

accumulatorInformation

 

Optional (0-1)

The list information of accumulator.

 

accumulatorID

Integer, 1 - 2147483647

Mandatory

The identity of accumulator.

 

accumulatorValue

Integer, -2147483648 to 2147483647

Mandatory

The value of accumulator.

 

accumulatorStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Indicates the date on which the accumulator was last reset.

 

accumulatorEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Indicates the date on which the accumulator will be reset to the initial value again.

temporaryBlockedFlag

Boolean { 0, 1 }


0 (false) = Default value. Unblocked


1 (true) = Temporary blocked

Optional (0-1)

Indicate whether the subscriber and operator has access to subscriber and account data.

accountFlagsAfter

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account after.

 

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

 

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

 

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

 

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

 

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

 

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

accountFlagsBefore

 

Optional (0-1)

Life cycle state flags of the account, indicating the actual status of the account before.

 

activationStatusFlag

Boolean, { 0,1 }


0 (false) = Default value. Account is not activated


1 (true) = Account is activated

Optional (0-1)

Indicate whether an account is activated or not.

 

negativeBarringStatusFlag

Boolean { 0,1 }


0 (false) = Default value. Account is not barred due to negative balance.


1 (true) = Account is barred due to negative balance.

Optional (0-1)

Indicate whether an account is barred due to negative balance or not.

 

supervisionPeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date expiration warning not active.


1 (true) = Supervision period date expiration warning active.

Optional (0-1)

Indicate whether the supervision period date expiration warning is active or not.

 

serviceFeePeriodWarningActiveFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date expiration warning not active.


1 (true) = Service fee period date expiration warning active

Optional (0-1)

Indicate whether the service fee period date expiration warning is active or not.

 

supervisionPeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Supervision period date has not expired.


1 (true) = Supervision period date has expired.

Optional (0-1)

Indicate whether the supervision period date has expired or not.

 

serviceFeePeriodExpiryFlag

Boolean, { 0,1 }


0 (false) = Default value. Service fee period date has not expired.


1 (true) = Service fee period date has expired.

Optional (0-1)

Indicate whether the service fee period date has expired or not.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

11.3   Examples

This section gives an example of the getAccumulators request and response message. This example shows how to get Accumulators.

Request Example

Example 86   Get Accumulators Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SequenceId>12345</cai3:SequenceId>
      <cai3:TransactionId>12345</cai3:TransactionId>
      <cai3:SessionId>70c10a7fd2de4bed9ca3c03f2313af98</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Accumulators@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getAccumulators subscriberNumber="465273152000001">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>00000</air:originTransactionID>
               <air:originTimeStamp>2015-10-01T12:00:00+00:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:messageCapabilityFlag>
                  <air:promotionNotificationFlag>0</air:promotionNotificationFlag>
                  <air:firstIVRCallSetFlag>0</air:firstIVRCallSetFlag>
                  <air:accountActivationFlag>0</air:accountActivationFlag>
               </air:messageCapabilityFlag>
               <air:accumulatorSelection>
                  <air:accumulatorIDFirst>1</air:accumulatorIDFirst>
                  <air:accumulatorIDLast>2</air:accumulatorIDLast>
               </air:accumulatorSelection>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:getAccumulators>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 87   Get Accumulators Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>70c10a7fd2de4bed9ca3c03f2313af98</cai3g:SessionId>
      <cai3g:TransactionId>12345</cai3g:TransactionId>
      <cai3g:SequenceId>12345</cai3g:SequenceId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getAccumulatorsResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>00000</air:originTransactionID>
               <air:languageIDCurrent>1</air:languageIDCurrent>
               <air:serviceClassCurrent>111</air:serviceClassCurrent>
               <air:accumulatorInformation>
                  <air:accumulatorID>1</air:accumulatorID>
                  <air:accumulatorValue>2147483647</air:accumulatorValue>
                  <air:accumulatorStartDate>2015-10-01T12:00:00+00:00</air:accumulatorStartDate>
                  <air:accumulatorEndDate>2021-10-31T12:00:00+00:00</air:accumulatorEndDate>
               </air:accumulatorInformation>
               <air:accumulatorInformation>
                  <air:accumulatorID>2</air:accumulatorID>
                  <air:accumulatorValue>2147483647</air:accumulatorValue>
                  <air:accumulatorStartDate>2015-11-01T12:00:00+00:00</air:accumulatorStartDate>
                  <air:accumulatorEndDate>2024-12-16T12:00:00+00:00</air:accumulatorEndDate>
               </air:accumulatorInformation>
               <air:accountFlagsAfter>
                  <air:activationStatusFlag>1</air:activationStatusFlag>
                  <air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
                  <air:supervisionPeriodWarningActiveFlag>0</air:supervisionPeriodWarningActiveFlag>
                  <air:serviceFeePeriodWarningActiveFlag>0</air:serviceFeePeriodWarningActiveFlag>
                  <air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
                  <air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
               </air:accountFlagsAfter>
               <air:accountFlagsBefore>
                  <air:activationStatusFlag>1</air:activationStatusFlag>
                  <air:negativeBarringStatusFlag>0</air:negativeBarringStatusFlag>
                  <air:supervisionPeriodWarningActiveFlag>0</air:supervisionPeriodWarningActiveFlag>
                  <air:serviceFeePeriodWarningActiveFlag>0</air:serviceFeePeriodWarningActiveFlag>
                  <air:supervisionPeriodExpiryFlag>0</air:supervisionPeriodExpiryFlag>
                  <air:serviceFeePeriodExpiryFlag>0</air:serviceFeePeriodExpiryFlag>
               </air:accountFlagsBefore>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getAccumulatorsResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

12   Set Accumulators

This section covers the AIR command setAccumulators.

MOType

Accumulators@http://schemas.ericsson.com/ma/CS/AIR/

12.1   Request Data

12.1.1   Parameters

MOId

Table 44    Set Accumulators MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 45 covers the parameters that can be used in a setAccumulators request.

Table 45    Set Accumulators Parameter

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.

accumulatorUpdateInformation

Sub-MO

Mandatory

The updated information of the accumulator.

 

accumulatorID

Integer, 1 - 2147483647

Mandatory

The identity of accumulator.

 

accumulatorValueRelative

Integer, -2147483648 to 2147483647

Optional (0-1)

An accumulator value used for a relative update.

 

accumulatorValueAbsolute

Integer, -2147483648 to 2147483647

Optional (0-1)

An accumulator value used for an absolute update.

 

accumulatorStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Indicates the date on which the accumulator was last reset.

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

negotiatedCapabilities

Interger, 0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node. The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active..

12.2   Response Data

12.2.1   Parameters

MOId

Table 46    Set Accumulators Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 47 covers the parameters that can be used in a setAccumulators response.

Table 47    Set Accumulators Parameter

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

12.3   Examples

This section gives an example of the setAccumulators request and response message. This example shows how to set Accumulators.

Request Example

Example 88   Set Accumulators Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>ffaaa4415eb249449a1a6f6827b7ca1e</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Accumulators@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setAccumulators subscriberNumber="465273152000001">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>00000</air:originTransactionID>
               <air:originTimeStamp>2015-10-01T12:00:00+00:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:originOperatorID>user1</air:originOperatorID>
               <air:accumulatorUpdateInformation>
                  <air:accumulatorID>1</air:accumulatorID>
                  <air:accumulatorValueAbsolute>2147483647</air:accumulatorValueAbsolute>
                  <air:accumulatorStartDate>2015-10-01T12:00:00+00:00</air:accumulatorStartDate>
               </air:accumulatorUpdateInformation>
               <air:accumulatorUpdateInformation>
                  <air:accumulatorID>2</air:accumulatorID>
                  <air:accumulatorValueAbsolute>2147483647</air:accumulatorValueAbsolute>
                  <air:accumulatorStartDate>2015-11-01T12:00:00+00:00</air:accumulatorStartDate>
               </air:accumulatorUpdateInformation>
               <air:serviceClassCurrent>111</air:serviceClassCurrent>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setAccumulators>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 89   Set Accumulators Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>ffaaa4415eb249449a1a6f6827b7ca1e</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setAccumulatorsResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:subscriberNumber>465273152000001</air:subscriberNumber>
               <air:originTransactionID>00000</air:originTransactionID>
               <air:originOperatorID>user1</air:originOperatorID>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:setAccumulatorsResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

13   Delete Accumulators

This section covers the AIR command deleteAccumulators.

MOType

Accumulators@http://schemas.ericsson.com/ma/CS/AIR/

13.1   Request Data

13.1.1   Parameters

MOId

Table 48    Delete Accumulators MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 49 covers the parameters that can be used in a deleteAccumulators request.

Table 49    Delete Accumulators Parameter

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.

serviceClassCurrent

Integer, 0 - 9999

Optional (0-1)

The service class currently used by the subscriber.

accumulatorIdentifier

Sub-MO

Mandatory

The identifier information of the accumulator.

 

accumulatorID

Integer, 1 - 2147483647

Mandatory

The identity of accumulator.

 

accumulatorEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Indicates the date on which the accumulator will be reset to the initial value again.

negotiatedCapabilities

Interger, 0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node. The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active..

13.2   Response Data

13.2.1   Parameters

MOId

Table 50    Delete Accumulators Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 51 covers the parameters that can be used in a deleteAccumulators response.

Table 51    Delete Accumulators Parameter

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.

accumulatorInformation

Sub-MO

Mandatory

The list information of accumulator.

 

accumulatorID

Integer, 1 - 2147483647

Mandatory

The identity of accumulator.

 

accumulatorValue

Integer, -2147483648 to 2147483647

Mandatory

The value of accumulator.

 

accumulatorStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Indicates the date on which the accumulator was last reset.

 

accumulatorEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Indicates the date on which the accumulator will be reset to the initial value again.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

13.3   Examples

This section gives an example of the deleteAccumulators request and response message. This example shows how to delete Accumulators.

Request Example

Example 90   Delete Accumulators Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SequenceId>12345</cai3:SequenceId>
      <cai3:TransactionId>12345</cai3:TransactionId>
      <cai3:SessionId>d3679e5e0af64a77804210816a7e1e70</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>Accumulators@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:deleteAccumulators subscriberNumber="465273152000001">
               <air:originNodeType>ADM</air:originNodeType>
               <air:originHostName>node1</air:originHostName>
               <air:originTransactionID>00000</air:originTransactionID>
               <air:originTimeStamp>2015-10-01T12:00:00+00:00</air:originTimeStamp>
               <air:subscriberNumberNAI>1</air:subscriberNumberNAI>
               <air:originOperatorID>user1</air:originOperatorID>
               <air:serviceClassCurrent>111</air:serviceClassCurrent>
               <air:accumulatorIdentifier>
                  <air:accumulatorID>1</air:accumulatorID>
                  <air:accumulatorEndDate>2030-10-01T12:00:00+00:00</air:accumulatorEndDate>
               </air:accumulatorIdentifier>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:deleteAccumulators>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 91   Delete Accumulators Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>d3679e5e0af64a77804210816a7e1e70</cai3g:SessionId>
      <cai3g:TransactionId>12345</cai3g:TransactionId>
      <cai3g:SequenceId>12345</cai3g:SequenceId>
   </S:Header>
   <S:Body>
      <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
              465273152000001</air:subscriberNumber>
         </MOId>
         <MOAttributes>
            <deleteAccumulatorsResponse:deleteAccumulatorsResponse 
xmlns="http://schemas.ericsson.com/ma/CS/AIR/" 
xmlns:deleteAccumulatorsResponse="http://schemas.ericsson.com/ma/CS/AIR/">
               <subscriberNumber>465273152000001</subscriberNumber>
               <originTransactionID>14484215823058213847</originTransactionID>
               <originOperatorID>user1</originOperatorID>
               <accumulatorInformation>
                  <accumulatorID>1</accumulatorID>
                  <accumulatorValue>2147483647</accumulatorValue>
                  <accumulatorStartDate>2015-10-01T12:00:00+00:00</accumulatorStartDate>
                  <accumulatorEndDate>2021-10-31T12:00:00+00:00</accumulatorEndDate>
               </accumulatorInformation>
               <negotiatedCapabilities>0</negotiatedCapabilities>
               <availableServerCapabilities>809988676</availableServerCapabilities>
            </deleteAccumulatorsResponse:deleteAccumulatorsResponse>
         </MOAttributes>
      </DeleteResponse>
   </S:Body>
</S:Envelope>

14   Set AIR Run Periodic Account Management

This section covers the AIR subscriber command setRunPeriodicAccountManagement.

MOType

RunPeriodicAccountManagement@http://schemas.ericsson.com/ma/CS/AIR/

14.1   Request Data

14.1.1   Parameters

MOId

Table 52    Set Run Periodic Account Management Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 53 covers the parameters that can be used in a setRunPeriodicAccountManagement request.

Table 53    Set Run Periodic Account Management Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

The Unique identifier for the transaction, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. An operation in this case is for example a refill.

originTimeStamp

String: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1- 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It can be used for security management or logging purposes for an example.

pamServiceID

Integer, 0 - 99

Mandatory

The id of the periodic account management service.

pamIndicator

Integer, 0 - 65535

Optional (0-1)

This parameter is used for differentiation in the periodic account management structure when executing a periodic account management evaluation.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

14.2   Response Data

14.2.1   Parameters

MOId

Table 54    Set Run Periodic Account Management Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 55 covers the parameters that can be used in a setRunPeriodicAccountManagement response.

Table 55    Set Run Periodic Account Management Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Mandatory

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.

pamInformation

SubMo

Mandatory

Information used for periodic account management.

 

pamServiceID

Integer, 0 - 99

Mandatory

The id of the periodic account management service.

 

pamClassID

Integer, 0 - 9999

Mandatory

The periodic account management class used by the periodic account management service.

 

scheduleID

Integer, 0 - 9999

Mandatory

The schedule that is used by the periodic account management service.

 

currentPamPeriod

String, 1 - 30 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Mandatory

Periodic account management period that is currently used for the subscriber.

 

deferredToDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The deferred to date for the Periodic Account Management service.

 

lastEvaluationDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Date of the last periodic account management evaluation.

 

pamServicePriority

Integer, 0 - 65535

Optional (0-1)

Indicate the priority between PAM services at PAM evaluation. Lower value gives higher priority.

negotiatedCapabilities

Interger, 0 - 2147483647

Optional (0-n)

Indicates the negotiated capabilities between the client and server node.


The capabilities are presented as a series of elements, where each element contains an integer value between 0 and 2147483647. The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

14.3   Examples

This section gives an example of the setRunPeriodicAccountManagement request and response message. This example shows how to set Run Periodic Account Management.

Request Example

Example 92   Set Run Periodic Account Management Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>12b27d765da5490b87a864dbb9a5a7fd</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>CommunicationID@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000010</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:setCommunicationID subscriberNumber="465273152000010">
               <air:imsiCurrent>46001111222</air:imsiCurrent>
               <air:imsiNew>46001111223</air:imsiNew>
               <air:externalContract>1</air:externalContract>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
            </air:setCommunicationID>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 93   Set Run Periodic Account Management Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>12b27d765da5490b87a864dbb9a5a7fd</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:setCommunicationIDResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:originTransactionID>1442804667204430352</air:originTransactionID>
               <air:cleanupDate>2015-12-20T12:00:00+00:00</air:cleanupDate>
               <air:negotiatedCapabilities>0</air:negotiatedCapabilities>
               <air:availableServerCapabilities>805646852</air:availableServerCapabilities>
            </air:setCommunicationIDResponse>
         </MOAttributes>
      </SetResponse>
   </S:Body>
</S:Envelope>

15   Get AIR Capabilities

This section covers the AIR subscriber command getCapabilites.

MOType

Capabilites@http://schemas.ericsson.com/ma/CS/AIR/

15.1   Request Data

15.1.1   Parameters

MOId

Table 56    Get Capabilities Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

15.2   Response Data

15.2.1   Parameters

MOAttributes

Table 57 covers the parameters that can be used in a getCapabilites response.

Table 57    Get Capabilities Parameters

Parameter

Type

Occurrence

Description

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

15.3   Examples

This section gives an example of the getCapabilites request and response message. This example shows how to get Capabilities.

Request Example

Example 94   Get Capabilities Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
   <soapenv:Header>
      <cai3:SessionId>a4573228f4124562bf58b6624565607d</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Capabilities@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
         <cai3:MOId>
            <air:subscriberNumber>465273152000001</air:subscriberNumber>
         </cai3:MOId>
         <cai3:MOAttributes>
            <air:getCapabilities subscriberNumber="465273152000001"/>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 95   Get Capabilities Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>a4573228f4124562bf58b6624565607d</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <air:getCapabilitiesResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
               <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
            </air:getCapabilitiesResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

16   Create AF Subscription

This section covers the AF command createSubscription .

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AF/

16.1   Request Data

16.1.1   Parameters

MOId

Table 58    Create Subscription MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

MOAttributes

Table 59 covers the parameters that can be used in a createSubscription request.

Table 59    Create Subscription Parameters

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

ttl

Integer

Optional (0-1)

Time To Live

sdpHostName

String


Format : hostname.domainname

Mandatory

SDP hostname

prerequisite

Boolean, {true, false}

Optional (0-1)

When it is set to TRUE in the Create operation, it means the MSISDNs are not to be defined in AF, otherwise error is returned.


When set to FALSE, it means that this request is to be forced to execute no matter MSISDNs exists or not.

16.2   Examples

This section gives an example of the createSubscription request and response message. This example shows how to create a Subscription.

Request Example

Example 96   Create Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>afe520a0a77e4f47b419bb0555665c11</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000995</af:msisdn>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:createSubscription msisdn="465273152000995">
               <af:msisdn>465273152000995</af:msisdn>
               <af:ttl>2147483647</af:ttl>
               <af:sdpHostName>vmx2118x2119-vip</af:sdpHostName>
               <af:prerequisite>1</af:prerequisite>
            </af:createSubscription>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 97   Create Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>afe520a0a77e4f47b419bb0555665c11</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <CreateResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <af:msisdn xmlns:af="http://schemas.ericsson.com/ma/CS/AF/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000995</af:msisdn>
         </MOId>
      </CreateResponse>
   </S:Body>
</S:Envelope>

17   Set AF Subscription

This section covers the AF command setSubscription.

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AF/

17.1   Request Data

17.1.1   Parameters

MOId

Table 60    Set Subscription MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

MOAttributes

Table 61 covers the parameters that can be used in a setSubscription request.

Table 61    Set Subscription Parameters

Parameter

Type

Occurrence

Description

ttl

Integer

Optional (0-1)

Time To Live

sdpHostName

String


Format : hostname.domainname

Mandatory

SDP hostname

prerequisite

Boolean, {true, false}

Optional (0-1)

When it is set to TRUE in the Create operation, it means the MSISDNs are not to be defined in AF, otherwise error is returned.


When set to FALSE, it means that this request is to be forced to execute no matter MSISDNs exists or not.

17.2   Examples

This section gives an example of the setSubscription request and response message. This example shows how to set a Subscription.

Request Example

Example 98   Set Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>96904b47ed2342aab5a59695b10d9677</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000995</af:msisdn>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:setSubscription msisdn="465273152000995">
               <af:ttl>0</af:ttl>
               <af:sdpHostName>vmx2118x2119-vip</af:sdpHostName>
               <af:prerequisite>1</af:prerequisite>
            </af:setSubscription>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 99   Set Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>96904b47ed2342aab5a59695b10d9677</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/"/>
   </S:Body>
</S:Envelope>

18   Get AF Subscription

This section covers the AF command getSubscription.

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AF/

18.1   Request Data

18.1.1   Parameters

MOId

Table 62    Get Subscription MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

18.2   Response Data

18.2.1   Parameters

MOAttributes

Table 63 covers the parameters that can be used in a getSubscription response.

Table 63    Get Subscription Parameters

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

class

String

Mandatory

Class identifier

ttl

Integer

Mandatory

Time To Live

sdpHostName

String


Format : hostname.domainname

Mandatory

SDP hostname

sdpIP

String

Mandatory

The IP address of SDP node

18.3   Examples

This section gives an example of the getSubscription request and response message. This example shows how to get a Subscription.

Request Example

Example 100   Get Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>96904b47ed2342aab5a59695b10d9677</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000995</af:msisdn>
         </cai3:MOId>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 101   Get Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>96904b47ed2342aab5a59695b10d9677</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOAttributes>
            <af:getSubscriptionResponse xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
               <af:msisdn>465273152000995</af:msisdn>
               <af:class>IN</af:class>
               <af:ttl>2147483647</af:ttl>
               <af:sdpHostName>vmx2118x2119-vip.cs.</af:sdpHostName>
               <af:sdpIP>10.61.14.128</af:sdpIP>
            </af:getSubscriptionResponse>
         </MOAttributes>
      </GetResponse>
   </S:Body>
</S:Envelope>

19   Delete AF Subscription

This section covers the AF command deleteSubscription.

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AF/

19.1   Request Data

19.1.1   Parameters

MOId

Table 64    Delete Subscription MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

19.2   Examples

This section gives an example of the deleteSubscription request and response message. This example shows how to delete a Subscription.

Request Example

Example 102   Delete Subscription Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>96904b47ed2342aab5a59695b10d9677</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>Subscription@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000995</af:msisdn>
         </cai3:MOId>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 103   Delete Subscription Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>96904b47ed2342aab5a59695b10d9677</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <af:msisdn xmlns:af="http://schemas.ericsson.com/ma/CS/AF/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000995</af:msisdn>
         </MOId>
      </DeleteResponse>
   </S:Body>
</S:Envelope>

20   Create AF Identifier

This section covers the AF command createIdentifier .

MOType

Identifier@http://schemas.ericsson.com/ma/CS/AF/

20.1   Request Data

20.1.1   Parameters

MOId

Table 65    Create Identifier MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

identifier

String, 1 - 28 digits

Mandatory

The identifier pointing to an MSISDN.

MOAttributes

Table 66 covers the parameters that can be used in a createIdentifier request.

Table 66    Create Identifier Parameters

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

identifier

String, 1 - 28 digits

Mandatory

The identifier pointing to an MSISDN.

type

String


Enumeration value="NAI"


Enumeration value="IMSI"


Enumeration value="SIP-URI"


Enumeration value="PRIVATE"

Mandatory

The type of the identifier

ttl

Integer

Optional (0-1)

Time To Live

prerequisite

Boolean, {true, false}

Optional (0-1)

When it is set to TRUE in the Create operation, it means the MSISDNs are not to be defined in AF, otherwise error is returned.


When set to FALSE, it means that this request is to be forced to execute no matter MSISDNs exists or not.

20.2   Examples

This section gives an example of the createIdentifier request and response message. This example shows how to create an identifier.

Request Example

Example 104   Create Identifier Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>8e883666b30541d2954e563e96b32123</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Create>
         <cai3:MOType>Identifier@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000111</af:msisdn>
            <af:identifier>naifoobar201@ericsson.com</af:identifier>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:createIdentifier msisdn="465273152000111" identifier="naifoobar201@ericsson.com">
               <af:msisdn>465273152000111</af:msisdn>
               <af:identifier>naifoobar201@ericsson.com</af:identifier>
               <af:type>nai</af:type>
               <af:ttl>201</af:ttl>
               <af:prerequisite>1</af:prerequisite>
            </af:createIdentifier>
         </cai3:MOAttributes>
      </cai3:Create>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 105   Create Identifier Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8e883666b30541d2954e563e96b32123</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <CreateResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <af:msisdn xmlns:af="http://schemas.ericsson.com/ma/CS/AF/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">465273152000111</af:msisdn>
            <af:identifier xmlns:af="http://schemas.ericsson.com/ma/CS/AF/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">naifoobar201@ericsson.com</af:identifier>
         </MOId>
      </CreateResponse>
   </S:Body>
</S:Envelope>

21   Set AF Identifier

This section covers the AF command setIdentifier.

MOType

Identifier@http://schemas.ericsson.com/ma/CS/AF/

21.1   Request Data

21.1.1   Parameters

MOId

Table 67    Set Identifier MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

identifier

String, 1 - 28 digits

Mandatory

The identifier pointing to an MSISDN.

MOAttributes

Table 68 covers the parameters that can be used in a setIdentifier request.

Table 68    Set Identifier Parameters

Parameter

Type

Occurrence

Description

type

String


Enumeration value="NAI"


Enumeration value="IMSI"


Enumeration value="SIP-URI"


Enumeration value="PRIVATE"

Mandatory

The type of the identifier

ttl

Integer

Optional (0-1)

Time To Live

prerequisite

Boolean, {true, false}

Optional (0-1)

When it is set to TRUE in the Create operation, it means the MSISDNs are not to be defined in AF, otherwise error is returned.


When set to FALSE, it means that this request is to be forced to execute no matter MSISDNs exists or not.

21.2   Examples

This section gives an example of the setIdentifier request and response message. This example shows how to set an identifier.

Request Example

This section gives an example of a setIdentifier request message, as shown in xxx.

Example 106   Set Identifier Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>8e883666b30541d2954e563e96b32123</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Set>
         <cai3:MOType>Identifier@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000111</af:msisdn>
            <af:identifier>naifoobar200@ericsson.com</af:identifier>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:setIdentifier msisdn="465273152000111" identifier="naifoobar200@ericsson.com">
               <af:type>nai</af:type>
               <af:ttl>200</af:ttl>
               <af:prerequisite>1</af:prerequisite>
            </af:setIdentifier>
         </cai3:MOAttributes>
      </cai3:Set>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 107   Set Identifier Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8e883666b30541d2954e563e96b32123</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/"/>
   </S:Body>
</S:Envelope>

22   Get AF Identifier

This section covers the command getIdentifier.

MOType

Identifier@http://schemas.ericsson.com/ma/CS/AF/

22.1   Request Data

22.1.1   Parameters

MOId

Table 69    Get Identifier MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

identifier

String, 1 - 28 digits

Mandatory

The identifier pointing to an MSISDN.

MOAttributes

Table 70 covers the parameters that can be used in a getIdentifier request.

Table 70    Get Identifier Parameters

Parameter

Type

Occurrence

Description

type

String


Enumeration value="NAI"


Enumeration value="IMSI"


Enumeration value="SIP-URI"


Enumeration value="PRIVATE"

Mandatory

The type of the identifier

22.2   Response Data

22.2.1   Parameters

MOAttributes

Table 71 covers the parameters that can be used in a getIdentifier response.

Table 71    Get Identifier Parameters

Parameter

Type

Occurrence

Description

identifier

String, 1 - 28 digits

Mandatory

The identifier pointing to an MSISDN.

type

String


Enumeration value="NAI"


Enumeration value="IMSI"


Enumeration value="SIP-URI"


Enumeration value="PRIVATE"

Mandatory

The type of the identifier

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

class

String

Mandatory

Class identifier

ttl

Integer

Mandatory

Time To Live

sdpHostName

String


Format : hostname.domainname

Mandatory

SDP hostname

sdpIP

String

Mandatory

The IP address of SDP node

22.3   Examples

This section gives an example of the getIdentifier request and response message. This example shows how to get an identifier.

Request Example

Example 108   Get Identifier Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>8e883666b30541d2954e563e96b32123</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Identifier@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000111</af:msisdn>
            <af:identifier>naifoobar200@ericsson.com</af:identifier>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:getIdentifier msisdn="465273152000111" identifier="naifoobar200@ericsson.com">
               <af:type>nai</af:type>
            </af:getIdentifier>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 109   Get Identifier Response Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>8e883666b30541d2954e563e96b32123</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Get>
         <cai3:MOType>Identifier@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000111</af:msisdn>
            <af:identifier>naifoobar200@ericsson.com</af:identifier>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:getIdentifier msisdn="465273152000111" identifier="naifoobar200@ericsson.com">
               <af:type>nai</af:type>
            </af:getIdentifier>
         </cai3:MOAttributes>
      </cai3:Get>
   </soapenv:Body>
</soapenv:Envelope>

23   Delete AF Identifier

This section covers the AF command deleteIdentifier.

MOType

Subscription@http://schemas.ericsson.com/ma/CS/AF/

23.1   Request Data

23.1.1   Parameters

MOId

Table 72    Delete Identifier MOId

Parameter

Type

Occurrence

Description

msisdn

String, 1 - 28 digits


  • A single number. For example, 13999292921

  • Several numbers separated by comma. For example, 13999292921, 13999292925, 13999292930

  • A number range. For example, 13999292921- 13999292971

Mandatory

Subscriber identifier

identifier

String, 1 - 28 digits

Mandatory

The identifier pointing to an MSISDN.

MOAttributes

Table 73 covers the parameters that can be used in a deleteIdentifier request.

Table 73    Delete Identifier Parameters

Parameter

Type

Occurrence

Description

type

String


Enumeration value="NAI"


Enumeration value="IMSI"


Enumeration value="SIP-URI"


Enumeration value="PRIVATE"

Mandatory

The type of the identifier

23.2   Examples

This section gives an example of the deleteIdentifier request and response message. This example shows how to delete an identifier.

Request Example

Example 110   Delete Identifier Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" xmlns:af="http://schemas.ericsson.com/ma/CS/AF/">
   <soapenv:Header>
      <cai3:SessionId>8e883666b30541d2954e563e96b32123</cai3:SessionId>
   </soapenv:Header>
   <soapenv:Body>
      <cai3:Delete>
         <cai3:MOType>Identifier@http://schemas.ericsson.com/ma/CS/AF/</cai3:MOType>
         <cai3:MOId>
            <af:msisdn>465273152000111</af:msisdn>
            <af:identifier>naifoobar200@ericsson.com</af:identifier>
         </cai3:MOId>
         <cai3:MOAttributes>
            <af:deleteIdentifier msisdn="465273152000111" identifier="naifoobar200@ericsson.com">
               <af:type>nai</af:type>
            </af:deleteIdentifier>
         </cai3:MOAttributes>
      </cai3:Delete>
   </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 111   Delete Identifier Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>8e883666b30541d2954e563e96b32123</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
         <MOId>
            <af:msisdn xmlns:af="http://schemas.ericsson.com/ma/CS/AF/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
             465273152000111</af:msisdn>
            <af:identifier xmlns:af="http://schemas.ericsson.com/ma/CS/AF/" 
xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
             naifoobar200@ericsson.com</af:identifier>
         </MOId>
      </DeleteResponse>
   </S:Body>
</S:Envelope>

24   Set PredefinedOffer

This section covers the AIR command setPredefinedOffer .

MOType

PredefinedOffer@http://schemas.ericsson.com/ma/CS/AIR/

24.1   Request Data

24.1.1   Parameters

MOId

Table 74    Set PredefinedOffer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

MOAttributes

Table 75 covers the parameters that can be used in a setPredefinedOffer request.

Table 75    Set PredefinedOffer Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configure.

attributeUpdateInformation

Sub-MO

Optional (0-n)

Update information of the attribute

 

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

 

attributeUpdateAction

String


Enumeration value="ADD"


Enumeration value="DELETE"


Enumeration value="CLEAR"


Enumeration value="SET"

Mandatory

The requested action for an attribute.


ADD : Add an entry to the set (for attributes storing a set of values).


DELETE : Delete an entry from the set (for attributes storing a set of values).


CLEAR :Clear all entries from the set (for attributes storing a set of values) or removes the value for a single value attribute.


SET :Sets the value for a single value attribute. Previous value, if existing, will be overwritten.

 

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

 

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

 

attributeValueDecimal

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueNumber

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

numberOfDecimals

Sub-MO

Optional (0-1)

Information about a decimal value.

 

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute

treeParameterSetUpdateInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names.

 

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

 

treeParameterUpdateInformation

Sub-MO

Optional (0-n)

Contains information about the changes made to a treeParameter.

   

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Mandatory

Contains the name of the tree parameter.

   

treeParameterUpdateAction

String


Enumeration value="ADD"


Enumeration value="DELETE"


Enumeration value="CLEAR"


Enumeration value="SET"

Mandatory

Contains the requested action for a tree parameter.


ADD: Adds an entry to the set (for tree parameters storing a set of values).


DELETE: Deletes an entry from the set (for tree parameters storing a set of values).


CLEAR: Clears all entries from the set (for tree parameters storing a set of values) or removes the value for a single value tree parameter.


SET: Sets the value for a single value tree parameter. Previous value, if existing, will be overwritten.

   

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

   

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

   

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

   

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

   

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

     

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

     

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

   

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

   

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

     

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

     

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

     

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

     

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

     

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

     

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

     

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

24.2   Response Data

24.2.1   Parameters

MOId

Table 76    Set PredefinedOffer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 77 covers the parameters that can be used in a setPredefinedOffer response.

Table 77    Set PredefinedOffer Response

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate the default "operator" or the configured OriginOperatorId value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic configuration.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicates the available capabilities on the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

 

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

 

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

 

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

 

attributeValueDecimal

 

Optional (0-1)

Information about a decimal value.

   

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

   

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

 

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute

 

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

 

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

 

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about the changes made to a treeParameter.

   

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

   

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

   

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

   

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

     

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

   

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

   

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

     

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

     

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

     

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

     

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

     

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

     

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

     

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

   

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

     

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

     

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

   

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

   

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

24.3   Examples

This section gives an example of the setPredefinedOffer request and response message. This example shows how to set an AIR PredefinedOffer.

Request Example

Example 112   Set PredefinedOffer Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/">
  <soapenv:Header>
    <cai3:SessionId>86e7024622bd4af8bbd57a716dd72cbc</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Set>
      <cai3:MOType>PredefinedOffer@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
      <cai3:MOId>
        <air:subscriberNumber>55897213</air:subscriberNumber>
        <air:offerID>513</air:offerID>
      </cai3:MOId>
      <cai3:MOAttributes>
        <air:setPredefinedOffer offerID="513" subscriberNumber="55897213">
          <air:originNodeType>ADM</air:originNodeType>
          <air:originHostName>AIR</air:originHostName>
          <air:originTransactionID>14428155633403480337</air:originTransactionID>
          <air:originTimeStamp>2017-10-08T12:00:00+00:00</air:originTimeStamp>
          <air:originOperatorID>egumeng</air:originOperatorID>
          <air:attributeUpdateInformation>
            <air:attributeName>LOS</air:attributeName>
            <air:attributeUpdateAction>ADD</air:attributeUpdateAction>
            <air:attributeValueString>VauleParameter1</air:attributeValueString>
          </air:attributeUpdateInformation>
          <air:attributeUpdateInformation>
            <air:attributeName>TemplateVersion</air:attributeName>
            <air:attributeUpdateAction>SET</air:attributeUpdateAction>
            <air:attributeValueString>ChangeDefault</air:attributeValueString>
          </air:attributeUpdateInformation>
          <air:attributeUpdateInformation>
            <air:attributeName>parent_offer</air:attributeName>
            <air:attributeUpdateAction>SET</air:attributeUpdateAction>
            <air:attributeValueInteger>1009</air:attributeValueInteger>
          </air:attributeUpdateInformation>
          <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
          <air:negotiatedCapabilities>16296</air:negotiatedCapabilities>
        </air:setPredefinedOffer>
      </cai3:MOAttributes>
    </cai3:Set>
  </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 113   Set PredefinedOffer Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
  <S:Header>
    <cai3g:SessionId>86e7024622bd4af8bbd57a716dd72cbc</cai3g:SessionId>
  </S:Header>
  <S:Body>
    <SetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
      <MOAttributes>
        <air:setPredefinedOfferResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
          <air:subscriberNumber>55897213</air:subscriberNumber>
          <air:originTransactionID>14428155633403480337</air:originTransactionID>
          <air:originOperatorID>egumeng</air:originOperatorID>
          <air:offerID>513</air:offerID>
          <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
          <air:negotiatedCapabilities>16296</air:negotiatedCapabilities>
          <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
          <air:availableServerCapabilities>16296</air:availableServerCapabilities>
          <air:attributeInformation>
            <air:attributeName>LOS</air:attributeName>
            <air:attributeValueString>VauleParameter1</air:attributeValueString>
          </air:attributeInformation>
          <air:attributeInformation>
            <air:attributeName>TemplateVersion</air:attributeName>
            <air:attributeValueString>ChangeDefault</air:attributeValueString>
          </air:attributeInformation>
          <air:attributeInformation>
            <air:attributeName>parent_offer</air:attributeName>
            <air:attributeValueInteger>1009</air:attributeValueInteger>
          </air:attributeInformation>
          <air:treeParameterSetInformation>
            <air:serviceProvider>3</air:serviceProvider>
            <air:treeParameterInformation>
              <air:treeParameterName>OfferType</air:treeParameterName>
              <air:treeParameterValueString>Sunday</air:treeParameterValueString>
            </air:treeParameterInformation>
          </air:treeParameterSetInformation>
          <air:treeParameterSetInformation>
            <air:serviceProvider>4</air:serviceProvider>
            <air:treeParameterInformation>
              <air:treeParameterName>Offer_fee_once</air:treeParameterName>
              <air:treeParameterValueDecimal>
                <air:treeParameterValueNumber>41</air:treeParameterValueNumber>
                <air:numberOfDecimals>1</air:numberOfDecimals>
              </air:treeParameterValueDecimal>
            </air:treeParameterInformation>
            <air:treeParameterInformation>
              <air:treeParameterName>Offer_fee</air:treeParameterName>
              <air:treeParameterValueInteger>1009</air:treeParameterValueInteger>
            </air:treeParameterInformation>
          </air:treeParameterSetInformation>
          <air:productOfferingName>Test_EDA</air:productOfferingName>
        </air:setPredefinedOfferResponse>
      </MOAttributes>
    </SetResponse>
  </S:Body>

25   Get PredefinedOffer

This section covers the AIR command getPredefinedOffer .

MOType

PredefinedOffer@http://schemas.ericsson.com/ma/CS/AIR/

25.1   Request Data

25.1.1   Parameters

MOId

Table 78    Get PredefinedOffer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

MOAttributes

Table 79 covers the parameters that can be used in a getPredefinedOffer request.

Table 79    Get PredefinedOffer Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Mandatory

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Mandatory

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Mandatory

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

offerSelection

Sub-MO

Optional (0-n)

Used to define offer identifiers to retrieve.

 

offerIDFirst

Integer, 1 - 2147483647

Mandatory

The identity of the first offer in a sequence of offers, or the only offer identity if a single offer shall be obtained.

 

offerIDLast

Integer, 1 - 2147483647

Optional (0-1)

The identity of the last offer in a sequence of offers, or the only offer identity if a single offer shall be obtained.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

25.2   Response Data

25.2.1   Parameters

MOAttributes

Table 80 covers the parameters that can be used in a getPredefinedOffer response.

Table 80    Get PredefinedOffer Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Mandatory

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

predefinedOfferValuesInformation

Sub-MO

Optional (0-n)

Contains all predefined offer values assigned to each offer.

 

offerID

Integer, 0 - 2147483647

Optional (0-1)

The identity of an offer.

 

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

   

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

   

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Optional (0-1)

The string value of an attribute.

   

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date value of an attribute.


DateMin to DateMax or DateInfinite

   

attributeValueDecimal

 

Optional (0-1)

Information about a decimal value.

     

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

     

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute

   

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

 

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

   

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

   

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about the changes made to a treeParameter.

     

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

     

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

     

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

     

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

       

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

       

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

     

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

     

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

       

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

       

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

       

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

       

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

       

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

       

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

       

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

       

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

     

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

treeParameterValueDateRange

 

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

       

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

       

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

     

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

     

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

     

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

 

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

25.3   Examples

This section gives an example of the getPredefinedOffer request and response message. This example shows how to get an AIR PredefinedOffer.

Request Example

Example 114   Get PredefinedOffer Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/">
  <soapenv:Header>
    <cai3:SessionId>86e7024622bd4af8bbd57a716dd72cbc</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Get>
      <cai3:MOType>PredefinedOffer@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
      <cai3:MOId>
        <air:subscriberNumber>55897213</air:subscriberNumber>
      </cai3:MOId>
      <cai3:MOAttributes>
        <air:getPredefinedOffer subscriberNumber="55897213">
          <air:originNodeType>ADM</air:originNodeType>
          <air:originHostName>AIR</air:originHostName>
          <air:originTransactionID>14428155633403480337</air:originTransactionID>
          <air:originTimeStamp>2017-10-08T12:00:00+00:00</air:originTimeStamp>
          <air:offerSelection>
            <air:offerIDFirst>513</air:offerIDFirst>
            <air:offerIDLast>514</air:offerIDLast>
          </air:offerSelection>
          <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
          <air:negotiatedCapabilities>16296</air:negotiatedCapabilities>
        </air:getPredefinedOffer>
      </cai3:MOAttributes>
    </cai3:Get>
  </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 115   Get PredefinedOffer Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
  <S:Header>
    <cai3g:SessionId>86e7024622bd4af8bbd57a716dd72cbc</cai3g:SessionId>
  </S:Header>
  <S:Body>
    <GetResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
      <MOAttributes>
        <air:getPredefinedOfferResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
          <air:subscriberNumber>55897213</air:subscriberNumber>
          <air:originTransactionID>14428155633403480337</air:originTransactionID>
          <air:predefinedOfferValuesInformation>
            <air:offerID>513</air:offerID>
            <air:treeParameterSetInformation>
              <air:serviceProvider>3</air:serviceProvider>
              <air:treeParameterInformation>
                <air:treeParameterName>OfferType</air:treeParameterName>
                <air:treeParameterValueString>Sunday</air:treeParameterValueString>
              </air:treeParameterInformation>
            </air:treeParameterSetInformation>
            <air:treeParameterSetInformation>
              <air:serviceProvider>4</air:serviceProvider>
              <air:treeParameterInformation>
                <air:treeParameterName>Offer_fee_once</air:treeParameterName>
                <air:treeParameterValueDecimal>
                  <air:treeParameterValueNumber>41</air:treeParameterValueNumber>
                  <air:numberOfDecimals>1</air:numberOfDecimals>
                </air:treeParameterValueDecimal>
              </air:treeParameterInformation>
              <air:treeParameterInformation>
                <air:treeParameterName>Offer_fee</air:treeParameterName>
                <air:treeParameterValueInteger>1009</air:treeParameterValueInteger>
              </air:treeParameterInformation>
            </air:treeParameterSetInformation>
            <air:productOfferingName>Test_EDA</air:productOfferingName>
          </air:predefinedOfferValuesInformation>
          <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
          <air:negotiatedCapabilities>16296</air:negotiatedCapabilities>
          <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
          <air:availableServerCapabilities>16296</air:availableServerCapabilities>
        </air:getPredefinedOfferResponse>
      </MOAttributes>
    </GetResponse>
  </S:Body>
</S:Envelope>

26   Delete PredefinedOffer

This section covers the AIR command deletePredefinedOffer .

MOType

PredefinedOffer@http://schemas.ericsson.com/ma/CS/AIR/

26.1   Request Data

26.1.1   Parameters

MOId

Table 81    Delete PredefinedOffer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

MOAttributes

Table 82 covers the parameters that can be used in a deletePredefinedOffer request.

Table 82    Delete PredefinedOffer Parameters

Parameter

Type

Occurrence

Description

originNodeType

String


Enumeration value="EXT"


Enumeration value="AIR"


Enumeration value="ADM"


Enumeration value="UGW"


Enumeration value="IVR"


Enumeration value="OGW"


Enumeration value="SDP"

Optional (0-1)

The parameter contains the origin node type that is set by AIR or provided by an external network element. It contains the type of the logical node from where the operation originated. External network elements are not allowed to use the reserved names on network element types, (except EXT).


Network Element Type:


EXT:External system


AIR:Account information and refill


ADM:Administrative system


UGW: USSD gateway


IVR :Interactive voice response system


OGW: On-line gateway


SDP: Service data point


If this parameter is absent from the request, Dynamic Activation will generate “ADM” as the parameter to NEs.

originHostName

String,1 - 255 characters

Optional (0-1)

The identifier string for the host where the operation originated from. The host name shall be unique within the network for a given network element type.


If this parameter is absent from the request, Dynamic Activation will generate a node name, which the character "-" replaced by "" as the parameter to NEs.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits


Each digit is 0-9

Optional (0-1)

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originTimeStamp

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

The date and time of sending the request by the entity that initiated the operation.


If this parameter is absent from the request, Dynamic Activation will generate system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

subscriberNumberNAI

Integer, 0 - 2


0 = National number (with prefix)


1 = International number


2 = National significant number (without prefix)

Optional (0-1)

The Nature of Address Indicator identifies the format of the subscriberNumber parameter.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

negotiatedCapabilities

Integer, 0 - 2147483647

Mandatory

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

26.2   Response Data

26.2.1   Parameters

MOId

Table 83    Delete PredefinedOffer MOId

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

MOAttributes

Table 84 covers the parameters that can be used in a deletePredefinedOffer response.

Table 84    Delete PredefinedOffer Parameters

Parameter

Type

Occurrence

Description

subscriberNumber

String, 1 - 28 digits

Mandatory

The subscriber identity of the subscriber related to the operation. The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes. If another format is used then it must be indicated by subscriberNumberNAI parameter.

originTransactionID

String, 0 - 9999 9999 9999 9999 9999 digits

Mandatory

Reference to a single operation, generated by the system it was initiated from.


The value in this parameter must be unique per operation and can be a sequence number. For example, an operation in this case is a refill.

originOperatorID

String, 1 - 255 characters

Optional (0-1)

The identity of the system user or the session from where the operation was initiated. It might be used for security management or logging purposes for an example.


If this parameter is absent from the request, Dynamic Activation will generate PGN system time plus the default "+0100" or the configured ChargingTimeZone value in Activation Logic as the parameter to NEs. Refer to User Guide for Resource Activation, Reference [4] for details of Activation Logic

offerID

Integer, 0 - 2147483647

Mandatory

The identity of an offer.

attributeInformation

Sub-MO

Optional (0-n)

Contains information about attributes.


It will be returned as response to GetAccountDetails, GetBalanceAndDate, GetOffers and Refill if requested with requestAttributesFlag and if any attributes exist that have a value. attributeInformation will also be included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, attributeInformation will include all attributes that have values.

 

attributeName

String, 1 - 128 characters

Mandatory

The name of the attribute.

 

attributeValueString

String, 1 - 128 extended characters


Extended characters which allows all US-ASCII values from 32 to 126 (hexadecimal 0x20 to 0x7e).

Mandatory

The string value of an attribute.

 

attributeValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm For example, 2005-11- 24T23:59:59+08:00

Mandatory

The date value of an attribute.


DateMin to DateMax or DateInfinite

 

attributeValueDecimal

Sub-MO

Mandatory

Information about a decimal value.

   

attributeValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

The parameter contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number.


There is no decimal sign included in this parameter.

   

numberOfDecimals

Integer, 0 - 15

Mandatory

The parameter forms together with attributeValue Number a decimal number.


The parameter contains information about where to put the decimal sign counted in positions from the right.

 

attributeValueInteger

Integer, -2147483648 to 2147483647

Optional (0-1)

Contains the integer value of an attribute

 

attributeSource

Integer, 1 - 255


1 = Default value from definition


2 - 255 = Reserved for future use

Optional (0-1)

Contain the source from where the attribute is fetched.


Default (parameter is not included) means the attribute is stored on the entity provisioned for a subscriber.

treeParameterSetInformation

Sub-MO

Optional (0-n)

Contains information about treeParameterSets divided per tree names


It is returned as response to GetAccountDetails, GetBalanceAndDate and GetOffers if requested with requestTreeParameterSetsFlag and if any attributes exist that have a value.


It is also included as response to DeleteOffer and DeleteSubscriber if any attributes is removed. For UpdateOffer reponse, it includes all attributes that have values.

 

serviceProvider

Integer, 1 - 6


1: Rating template


2: Policy rulfe determination template


3: Product notification template


4: Product fee template


5: Product provision template


6: Quota determination template

Optional (0-1)

Contains the service provider which is the type of treeParameter.

 

treeParameterInformation

Sub-MO

Optional (0-n)

Contains information about the changes made to a treeParameter.

   

treeParameterName

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the name of the tree parameter.

   

treeParameterValueString

String,1 - 128 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash).

Optional (0-1)

Contains the string value of a tree parameter.

   

treeParameterValueDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Optional (0-1)

Contains the date value of a tree parameter.

   

treeParameterValueDecimal

Sub-MO

Optional (0-n)

Contains information about a decimal value. It is enclosed in a <struct> of its own. The structure contains one parameter treeParameterValueNumber containing the significant digits and a numberOfDecimals part telling how many decimals are used.

     

treeParameterValueNumber

String, -999 999 999 999 999 to 999 999 999 999 999 SignedNumeric

Mandatory

Contains up to 15 significant digits that together with the numberOfDecimals parameter forms a decimal number. There is no decimal sign included in this parameter.

     

numberOfDecimals

Integer, 0 - 15

Mandatory

Contains information about where to put the decimal sign counted in positions from the right and forms together with attributeValueNumber a decimal number.

   

treeParameterValueInteger

String, -9223372036854775807 to 9223372036854775807 SignedNumeric

Optional (0-1)

Contains the integer value of a tree parameter

   

treeParameterValueSchedule

 

Optional (0-1)

Contains values for a schedule event.

     

scheduledFrequency

Integer, 1 - 7

Mandatory

Contains the frequency of the schedule (monthly, weekly, daily etc).


1: Yearly


2: Monthly


3: Weekly


4: Daily


5: Hourly


6: Minutely


7: Secondly

     

scheduledInterval

Integer, 1 - 99999

Optional (0-1)

Contains the interval of the schedule (For example every week, every second, every month, etc.).

     

scheduledMonth

Integer, 1 - 12

Optional (0-n)

Contains the number of month for the schedule.

     

scheduledDayOfMonth

Integer, -1 - 31

Optional (0-n)

Contains the number of the days of month for the schedule.


Value -1 means last day of month.

     

scheduledDayOfWeek

Integer, 1 - 7

Optional (0-n)

Contains the week day for the schedule.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

     

scheduledHour

Integer, 0 - 23

Optional (0-1)

Contains the time (hour) for the schedule.

     

scheduledMinute

Integer, 0 - 59

Optional (0-1)

Contains the time (minute) for the schedule.

     

scheduledSecond

Integer, 0 - 59

Optional (0-1)

Contains the time (second) for the schedule.

   

treeParameterValueDayOfWeek

Integer, 0 - 7

Optional (0-1)

Contains the value of day of week of a tree parameter.


1: Monday


2: Tuesday


3: Wednesday


4: Thursday


5: Friday


6: Saturday


7: Sunday

   

treeParameterValueDateRange

Sub-MO

Optional (0-1)

The struct is used to define the range of dates valid for a tree parameter. It contains two dates in a sequence to specify the range needed for tree parameter.

     

treeParameterStartDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the initial date of range applied for a tree parameter.

     

treeParameterEndDate

DateTime.iso8601: YYYY-MM-DDT hh:mm:ssTZ


TZ is the deviation in hours from UTC, the format is: [+|-] hh:mm


For example, 2005-11- 24T23:59:59+08:00

Mandatory

Contains the final date of range applied for a tree parameter.

   

treeParameterValueTime

String,1 - 8 characters


Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-1)

Contains the value of time applied for a tree parameter.

   

treeParameterSource

Integer, 1 - 2


1: Tree parameter value fetched from the offer definition


2: Tree parameter fetched from the template tree definition

Optional (0-1)

Contains the source where the tree parameter is fetched. Default (parameter is not included) means the tree parameter is stored on the entity provisioned for a subscriber.

   

associatedPartyID

String, 1 - 28 digits

Optional (0-1)

The subscriber identity of the consumer or provider.


The default format of the parameter is the same numbering format as used by the account database, this also includes support of leading zeroes.

productOfferingName

String,1 - 128 characters Allowed characters are a-z. A-Z, 0-9, - (hyphen) and / (slash)

Optional (0-n)

Contains the identity of a product offering.

negotiatedCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the negotiated capabilities between the client and server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active.

availableServerCapabilities

Integer, 0 - 2147483647

Optional (0-n)

Indicate the available capabilities at the server node.


The value 0 indicates that none of the capabilities in the element are active, and the value 2147483647 indicates that all of the capabilities in the element are active. If only one element is present and is set to 0, no functions after release AIR-IP 5.0 are active, only legacy functionality can be used.

26.3   Examples

This section gives an example of the deletePredefinedOffer request and response message. This example shows how to delete an AIR PredefinedOffer.

Request Example

Example 116   Delete PredefinedOffer Request Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/">
  <soapenv:Header>
    <cai3:SessionId>86e7024622bd4af8bbd57a716dd72cbc</cai3:SessionId>
  </soapenv:Header>
  <soapenv:Body>
    <cai3:Delete>
      <cai3:MOType>PredefinedOffer@http://schemas.ericsson.com/ma/CS/AIR/</cai3:MOType>
      <cai3:MOId>
        <air:subscriberNumber>55897213</air:subscriberNumber>
        <air:offerID>513</air:offerID>
      </cai3:MOId>
      <cai3:MOAttributes>
        <air:deletePredefinedOffer offerID="513" subscriberNumber="55897213">
          <air:originNodeType>ADM</air:originNodeType>
          <air:originHostName>AIR</air:originHostName>
          <air:originTransactionID>14428155633403480337</air:originTransactionID>
          <air:originTimeStamp>2017-10-08T12:00:00+00:00</air:originTimeStamp>
          <air:originOperatorID>egumeng</air:originOperatorID>
          <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
          <air:negotiatedCapabilities>16296</air:negotiatedCapabilities>
        </air:deletePredefinedOffer>
      </cai3:MOAttributes>
    </cai3:Delete>
  </soapenv:Body>
</soapenv:Envelope>

Response Example

Example 117   Delete PredefinedOffer Response Message

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"
 xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
  <S:Header>
    <cai3g:SessionId>86e7024622bd4af8bbd57a716dd72cbc</cai3g:SessionId>
  </S:Header>
  <S:Body>
    <DeleteResponse xmlns="http://schemas.ericsson.com/cai3g1.2/">
      <MOId>
        <air:subscriberNumber xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">55897213
        </air:subscriberNumber>
        <air:offerID xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/"
 xmlns:cai3="http://schemas.ericsson.com/cai3g1.2/"
 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">513</air:offerID>
      </MOId>
      <MOAttributes>
        <air:deletePredefinedOfferResponse xmlns:air="http://schemas.ericsson.com/ma/CS/AIR/">
          <air:subscriberNumber>55897213</air:subscriberNumber>
          <air:originTransactionID>14428155633403480337</air:originTransactionID>
          <air:originOperatorID>egumeng</air:originOperatorID>
          <air:offerID>513</air:offerID>
          <air:attributeInformation>
            <air:attributeName>LOS</air:attributeName>
            <air:attributeValueString>VauleParameter1</air:attributeValueString>
          </air:attributeInformation>
          <air:attributeInformation>
            <air:attributeName>TemplateVersion</air:attributeName>
            <air:attributeValueString>ChangeDefault</air:attributeValueString>
          </air:attributeInformation>
          <air:attributeInformation>
            <air:attributeName>parent_offer</air:attributeName>
            <air:attributeValueInteger>1009</air:attributeValueInteger>
          </air:attributeInformation>
          <air:treeParameterSetInformation>
            <air:serviceProvider>3</air:serviceProvider>
            <air:treeParameterInformation>
              <air:treeParameterName>OfferType</air:treeParameterName>
              <air:treeParameterValueString>Sunday</air:treeParameterValueString>
            </air:treeParameterInformation>
          </air:treeParameterSetInformation>
          <air:treeParameterSetInformation>
            <air:serviceProvider>4</air:serviceProvider>
            <air:treeParameterInformation>
              <air:treeParameterName>Offer_fee_once</air:treeParameterName>
              <air:treeParameterValueDecimal>
                <air:treeParameterValueNumber>41</air:treeParameterValueNumber>
                <air:numberOfDecimals>1</air:numberOfDecimals>
              </air:treeParameterValueDecimal>
            </air:treeParameterInformation>
            <air:treeParameterInformation>
              <air:treeParameterName>Offer_fee</air:treeParameterName>
              <air:treeParameterValueInteger>1009</air:treeParameterValueInteger>
            </air:treeParameterInformation>
          </air:treeParameterSetInformation>
          <air:productOfferingName>Test_EDA</air:productOfferingName>
          <air:negotiatedCapabilities>809988676</air:negotiatedCapabilities>
          <air:negotiatedCapabilities>16296</air:negotiatedCapabilities>
          <air:availableServerCapabilities>809988676</air:availableServerCapabilities>
          <air:availableServerCapabilities>16296</air:availableServerCapabilities>
        </air:deletePredefinedOfferResponse>
      </MOAttributes>
    </DeleteResponse>
  </S:Body>
</S:Envelope>

27   Faults and Errors

The generic structure for fault responses is covered in Generic CAI3G Interface 1.2, Reference [2]. That document also covers the generic fault codes, which are applicable to all CAI3G operations.

This section covers the subordinate CAI3G errors. They can appear in the errorcode element in the error message.

AIR and AF specific error codes are described in this section. These error codes are included in the Fault type PGFault.

For generic error codes, and information about the different Fault types, see CAI3G Implementation, Reference [3].

27.1   AIR Error Codes

The following table covers error codes for AIR commands over the CAI3G interface.

Table 85    AIR Error Codes

Error Code

Error Message

Mapped from

17100

Illegal request message

1000

17101

Mandatory field missing

1001

17102

Illegal data type

1002

17103

Data out of bounds

1003

17104

Unknown operation

1004

17105

Internal server error

1005

17107

Overload rejection

1007

17111

OK but supervision period exceeded

1

17112

OK but Service Fee period exceeded

2

17199

Other Error No Retry

999

17200

Other Error

100

17202

Subscriber not found

102

17203

Account barred from refill

103

17204

Temporary Blocked

104

17205

Dedicated account not allowed

105

17206

Dedicated account negative

106

17207

Voucher status used by same

107

17208

Voucher status used by different

108

17209

Voucher status unavailable

109

17210

Voucher status expired

110

17211

Voucher status stolen or missing

111

17212

Voucher status damaged

112

17213

Voucher status pending

113

17214

Voucher type not accepted

114

17215

Refill not accepted

115

17217

Service class change not allowed

117

17219

Invalid voucher activation code

119

17220

Invalid refill profile

120

17221

Supervision period too long

121

17222

Service fee period too long

122

17223

Maximum credit limit exceeded

123

17224

Below minimum balance

124

17226

Account not active

126

17227

Accumulator not available

127

17228

Invalid PIN Code

128

17229

FAF number does not exist

129

17230

FAF number not allowed

130

17233

Service class list empty

133

17234

Accumulator overflow

134

17235

Accumulator underflow

135

17236

Date adjustment error

136

17237

Get balance and date not allowed

137

17238

No PIN Code registered

138

17239

Dedicated account not defined

139

17240

Invalid old Service Class

140

17241

Invalid Language

141

17242

Subscriber already installed

142

17243

Invalid master subscriber

143

17244

Subscriber already activated

144

17245

Already linked subordinate

145

17246

Already linked as master

146

17247

Invalid old community list

147

17248

Invalid new community list

148

17249

Invalid promotion plan end date

149

17250

Invalid promotion plan id

150

17251

Promotion plan not found

151

17252

Deblocking of expired account

152

17253

Dedicated account max credit limit exceeded

153

17254

Invalid old SC date

154

17255

Invalid new service class

155

17256

Delete subscriber failed

156

17257

Invalid account home region

157

17258

Maximum number of allocated promotion plans that is already reached

158

17259

Charged FaF not active for service class

159

17260

Operation not allowed from current location

160

17261

Failed to get location information

161

17265

Offer not found

165

17267

Invalid unit type

167

17290

The PAM service id provided in the request exists.

190

17291

The PAM service id provided in the request was out of range, or did not exist.

191

17292

The old PAM class id provided in the request was incorrect or did not match the existing PAM class id for the account.

192

17293

The PAM class id or new PAM class id provided in the request was incorrect.

193

17294

The old schedule id provided in the request was incorrect or did not match the existing schedule id for the account.

194

17295

The schedule id or new schedule id provided in the request was incorrect.

195

17296

Invalid deferred to date

196

17297

Periodic account management evaluation failed

197

17298

Too many PAM services given in the sequence or the number of services on the account would be exceeded.

198

17299

The PAM period, provided or calculated, could not be found in the schedule.

199

17300

The PAM class id or new PAM class id provided in the request does not exist.

200

17301

The schedule id or new schedule id provided in the request did not exist or no valid period found.

201

17302

Invalid PAM indicator

202

17314

One or several of the provided offers are not defined or there is a mismatch between provided offer type and the offer type definition. It is also used when the offer type is not supported for the requested update.

214

17315

Too many offers of the type Multi User Identification given in the sequence or the Multi User Identification offer is already activated for the subscriber.

215

17316

Use threshold not found in definition

216

17317

Use counter not found in definition

217

17319

Use counter value out of bounds

219

17320

The supplied value type does not match the definition.

220

17321

No subordinate subscribers connected to the account

221

17325

The offer start date cannot be changed because the offer is already active.

225

17326

Invalid PAM Period Relative Dates Start PAM Period Indicator

226

17327

Invalid PAM Period Relative Dates Expiry PAM Period Indicator

227

17330

Not allowed to convert to other type of lifetime

230

17332

Not allowed to delete PAM service ID in use. The PAM Service ID is used by an Offer, DA, or sub-DAs Relative Dates.

232

17337

Not allowed to add a Provider ID to another offer type than the provider account offer.

237

17338

Not allowed to create a provider account offer without providing a provider ID.

238

17333

Invalid PAM service priority

233

17334

The old PAM service priority provided in the request was incorrect or did not match the existing PAM service priority for the account.

234

17335

Not allowed to connect the PAM class to the PAM Service. The account already has a bill cycle service. Only one bill cycle per account is allowed.

235

17336

The PAM service priority is already used for some other PAM services.

236

17347

The product is not found.

247

17348

The shared account offer is not allowed on a subordinate subscriber.

248

17350

The communication ID change fails because of insufficient funds.

250

17351

The communication ID change fails. The AIA does not match the MSISDN.

251

17352

Invalid combination of values

252

17353

The communication ID change fails. The previous MSISDN change is pending.

253

17354

The Communication ID change fails. The new MSISDN is not available.

254

17355

The operation is not allowed on a subordinate subscriber.

255

17356

Attribute name does not exist.

256

17357

Operation not allowed since End of Provisioning is set.

257

17358

Attribute value does not exist.

258

17359

Attribute value exists.

259

17362

Attribute update action not allowed for this attribute.

262

17363

Attribute value is not possible to override for the subscriber.

263

17364

The result of the operation is a nominal value that is out of bounds.

264

17366

Permission denied

266

17388

Tree parameter name does not exist

288

17389

Tree parameter value has wrong format

289

17390

Service provider (= tree type) does not exist

290

17397

Maximum limit of offers exceeded during Installation of subscriber

297

17398

Failure to Delete Subscriber, that had been successfully installed, but should be deleted due to failure of offers

298

17399

Failure to Install Subscriber

299

17344

Associated party ID not allowed for this type of entity

244

17335

Not allowed to connect the PAM Class to the PAM Service. The account already has a bill cycle service. Only one bill cycle and one related cycle PAM service per account is allowed

235

17501

Unauthorized

401

27.2   AF Error Codes

The following table covers error codes for AF commands over the CAI3G interface.

Table 86    AF Error Codes

Error Code

Error Message

Mapped from

17051

Format error

1

17052

Name server internal failure.

2

17053

The domain name does not exist.

3

17054

Not supported by the name server.

4

17055

Refused

5

17056

Name exists when it should not.

6

17057

RR set exists when it should not.

7

17058

RR set that should exist does not.

8

17059

Not authoritative

9

17060

Name is not contained in zone.

10

27.3   CAI3G Error Message Example

The following is an example of a CAI3G error message:

Example 118   CAI3G Error Message for AIR

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>0418dc80b9f149a2b05f6bc8052ffedf</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <ns2:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
         <faultcode>ns2:Server</faultcode>
         <faultstring>This is a server fault</faultstring>
         <detail>
            <Cai3gFault:Cai3gFault xmlns="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:Cai3gFault="http://schemas.ericsson.com/cai3g1.2/">
               <faultcode>4006</faultcode>
               <faultreason>
                  <reasonText>External error.</reasonText>
               </faultreason>
               <faultrole>MF</faultrole>
               <details>
                  <PGFault:PGFault xmlns="http://schemas.ericsson.com/pg/1.0" 
xmlns:PGFault="http://schemas.ericsson.com/pg/1.0">
                     <errorcode>17242</errorcode>
                     <errormessage>Subscriber already installed.</errormessage>
                     <errordetails>External error. Error occurred when provisioning AIR. 
                        - [Processed by PG Node: node1]</errordetails>
                  </PGFault:PGFault>
               </details>
            </Cai3gFault:Cai3gFault>
         </detail>
      </ns2:Fault>
   </S:Body>
</S:Envelope>

Example 119   CAI3G Error Message for AF

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:cai3g="http://schemas.ericsson.com/cai3g1.2/">
   <S:Header>
      <cai3g:SessionId>a4d8cbfcab6d4605b2afb66092025b91</cai3g:SessionId>
   </S:Header>
   <S:Body>
      <ns2:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
         <faultcode>ns2:Server</faultcode>
         <faultstring>This is a server fault</faultstring>
         <detail>
            <Cai3gFault:Cai3gFault xmlns="http://schemas.ericsson.com/cai3g1.2/" 
xmlns:Cai3gFault="http://schemas.ericsson.com/cai3g1.2/">
               <faultcode>4006</faultcode>
               <faultreason>
                  <reasonText>External error.</reasonText>
               </faultreason>
               <faultrole>MF</faultrole>
               <details>
                  <PGFault:PGFault xmlns="http://schemas.ericsson.com/pg/1.0" 
xmlns:PGFault="http://schemas.ericsson.com/pg/1.0">
                     <errorcode>17056</errorcode>
                     <errormessage>Name Exists when it should not.</errormessage>
                     <errordetails>External error. Error occurred when provisioning AF. 
                         - [Processed by PG Node: node1]</errordetails>
                  </PGFault:PGFault>
               </details>
            </Cai3gFault:Cai3gFault>
         </detail>
      </ns2:Fault>
   </S:Body>
</S:Envelope>

Reference List

[1] Library Overview, 18/1553-CSH 109 628 Uen
[2] Generic CAI3G Interface 1.2, 2/155 19-FAY 302 0003 Uen
[3] CAI3G Implementation, 26/155 19-CSH 109 628 Uen
[4] User Guide for Resource Activation, 1/1553-CSH 109 628 Uen
[5] Solution Description Charging and CBiO, 1/221 02-CSH 109 628 Uen


Copyright

© Ericsson AB 2017. All rights reserved. No part of this document may be reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to continued progress in methodology, design and manufacturing. Ericsson shall have no liability for any error or damage of any kind resulting from the use of this document.

Trademark List
All trademarks mentioned herein are the property of their respective owners. These are shown in the document Trademark Information.

    Charging Provisioning over CAI3G         Ericsson Dynamic Activation 1