5780 DSC API Reference Manual

API REFERENCE MANUAL
Alcatel-Lucent 5780
DYNAMIC SERVICES CONTROLLER | RELEASE 5.1
API REFERENCE MANUAL
Alcatel-Lucent Proprietary
This document contains proprietary information of Alcatel-Lucent and is not to be disclosed
or used except in accordance with applicable agreements.
Copyright 2012-2013 © Alcatel-Lucent. All rights reserved.
Alcatel-Lucent assumes no responsibility for the accuracy of the information presented, which is
subject to change without notice.
Alcatel, Lucent, Alcatel-Lucent, the Alcatel-Lucent logo, and TiMetra are registered trademarks of
Alcatel-Lucent. All other trademarks are the property of their respective owners.
Copyright 2012-2013 Alcatel-Lucent.

All rights reserved.
Disclaimers
Alcatel-Lucent products are intended for commercial uses. Without the appropriate network design
engineering, they must not be sold, licensed or otherwise distributed for use in any hazardous
environments requiring fail-safe performance, such as in the operation of nuclear facilities, aircraft
navigation or communication systems, air traffic control, direct life-support machines, or weapons
systems, in which the failure of products could lead directly to death, personal injury, or severe physical
or environmental damage. The customer hereby agrees that the use, sale, license or other distribution
of the products for any such application without the prior written consent of Alcatel-Lucent, shall be at
the customer's sole risk. The customer hereby agrees to defend and hold Alcatel-Lucent harmless from
any claims for loss, cost, damage, expense or liability that may arise out of or in connection with the
use, sale, license or other distribution of the products in such applications.
This document may contain information regarding the use and installation of non-Alcatel-Lucent
products. Please note that this information is provided as a courtesy to assist you. While Alcatel-Lucent
tries to ensure that this information accurately reflects information provided by the supplier, please refer
to the materials provided with any non-Alcatel-Lucent product and contact the supplier for
confirmation. Alcatel-Lucent assumes no responsibility or liability for incorrect or incomplete
information provided about non-Alcatel-Lucent products.
However, this does not constitute a representation or warranty. The warranties provided for
Alcatel-Lucent products, if any, are set forth in contractual documentation entered into by
Alcatel-Lucent and its customers.
This document was originally written in English. If there is any conflict or inconsistency between the
English version and any other version of a document, the English version shall prevail.
When printed by Alcatel-Lucent, this document is printed on recycled paper.

Alcatel-Lucent License Agreement
SAMPLE END USER LICENSE AGREEMENT
1. LICENSE
1.1 Subject to the terms and conditions of this Agreement, Alcatel-Lucent grants
to Customer and Customer accepts a nonexclusive, nontransferable license to
use any software and related documentation provided by Alcatel-Lucent
pursuant to this Agreement ("Licensed Program") for Customer's own internal
use, solely in conjunction with hardware supplied or approved by
Alcatel-Lucent. In case of equipment failure, Customer may use the Licensed
Program on a backup system, but only for such limited time as is required to
rectify the failure.
1.2 Customer acknowledges that Alcatel-Lucent may have encoded within the
Licensed Program optional functionality and capacity (including, but not
limited to, the number of equivalent nodes, delegate workstations, paths and
partitions), which may be increased upon the purchase of the applicable license
extensions.
1.3 Use of the Licensed Program may be subject to the issuance of an application
key, which shall be conveyed to the Customer in the form of a Supplement to
this End User License Agreement. The purchase of a license extension may
require the issuance of a new application key.
2. PROTECTION AND SECURITY OF LICENSED PROGRAMS

2.1 Customer acknowledges and agrees that the Licensed Program contains
proprietary and confidential information of Alcatel-Lucent and its third party
suppliers, and agrees to keep such information confidential. Customer shall
not disclose the Licensed Program except to its employees having a need to
know, and only after they have been advised of its confidential and proprietary
nature and have agreed to protect same.
2.2 All rights, title and interest in and to the Licensed Program, other than those
expressly granted to Customer herein, shall remain vested in Alcatel-Lucent or
its third party suppliers. Customer shall not, and shall prevent others from
copying, translating, modifying, creating derivative works, reverse
engineering, decompiling, encumbering or otherwise using the Licensed
Program except as specifically authorized under this Agreement.
Notwithstanding the foregoing, Customer is authorized to make one copy for
its archival purposes only. All appropriate copyright and other proprietary
notices and legends shall be placed on all Licensed Programs supplied by
Alcatel-Lucent, and Customer shall maintain and reproduce such notices on
any full or partial copies made by it.
3. TERM
3.1 This Agreement shall become effective for each Licensed Program upon
delivery of the Licensed Program to Customer.
iii
3.2 Alcatel-Lucent may terminate this Agreement: (a) upon notice to Customer if
any amount payable to Alcatel-Lucent is not paid within thirty (30) days of the
date on which payment is due; (b) if Customer becomes bankrupt, makes an
assignment for the benefit of its creditors, or if its assets vest or become subject
to the rights of any trustee, receiver or other administrator; (c) if bankruptcy,
reorganization or insolvency proceedings are instituted against Customer and
not dismissed within 15 days; or (d) if Customer breaches a material provision
of this Agreement and such breach is not rectified within 15 days of receipt of
notice of the breach from Alcatel-Lucent.
3.3 Upon termination of this Agreement, Customer shall return or destroy all
copies of the Licensed Program. All obligations of Customer arising prior to
termination, and those obligations relating to confidentiality and nonuse, shall
survive termination.
4. CHARGES
4.1 Upon shipment of the Licensed Program, Alcatel-Lucent will invoice
Customer for all fees, and any taxes, duties and other charges. Customer will
be invoiced for any license extensions upon delivery of the new software
application key or, if a new application key is not required, upon delivery of
the extension. All amounts shall be due and payable within thirty (30) days of
receipt of invoice, and interest will be charged on any overdue amounts at the
rate of 1 1/2% per month (19.6% per annum).
5. SUPPORT AND UPGRADES

5.1 Customer shall receive software support and upgrades for the Licensed
Program only to the extent provided for in the applicable Alcatel-Lucent
software support policy in effect from time to time, and upon payment of any
applicable fees. Unless expressly excluded, this Agreement shall be deemed to
apply to all updates, upgrades, revisions, enhancements and other software
which may be supplied by Alcatel-Lucent to Customer from time to time.
6. WARRANTIES AND INDEMNIFICATION

6.1 Alcatel-Lucent warrants that the Licensed Program as originally delivered to
Customer will function substantially in accordance with the functional
description set out in the associated user documentation for a period of 90 days
from the date of shipment, when used in accordance with the user
documentation. Alcatel-Lucent's sole liability and Customer's sole remedy for
a breach of this warranty shall be Alcatel-Lucent's good faith efforts to rectify
the nonconformity or, if after repeated efforts Alcatel-Lucent is unable to
rectify the nonconformity, Alcatel-Lucent shall accept return of the Licensed
Program and shall refund to Customer all amounts paid in respect thereof. This
warranty is available only once in respect of each Licensed Program, and is not
renewed by the payment of an extension charge or upgrade fee.
iv
6.2 ALCATEL-LUCENT EXPRESSLY DISCLAIMS ALL OTHER
WARRANTIES, REPRESENTATIONS, COVENANTS OR CONDITIONS
OF ANY KIND, WHETHER EXPRESS OR IMPLIED, INCLUDING
WITHOUT LIMITATION, WARRANTIES OR REPRESENTATIONS OF
WORKMANSHIP, MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE, DURABILITY, OR THAT THE OPERATION
OF THE LICENSED PROGRAM WILL BE ERROR FREE OR THAT THE
LICENSED PROGRAMS WILL NOT INFRINGE UPON ANY THIRD
PARTY RIGHTS.
6.3 Alcatel-Lucent shall defend and indemnify Customer in any action to the
extent that it is based on a claim that the Licensed Program furnished by
Alcatel-Lucent infringes any patent, copyright, trade secret or other intellectual
property right, provided that Customer notifies Alcatel-Lucent within ten (10)
days of the existence of the claim, gives Alcatel-Lucent sole control of the
litigation or settlement of the claim, and provides all such assistance as
Alcatel-Lucent may reasonably require. Notwithstanding the foregoing,
Alcatel-Lucent shall have no liability if the claim results from any modification
or unauthorized use of the Licensed Program by Customer, and Customer shall
defend and indemnify Alcatel-Lucent against any such claim.
6.4 Alcatel-Lucent Products are intended for standard commercial uses. Without
the appropriate network design engineering, they must not be sold, licensed or
otherwise distributed for use in any hazardous environments requiring fail safe
performance, such as in the operation of nuclear facilities, aircraft navigation
or communication systems, air traffic control, direct life-support machines, or
weapons systems, in which the failure of products could lead directly to death,
personal injury, or severe physical or environmental damage. The Customer
hereby agrees that the use, sale, license or other distribution of the Products for
any such application without the prior written consent of Alcatel-Lucent, shall
be at the Customer's sole risk. The Customer also agrees to defend and hold
Alcatel-Lucent harmless from any claims for loss, cost, damage, expense or
liability that may arise out of or in connection with the use, sale, license or
other distribution of the Products in such applications.
7. LIMITATION OF LIABILITY
7.1 IN NO EVENT SHALL THE TOTAL COLLECTIVE LIABILITY OF
ALCATEL-LUCENT, ITS EMPLOYEES, DIRECTORS, OFFICERS OR
AGENTS FOR ANY CLAIM, REGARDLESS OF VALUE OR NATURE,
EXCEED THE AMOUNT PAID UNDER THIS AGREEMENT FOR THE
LICENSED PROGRAM THAT IS THE SUBJECT MATTER OF THE
CLAIM. IN NO EVENT SHALL THE TOTAL COLLECTIVE LIABILITY
OF ALCATEL-LUCENT, ITS EMPLOYEES, DIRECTORS, OFFICERS OR
AGENTS FOR ALL CLAIMS EXCEED THE TOTAL AMOUNT PAID BY
CUSTOMER TO ALCATEL-LUCENT HEREUNDER. NO PARTY SHALL
BE LIABLE FOR ANY INDIRECT, SPECIAL OR CONSEQUENTIAL
DAMAGES, WHETHER OR NOT SUCH DAMAGES ARE
FORESEEABLE, AND/OR THE PARTY HAD BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
7.2 The foregoing provision limiting the liability of Alcatel-Lucent's employees,
agents, officers and directors shall be deemed to be a trust provision, and shall
be enforceable by such employees, agents, officers and directors as trust
beneficiaries.
v
8. GENERAL
8.1 Under no circumstances shall either party be liable to the other for any failure
to perform its obligations (other than the payment of any monies owing) where
such failure results from causes beyond that party's reasonable control.
8.2 This Agreement constitutes the entire agreement between Alcatel-Lucent and
Customer and supersedes all prior oral and written communications. All
amendments shall be in writing and signed by authorized representatives of
both parties.
8.3 If any provision of this Agreement is held to be invalid, illegal or
unenforceable, it shall be severed and the remaining provisions shall continue
in full force and effect.
8.4 The Licensed Program may contain freeware or shareware obtained by
Alcatel-Lucent from a third party source. No license fee has been paid by
Alcatel-Lucent for the inclusion of any such freeware or shareware, and no
license fee is charged to Customer for its use. The Customer agrees to be
bound by any license agreement for such freeware or shareware. CUSTOMER
ACKNOWLEDGES AND AGREES THAT THE THIRD PARTY SOURCE
PROVIDES NO WARRANTIES AND SHALL HAVE NO LIABILITY
WHATSOEVER IN RESPECT OF CUSTOMER'S POSSESSION AND/OR
USE OF THE FREEWARE OR SHAREWARE.
8.5 Alcatel-Lucent shall have the right, at its own expense and upon reasonable
written notice to Customer, to periodically inspect Customer's premises and
such documents as it may reasonably require, for the exclusive purpose of
verifying Customer's compliance with its obligations under this Agreement.
8.6 All notices shall be sent to the parties at the addresses listed above, or to any
such address as may be specified from time to time. Notices shall be deemed
to have been received five days after deposit with a post office when sent by
registered or certified mail, postage prepaid and receipt requested.
8.7 If the Licensed Program is being acquired by or on behalf of any unit or agency
of the United States Government, the following provision shall apply: If the
Licensed Program is supplied to the Department of Defense, it shall be
classified as "Commercial Computer Software" and the United States
Government is acquiring only "restricted rights" in the Licensed Program as
defined in DFARS 227-7202-1(a) and 227.7202-3(a), or equivalent. If the
Licensed Program is supplied to any other unit or agency of the United States
Government, rights will be defined in Clause 52.227-19 or 52.227-14 of the
FAR, or if acquired by NASA, Clause 18-52.227-86(d) of the NASA
Supplement to the FAR, or equivalent. If the software was acquired under a
contract subject to the October 1988 Rights in Technical Data and Computer
Software regulations, use, duplication and disclosure by the Government is
subject to the restrictions set forth in DFARS 252-227.7013(c)(1)(ii) 1988, or
equivalent.
8.8 Customer shall comply with all export regulations pertaining to the Licensed
Program in effect from time to time. Without limiting the generality of the
foregoing, Customer expressly warrants that it will not directly or indirectly
export, reexport, or transship the Licensed Program in violation of any export
laws, rules or regulations of Canada, the United States or the United Kingdom.
vi
8.9 No term or provision of this Agreement shall be deemed waived and no breach
excused unless such waiver or consent is in writing and signed by the party
claimed to have waived or consented. The waiver by either party of any right
hereunder, or of the failure to perform or of a breach by the other party, shall
not be deemed to be a waiver of any other right hereunder or of any other
breach or failure by such other party, whether of a similar nature or otherwise.
8.10 This Agreement shall be governed by and construed in accordance with the
laws of the Province of Ontario. The application of the United Nations
Convention on Contracts for the International Sale of Goods is hereby
expressly excluded.
vii
viii
Preface
The preface provides general information about the 5780 Dynamic Services
Controller (5780 DSC) documentation suite.
Audience
This document is intended for administrators, operators, and maintenance personnel
involved with installing, operating, maintaining, or troubleshooting the 5780 DSC.
5780 DSC documentation suite

Table 1 describes the documents that comprise the 5780 DSC documentation suite.
Table 1 5780 DSC documentation set
Title Description Part number

5780 DSC Release Description General information about the platform, product, compatibility 07RD0119
requirements, network element compatibility of the release,
features and functions of the 5780 DSC, features that are no
longer supported, and ordering information.
5780 DSC Release Notice Important late-breaking information including new features, 3HE 07626 AAAD TQZZA
design change requests, restrictions and limitations, closed and
outstanding problems, technical alerts, and installation and
upgrade notes.
5780 DSC Planning Guide Information required to plan a successful deployment of the 3HE 07633 AAAD TQZZA
5780 DSC including deployment scenarios, geo-redundant
configurations, platform requirements and sizing, bandwidth
requirements, and network and security considerations.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 ix

3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Preface
Title Description Part number
5780 DSC Installation and Upgrade Information that describes: 3HE 07628 AAAD TQZZA
Guide • 5780 DSC software requirements and installation
prerequisites
• how to install the 5780 DSC for the first time including pre-
and post-installation procedures
• how to configure geo-redundant deployments
• how to upgrade the 5780 DSC
5780 DSC User Guide Information about: 3HE 07629 AAAD TQZZA
• an overall description of the 5780 DSC, including the core
services and features, as well as the key benefits of using
the product
• how to access and log in to the 5780 DSC web-based GUI,
and an overview of the GUI components including menus
and icons, how to view and manage information, and
perform routine GUI tasks
• how to configure and manage the metering limits,
9900 WNG policies, RADIUS-based policy management, and
the rules engine, including: rule sets, rule tables, QoS rules,
internal and external SPR subscribers, and how to work with
AF, IP-CAN, Gateway Control, NASREQ, S9, Sd, and Sy
sessions
• how to configure and manage 5780 DSC VSA dictionaries,
PCRF clusters, and view the parameters associated with
5780 DSC complex equipment
• routine administrator tasks such as how to create user
accounts, view the 5780 DSC platform status, set up the
collection of performance metrics, start and stop the
database and application servers, back up the 5780 DSC
database, and manage license keys
• how to troubleshoot 5780 DSC platform components (such
as connections, sessions, interfaces, rules, and actions),
how to manage logging functions, restore and replicate the
database, and collect information for technical support
• how to use the Provisioning Server XML interface to
automate provisioning operations and examples to help you
write custom OSS applications that interface with the
5780 DSC database
5780 DSC Integration Guide Information about: 3HE 07630 AAAD TQZZA
• 3GPP Gx, Gxx, Rx, S9, Sy, and Sd Diameter interfaces
supported by the 5780 DSC
• 5780 DSC compliance with the 3GPP PCC-related Release 7,
8, 9, and 10 specifications
5780 DSC Policy Management Use Cases Provides a number of use cases that demonstrate how the 3HE 07631 AAAD TQZZA
5780 DSC provides flexible policy control and charging rules to
address the requirements of service providers.
5780 DSC API Reference Manual Provides simplified APIs for the 5780 DSC to configure 3HE 07632 AAAD TQZZA
subscribers, provide types of billing identifiers, and configure
metering limits.
5780 DSC Error Messages Reference Describes the error messages you may receive when you use the 3HE 07665 AAAD TQZZA
5780 DSC.
5780 DSC Glossary Provides the 5780 DSC glossary terms and definitions. 3HE 07625 AAAD TQZZA
(2 of 2)
x May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4

Preface
Procedure 1 To find the 5780 DSC user documentation
The user documentation is available from the following sources:
• the top level of the product DVD:

• 5780_DSC_Integration_Guide.pdf
• 5780_DSC_User_Guide.pdf
• 5780_DSC_Installation_and_Upgrade_Guide.pdf
• 5780_DSC_Planning_Guide.pdf
• 5780_DSC_Use_Cases.pdf
• 5780_DSC_API_Reference_Manual.pdf
• 5780_DSC_Error_Messages.pdf
• 5780_DSC_Glossary.pdf
• Help→5780 DSC User Documentation in the 5780 DSC client GUI main menu
The mibs directory in the product DVD contains all the .mib files packaged in the
product.
Note — Users of Mozilla browsers may receive an error message when

using the User Documentation Index page (index.html) to open the PDF
files in the 5780 DSC documentation suite. The offline storage and
default cache values used by the browsers are the cause of the error
message.
Alcatel-Lucent recommends changing the offline storage (Mozilla

Firefox) or cache (Mozilla 1.7) values to 100 Mbytes to eliminate the
error message.
Searching for information in this guide

You can use Adobe Reader, Release 6.0 or later, to search one or more PDF files for
a term.
Procedure 2 To search for specific information in this guide

1 Open Adobe Acrobat Reader.
2 Choose Edit→Search from the Acrobat Reader main menu. The Search panel
appears.
3 Enter the search criteria.
4 Click on the In the current PDF Document radio button.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xi

Preface
5 Select the following search criteria, if required:
• Whole words only

• Case-Sensitive
• Include Bookmarks
• Include Comments
6 Click on the Search button. Acrobat Reader displays the search results. The results
are grouped by PDF file and you can expand the entry for each file. You can
expand the entries by clicking on the + symbol.
Note — After you click on a hyperlink, you can right-click and choose
Previous View from the contextual menu to return to the location of the
previous hyperlink.
Procedure 3 To search for specific information in multiple 5780 DSC

user documents
Note — The PDF files that you search must be in the same folder.
1 Open the Adobe Reader.
2 Choose Edit→Search from the Adobe Reader main menu. The Search panel
appears.
3 Enter the search criteria.
4 Click on the All PDF Documents in radio button.
5 Choose the folder in which to search using the drop-down menu.
xii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Preface
6 Select the following search criteria, if required:
• Whole words only

• Case-Sensitive
• Include Bookmarks
• Include Comments
7 Click on the Search button. Adobe Reader displays the search results. The results
are grouped by PDF file and you can expand the entry for each file.You can expand
the entries by clicking on the + symbol.
Note — After you click on a hyperlink, you can right-click and choose
Previous View from the contextual menu to return to the location of the
previous hyperlink.
Prerequisites
To perform the tasks in this documentation set, you need sufficient technical
knowledge about:
• 3GPP specifications, available at: http://www.3gpp.org/
• general telecommunications principles
• network requirements, recommended deployments, and administration
• UNIX administration
Conventions
Table 2 describes the conventions that are used in this documentation set.
Table 2 Documentation conventions
Convention Description Example
Key name Press a keyboard key. Delete
Italics Italics identifies a variable. hostname
Key+Key Type the appropriate consecutive keystroke sequence. CTRL+G

Key–Key Type the appropriate simultaneous keystroke sequence. CTRL–G
* An asterisk is a wildcard character, which means “any character” log_file*.txt

in a search argument. Name*
In addition, parameters that have an asterisk (*) beside them are
mandatory.
↵ Press the Return key. ↵
— An em dash indicates there is no information. —
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xiii
Preface
Convention Description Example
→ A right arrow indicates that a cascading submenu opens when you Policies→Routing
choose a menu item.
User-defined Appears in examples of code to denote user-defined parameters. <password>password</password>

parameters
(2 of 2)
Procedures with options or substeps

When there are options in a procedure, they are identified by letters. When there are
substeps in a procedure, they are identified by Roman numerals.
Example of options in a procedure
At step 1, you can choose option a or b. At step 2, you must do what the step
indicates.
1 This step offers two options. You must choose one of the following:
a This is one option.
b This is another option.
2 You must perform this step.
Example of substeps in a procedure
At step 1, you must perform a series of substeps within a step. At step 2, you must
do what the step indicates.
1 Perform the following substeps:
i This is the first substep.
ii This is the second substep.
iii This is the third substep.
2 You must perform this step.
Measurement conventions
Measurements in this document are expressed in metric units and follow the Système
international d’unités (SI) standard for abbreviation of metric units. If imperial
measurements are included, they appear in brackets following the metric unit.
Table 3 lists the measurement symbols used in this document.
xiv May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Preface
Table 3 Bits and bytes conventions
Measurement Symbol
bit b
byte byte
kilobits per second kb/s
Glossary entries in this documentation set

Glossary entries marked with an asterisk are reproduced with permission from LTE
– The UMTS Long Term Evolution: A Pocket Dictionary of Acronyms, © 2009
Stefania Sesia, Issam Toufik and Matthew Baker, available at:
http://www.wiley.com/go/sesia_theumts.
Important information
The following conventions are used to indicate important information.
Warning — Warning indicates that the described activity or situation

may, or will, cause equipment damage or serious performance
problems.
Caution — Caution indicates that the described activity or situation

may, or will, cause service interruption.
Note — Notes provide information that is, or may be, of special

interest.
Contact information
If you have questions or comments about this documentation, contact:
documentation.feedback@alcatel-lucent.com
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xv

Preface
xvi May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
Preface ix
Audience ............................................................................................... ix
5780 DSC documentation suite ...................................................................... ix
Procedure 1 To find the 5780 DSC user documentation ......................... xi
Searching for information in this guide............................................................. xi
Procedure 2 To search for specific information in this guide .................. xi
Procedure 3 To search for specific information in multiple 5780 DSC
user documents.................................................................. xii
Prerequisites.......................................................................................... xiii
Conventions........................................................................................... xiii
Procedures with options or substeps ...............................................xiv
Measurement conventions ...........................................................xiv
Glossary entries in this documentation set ....................................... xv
Important information................................................................ xv
Contact information .................................................................................. xv
1— 5780 DSC API reference 1-1

1.1 5780 DSC API overview ................................................................. 1-2
1.2 5780 DSC provisioning web services API overview ................................. 1-2
Versioning of objects and APIs ..................................................... 1-4
5780 DSC APIs ......................................................................... 1-4
Failure response handling.......................................................... 1-10
Header information ................................................................. 1-11
API versions .......................................................................... 1-12
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xvii
Contents
2— Subscriber provisioning API 2-1

2.1 Using the subscriber provisioning API ................................................ 2-4
2.2 addAccount .............................................................................. 2-4
Parameter ............................................................................. 2-4
Request code ......................................................................... 2-4
Request fields......................................................................... 2-6
Response code ........................................................................ 2-9
2.3 addSubscriber........................................................................... 2-10
Parameter ............................................................................ 2-10
Request code ........................................................................ 2-10
Request fields........................................................................ 2-12
Response code ....................................................................... 2-15
2.4 clearPenaltyPeriod..................................................................... 2-16
Parameters ........................................................................... 2-16
Request code ........................................................................ 2-16
Request fields........................................................................ 2-17
Response code ....................................................................... 2-18
2.5 getAccount .............................................................................. 2-18
Parameters ........................................................................... 2-18
Request code ........................................................................ 2-19
Request fields........................................................................ 2-19
Response code ....................................................................... 2-20
2.6 getAccountCustomData ............................................................... 2-28
Parameters ........................................................................... 2-28
Request code ........................................................................ 2-28
Request fields........................................................................ 2-29
Response code ....................................................................... 2-30
Response fields ...................................................................... 2-30
2.7 getAccountCustomDataProfiles ...................................................... 2-31
Parameters ........................................................................... 2-31
Request code ........................................................................ 2-32
Request fields........................................................................ 2-32
Response code ....................................................................... 2-33
Response fields ...................................................................... 2-34
2.8 getAllowOverage ....................................................................... 2-34
Parameter ............................................................................ 2-34
Request code ........................................................................ 2-34
Request fields........................................................................ 2-35
Response code ....................................................................... 2-36
Response fields ...................................................................... 2-36
2.9 getCategory ............................................................................. 2-36
Parameter ............................................................................ 2-36
Request code ........................................................................ 2-36
Request fields........................................................................ 2-37
Response code ....................................................................... 2-38
Response fields ...................................................................... 2-39
2.10 getCustomData ......................................................................... 2-39
Parameter ............................................................................ 2-39
Request code ........................................................................ 2-39
Request fields........................................................................ 2-40
Response code ....................................................................... 2-41
Response fields ...................................................................... 2-41
xviii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
2.11 getCustomDataProfiles ................................................................ 2-42

Parameter ............................................................................ 2-42
Request code ........................................................................ 2-42
Request fields........................................................................ 2-43
Response code ....................................................................... 2-44
Response fields ...................................................................... 2-45
2.12 getMeteringLimits ...................................................................... 2-45
Parameters ........................................................................... 2-45
Request code ........................................................................ 2-45
Request fields........................................................................ 2-46
Response code ....................................................................... 2-47
Response fields ...................................................................... 2-48
2.13 getNotification ......................................................................... 2-48
Parameter ............................................................................ 2-48
Request code ........................................................................ 2-48
Request fields........................................................................ 2-49
Response code ....................................................................... 2-50
Response fields ...................................................................... 2-50
2.14 getResetDayOfMonth .................................................................. 2-51
Parameters ........................................................................... 2-51
Request code ........................................................................ 2-51
Request fields........................................................................ 2-52
Response code ....................................................................... 2-52
Response fields ...................................................................... 2-53
2.15 getResetDayOfWeek ................................................................... 2-53
Parameters ........................................................................... 2-53
Request code ........................................................................ 2-53
Request fields........................................................................ 2-54
Response code ....................................................................... 2-55
Response fields ...................................................................... 2-56
2.16 getResetHourOfDay .................................................................... 2-56
Parameters ........................................................................... 2-56
Request code ........................................................................ 2-56
Request fields........................................................................ 2-57
Response code ....................................................................... 2-58
Response fields ...................................................................... 2-59
2.17 getSubProfileNames ................................................................... 2-59
Parameter ............................................................................ 2-59
Request code ........................................................................ 2-59
Request fields........................................................................ 2-60
Response code ....................................................................... 2-61
Response fields ...................................................................... 2-62
2.18 getSubscriber ........................................................................... 2-62
Parameter ............................................................................ 2-62
Request code ........................................................................ 2-62
Request fields........................................................................ 2-63
Response code ....................................................................... 2-64
Response fields ...................................................................... 2-65
2.19 getSubscriberState ..................................................................... 2-68
Parameter ............................................................................ 2-69
Request code ........................................................................ 2-69
Request fields........................................................................ 2-69
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xix
Contents
Response code ....................................................................... 2-70

Response fields ...................................................................... 2-71
2.20 getSubscriptionIds...................................................................... 2-71
Parameter ............................................................................ 2-71
Request code ........................................................................ 2-71
Request fields........................................................................ 2-72
Response code ....................................................................... 2-73
Response fields ...................................................................... 2-74
2.21 getUnknownSubscriber ................................................................ 2-74
Parameter ............................................................................ 2-75
Request code ........................................................................ 2-75
Request fields........................................................................ 2-75
Response code ....................................................................... 2-76
Response fields ...................................................................... 2-77
2.22 getUsage................................................................................. 2-77
Parameters ........................................................................... 2-77
Request code ........................................................................ 2-77
Request fields........................................................................ 2-78
Response code ....................................................................... 2-79
Response fields ...................................................................... 2-80
2.23 removeAccount ......................................................................... 2-81
Parameters ........................................................................... 2-82
Request code ........................................................................ 2-82
Request fields........................................................................ 2-82
Response code ....................................................................... 2-83
2.24 removeSubscriber ...................................................................... 2-84
Parameter ............................................................................ 2-84
Request code ........................................................................ 2-84
Request fields........................................................................ 2-85
Response code ....................................................................... 2-86
2.25 resetUsage .............................................................................. 2-86
Parameters ........................................................................... 2-86
Request code ........................................................................ 2-86
Request fields........................................................................ 2-87
Response code ....................................................................... 2-88
2.26 updateAccount ......................................................................... 2-89
Parameter ............................................................................ 2-89
Request code ........................................................................ 2-89
Request fields........................................................................ 2-91
Response code ....................................................................... 2-94
2.27 updateAccountCustomData ........................................................... 2-95
Parameters ........................................................................... 2-95
Request code ........................................................................ 2-95
Request fields........................................................................ 2-96
Response code ....................................................................... 2-99
2.28 updateAccountCustomDataEntry .................................................... 2-99
Parameters ........................................................................... 2-99
Request code ........................................................................ 2-99
Request fields...................................................................... 2-100
Response code ..................................................................... 2-102
xx May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4

Contents
2.29 updateAccountCustomDataProfiles................................................ 2-103

Parameters ......................................................................... 2-103
Request code ...................................................................... 2-103
Request fields...................................................................... 2-104
Response code ..................................................................... 2-105
2.30 updateAllowOverage................................................................. 2-106
Parameters ......................................................................... 2-106
Request code ...................................................................... 2-106
Request fields...................................................................... 2-107
Response code ..................................................................... 2-108
2.31 updateCategory ...................................................................... 2-108
Parameters ......................................................................... 2-108
Request code ...................................................................... 2-108
Subparameters..................................................................... 2-109
Response code ..................................................................... 2-110
2.32 updateCustomData................................................................... 2-111
Parameters ......................................................................... 2-111
Request code ...................................................................... 2-111
Request fields...................................................................... 2-112
Response code ..................................................................... 2-115
2.33 updateCustomDataEntry ............................................................ 2-115
Parameters ......................................................................... 2-115
Request code ...................................................................... 2-115
Request fields...................................................................... 2-116
Response code ..................................................................... 2-118
2.34 updateCustomDataProfiles ......................................................... 2-119
Parameters ......................................................................... 2-119
Request code ...................................................................... 2-119
Request fields...................................................................... 2-120
Response code ..................................................................... 2-121
2.35 updateMeteringLimitEntry .......................................................... 2-121
Parameters ......................................................................... 2-121
Request code ...................................................................... 2-122
Request fields...................................................................... 2-122
Response code ..................................................................... 2-124
2.36 updateMeteringLimits ............................................................... 2-124
Parameters ......................................................................... 2-124
Request code ...................................................................... 2-124
Request fields...................................................................... 2-125
Response code ..................................................................... 2-126
2.37 updateNotification ................................................................... 2-127
Parameters ......................................................................... 2-127
Request code ...................................................................... 2-127
Request fields...................................................................... 2-128
Response code ..................................................................... 2-129
2.38 updateResetDayOfMonth ............................................................ 2-129
Parameters ......................................................................... 2-129
Request code ...................................................................... 2-130
Request fields...................................................................... 2-130
Response code ..................................................................... 2-131
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxi
Contents
2.39 updateResetDayOfWeek............................................................. 2-132

Parameters ......................................................................... 2-132
Request code ...................................................................... 2-132
Request fields...................................................................... 2-133
Response code ..................................................................... 2-134
2.40 updateResetHourOfDay ............................................................. 2-135
Parameters ......................................................................... 2-135
Request code ...................................................................... 2-135
Request fields...................................................................... 2-136
Response code ..................................................................... 2-137
2.41 updateSubProfileNames ............................................................. 2-138
Parameters ......................................................................... 2-138
Request code ...................................................................... 2-138
Request fields...................................................................... 2-139
Response code ..................................................................... 2-140
2.42 updateSubscriber..................................................................... 2-141
Parameter .......................................................................... 2-141
Request code ...................................................................... 2-141
Request fields...................................................................... 2-143
Response code ..................................................................... 2-147
2.43 updateSubscriberState .............................................................. 2-147
Parameters ......................................................................... 2-147
Request code ...................................................................... 2-147
Request fields...................................................................... 2-148
Response code ..................................................................... 2-149
2.44 updateSubscriptionId ................................................................ 2-150
Parameters ......................................................................... 2-150
Request code ...................................................................... 2-150
Request fields...................................................................... 2-151
Response code ..................................................................... 2-154
2.45 updateSubscriptionIds ............................................................... 2-155
Parameters ......................................................................... 2-155
Request code ...................................................................... 2-155
Request fields...................................................................... 2-156
Response code ..................................................................... 2-157
2.46 updateUnknownSubscriber.......................................................... 2-158
Parameters ......................................................................... 2-158
Request code ...................................................................... 2-158
Request fields...................................................................... 2-159
Response code ..................................................................... 2-160
3— Subscriber profile provisioning API 3-1

3.1 Using the subscriber profile provisioning ............................................ 3-3
3.2 addCalledStationIdEntry ............................................................... 3-3
Parameters ............................................................................ 3-3
Request code ......................................................................... 3-3
Request fields......................................................................... 3-3
Response code ........................................................................ 3-4
3.3 addSubscriberProfile.................................................................... 3-4
Parameter ............................................................................. 3-4
Request code ......................................................................... 3-4
xxii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
Request fields......................................................................... 3-7

Response code ....................................................................... 3-12
3.4 getAFApplications ...................................................................... 3-13
Parameter ............................................................................ 3-13
Request code ........................................................................ 3-13
Request fields........................................................................ 3-13
Response code ....................................................................... 3-14
Response fields ...................................................................... 3-14
3.5 getCalledStationIds .................................................................... 3-15
Parameter ............................................................................ 3-15
Request code ........................................................................ 3-15
Request fields........................................................................ 3-16
Response code ....................................................................... 3-16
Response fields ...................................................................... 3-16
3.6 getQciGuaranteedBitRates ........................................................... 3-17
Parameter ............................................................................ 3-17
Request code ........................................................................ 3-17
Request fields........................................................................ 3-17
Response code ....................................................................... 3-18
Response fields ...................................................................... 3-18
3.7 getQciMaxBitRates ..................................................................... 3-19
Parameter ............................................................................ 3-19
Request code ........................................................................ 3-19
Request fields........................................................................ 3-20
Response code ....................................................................... 3-20
Response fields ...................................................................... 3-21
3.8 getSubscriberProfile ................................................................... 3-21
Parameter ............................................................................ 3-21
Request code ........................................................................ 3-21
Request fields........................................................................ 3-22
Response code ....................................................................... 3-22
Response fields ...................................................................... 3-24
3.9 getSubscriberProfileCustomData .................................................... 3-30
Parameter ............................................................................ 3-30
Request code ........................................................................ 3-31
Request fields........................................................................ 3-31
Response code ....................................................................... 3-31
Response fields ...................................................................... 3-32
3.10 getSubscriberProfileCustomDataProfiles ........................................... 3-33
Parameter ............................................................................ 3-33
Request code ........................................................................ 3-33
Request fields........................................................................ 3-34
Response code ....................................................................... 3-34
Response fields ...................................................................... 3-35
3.11 removeSubscriberProfile .............................................................. 3-35
Parameter ............................................................................ 3-35
Request code ........................................................................ 3-35
Request fields........................................................................ 3-36
Response code ....................................................................... 3-36
3.12 updateAFApplicationEntry ............................................................ 3-36
Parameters ........................................................................... 3-36
Request code ........................................................................ 3-36
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxiii
Contents
Request fields........................................................................ 3-37

Response code ....................................................................... 3-39
3.13 updateAFApplications ................................................................. 3-39
Parameters ........................................................................... 3-39
Request code ........................................................................ 3-40
Request fields........................................................................ 3-40
Response code ....................................................................... 3-42
3.14 updateCalledStationIds................................................................ 3-42
Parameters ........................................................................... 3-42
Request code ........................................................................ 3-43
Request fields........................................................................ 3-43
Response code ....................................................................... 3-44
3.15 updateQciGuaranteedBitRateEntry.................................................. 3-44
Parameters ........................................................................... 3-44
Request code ........................................................................ 3-44
Request fields........................................................................ 3-45
Response code ....................................................................... 3-46
3.16 updateQciGuaranteedBitRates ....................................................... 3-46
Parameters ........................................................................... 3-47
Request code ........................................................................ 3-47
Request fields........................................................................ 3-47
Response code ....................................................................... 3-48
3.17 updateQciMaxBitRateEntry ........................................................... 3-49
Parameters ........................................................................... 3-49
Request code ........................................................................ 3-49
Request fields........................................................................ 3-50
Response code ....................................................................... 3-50
3.18 updateQciMaxBitRates ................................................................ 3-51
Parameters ........................................................................... 3-51
Request code ........................................................................ 3-51
Request fields........................................................................ 3-52
Response code ....................................................................... 3-53
3.19 updateSubscriberProfile .............................................................. 3-53
Parameters ........................................................................... 3-53
Request code ........................................................................ 3-53
Request fields........................................................................ 3-55
Response code ....................................................................... 3-61
3.20 updateSubscriberProfileCustomData ................................................ 3-62
Parameters ........................................................................... 3-62
Request code ........................................................................ 3-62
Request fields........................................................................ 3-63
Response code ....................................................................... 3-64
3.21 updateSubscriberProfileCustomDataEntry ......................................... 3-65
Parameters ........................................................................... 3-65
Request code ........................................................................ 3-65
Request fields........................................................................ 3-66
Response code ....................................................................... 3-67
3.22 updateSubscriberProfileCustomDataProfiles....................................... 3-68
Parameters ........................................................................... 3-68
Request code ........................................................................ 3-68
Request fields........................................................................ 3-69
Response code ....................................................................... 3-69
xxiv May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
4— Rule provisioning API 4-1

4.1 Using the rule provisioning API........................................................ 4-3
4.2 activateRuleSystemVersion ............................................................ 4-3
Parameter ............................................................................. 4-3
Request code ......................................................................... 4-3
Request fields......................................................................... 4-4
Response code ........................................................................ 4-4
4.3 addCustomDataProfiles ................................................................ 4-4
Parameter ............................................................................. 4-4
Request code ......................................................................... 4-4
Request fields......................................................................... 4-5
Response code ........................................................................ 4-7
4.4 addMeteringLimits ...................................................................... 4-8
Parameter ............................................................................. 4-8
Request code ......................................................................... 4-8
Request fields........................................................................ 4-11
Response code ....................................................................... 4-22
4.5 cloneRuleSystemVersion .............................................................. 4-22
Parameters ........................................................................... 4-22
Request code ........................................................................ 4-22
Request fields........................................................................ 4-23
Response code ....................................................................... 4-23
4.6 exportRuleSystemVersion ............................................................. 4-24
Parameter ............................................................................ 4-24
Request code ........................................................................ 4-24
Request fields........................................................................ 4-24
Response code ....................................................................... 4-25
4.7 getActiveRuleSystemVersionName .................................................. 4-35
Parameter ............................................................................ 4-35
Request code ........................................................................ 4-35
Request fields........................................................................ 4-36
Response code ....................................................................... 4-36
Response fields ...................................................................... 4-36
4.8 getCustomDataProfile ................................................................. 4-37
Parameter ............................................................................ 4-37
Request code ........................................................................ 4-37
Request fields........................................................................ 4-37
Response code ....................................................................... 4-38
Response fields ...................................................................... 4-38
4.9 getCustomDataProfile_CustomData ................................................. 4-40
Parameter ............................................................................ 4-40
Request code ........................................................................ 4-40
Request fields........................................................................ 4-41
Response code ....................................................................... 4-41
Response fields ...................................................................... 4-42
4.10 getCustomDataProfilePriority ........................................................ 4-43
Parameter ............................................................................ 4-43
Request code ........................................................................ 4-43
Request fields........................................................................ 4-44
Response code ....................................................................... 4-44
Response fields ...................................................................... 4-45
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxv
Contents
4.11 getMeteringLimit ....................................................................... 4-45

Parameter ............................................................................ 4-45
Request code ........................................................................ 4-45
Request fields........................................................................ 4-46
Response code ....................................................................... 4-46
Response fields ...................................................................... 4-47
4.12 getMeteringLimitApplicabilityConditions ........................................... 4-51
Parameter ............................................................................ 4-52
Request code ........................................................................ 4-52
Request fields........................................................................ 4-52
Response code ....................................................................... 4-53
Response fields ...................................................................... 4-53
4.13 getMeteringLimitDefaultActions ..................................................... 4-55
Parameter ............................................................................ 4-55
Request code ........................................................................ 4-56
Request fields........................................................................ 4-56
Response code ....................................................................... 4-56
Response fields ...................................................................... 4-57
4.14 getMeteringLimitNames .............................................................. 4-60
Parameter ............................................................................ 4-60
Request code ........................................................................ 4-60
Request fields........................................................................ 4-60
Response code ....................................................................... 4-61
Response fields ...................................................................... 4-61
4.15 getMeteringLimitPriority .............................................................. 4-61
Parameter ............................................................................ 4-62
Request code ........................................................................ 4-62
Request fields........................................................................ 4-62
Response code ....................................................................... 4-63
Response fields ...................................................................... 4-63
4.16 getMeteringLimitQuota................................................................ 4-63
Parameter ............................................................................ 4-63
Request code ........................................................................ 4-63
Request fields........................................................................ 4-64
Response code ....................................................................... 4-64
Response fields ...................................................................... 4-65
4.17 getMeteringLimits ...................................................................... 4-65
Parameter ............................................................................ 4-65
Request code ........................................................................ 4-65
Request fields........................................................................ 4-66
Response code ....................................................................... 4-66
Response fields ...................................................................... 4-69
4.18 getRuleSystemVersion ................................................................. 4-74
Parameter ............................................................................ 4-74
Request code ........................................................................ 4-75
Request fields........................................................................ 4-75
Response code ....................................................................... 4-75
Response fields ...................................................................... 4-76
4.19 getRuleSystemVersionDescription ................................................... 4-76
Parameter ............................................................................ 4-76
Request code ........................................................................ 4-77
Request fields........................................................................ 4-77
xxvi May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
Response code ....................................................................... 4-77

Response fields ...................................................................... 4-78
4.20 getRuleSystemVersionNames ......................................................... 4-78
Parameter ............................................................................ 4-78
Request code ........................................................................ 4-78
Request fields........................................................................ 4-78
Response code ....................................................................... 4-79
Response fields ...................................................................... 4-79
4.21 importRuleSystemVersion............................................................. 4-79
Parameters ........................................................................... 4-79
Request code ........................................................................ 4-80
Request fields........................................................................ 4-91
Response code ....................................................................... 4-91
4.22 removeCustomDataProfile ............................................................ 4-91
Parameter ............................................................................ 4-92
Request code ........................................................................ 4-92
Request fields........................................................................ 4-92
Response code ....................................................................... 4-93
4.23 removeMeteringLimit.................................................................. 4-93
Parameter ............................................................................ 4-93
Request code ........................................................................ 4-93
Request fields........................................................................ 4-94
Response code ....................................................................... 4-94
4.24 removeRuleSystemVersion ............................................................ 4-94
Parameter ............................................................................ 4-94
Request code ........................................................................ 4-94
Request fields........................................................................ 4-95
Response code ....................................................................... 4-95
4.25 updateCustomDataProfile............................................................. 4-95
Parameter ............................................................................ 4-96
Request code ........................................................................ 4-96
Request fields........................................................................ 4-96
Response code ....................................................................... 4-98
4.26 updateCustomDataProfile_CustomData ............................................ 4-99
Parameters ........................................................................... 4-99
Request code ........................................................................ 4-99
Request fields...................................................................... 4-100
Response code ..................................................................... 4-101
4.27 updateCustomDataProfile_CustomDataEntry .................................... 4-102
Parameters ......................................................................... 4-102
Request code ...................................................................... 4-102
Request fields...................................................................... 4-102
Response code ..................................................................... 4-104
4.28 updateCustomDataProfilePriority ................................................. 4-105
Parameters ......................................................................... 4-105
Request code ...................................................................... 4-105
Request fields...................................................................... 4-105
Response code ..................................................................... 4-106
4.29 updateMeteringLimit ................................................................ 4-106
Parameter .......................................................................... 4-107
Request code ...................................................................... 4-107
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxvii
Contents
Request fields...................................................................... 4-109

Response code ..................................................................... 4-114
4.30 updateMeteringLimitApplicabilityConditions .................................... 4-114
Parameters ......................................................................... 4-114
Request code ...................................................................... 4-114
Request fields...................................................................... 4-115
Response code ..................................................................... 4-117
4.31 updateMeteringLimitDefaultActions .............................................. 4-118
Parameters ......................................................................... 4-118
Request code ...................................................................... 4-118
Request fields...................................................................... 4-119
Response code ..................................................................... 4-121
4.32 updateMeteringLimitPriority ....................................................... 4-122
Parameters ......................................................................... 4-122
Request code ...................................................................... 4-122
Request fields...................................................................... 4-123
Response code ..................................................................... 4-123
4.33 updateMeteringLimitQuota ......................................................... 4-124
Parameters ......................................................................... 4-124
Request code ...................................................................... 4-124
Request fields...................................................................... 4-124
Response code ..................................................................... 4-125
4.34 updateMeteringLimitRateLimitRate ............................................... 4-125
Parameters ......................................................................... 4-125
Request code ...................................................................... 4-126
Request fields...................................................................... 4-126
Response code ..................................................................... 4-127
4.35 updateRuleSystemVersionDescription............................................. 4-128
Parameters ......................................................................... 4-128
Request code ...................................................................... 4-128
Request fields...................................................................... 4-128
Response code ..................................................................... 4-129
5— NASREQ session API 5-1

5.1 Using the NASREQ session API ......................................................... 5-2
5.2 bindSubscriber ........................................................................... 5-2
Parameters ............................................................................ 5-2
Request code ......................................................................... 5-2
Request fields......................................................................... 5-3
Response code ........................................................................ 5-5
5.3 disconnectSession ....................................................................... 5-6
Parameter ............................................................................. 5-6
Request code ......................................................................... 5-6
Request fields......................................................................... 5-6
Response code ........................................................................ 5-8
5.4 getSession ................................................................................ 5-8
Parameter ............................................................................. 5-8
Request code ......................................................................... 5-8
Request fields......................................................................... 5-9
Response code ....................................................................... 5-11
Response fields ...................................................................... 5-12
xxviii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
5.5 getSessionSummary .................................................................... 5-17

Parameter ............................................................................ 5-18
Request code ........................................................................ 5-18
Request fields........................................................................ 5-18
Response code ....................................................................... 5-20
6— IP-CAN session API 6-1

6.1 Using the IP-CAN session API .......................................................... 6-2
6.2 getSession ................................................................................ 6-2
Parameter ............................................................................. 6-2
Request code ......................................................................... 6-2
Request fields......................................................................... 6-3
Response code ........................................................................ 6-4
Response fields ....................................................................... 6-6
Parameter ............................................................................ 6-20
Request code ........................................................................ 6-20
Request fields........................................................................ 6-21
Response code ....................................................................... 6-22
7— AF session API 7-1

7.1 Using the AF session API................................................................ 7-2
7.2 getSession ................................................................................ 7-2
Parameter ............................................................................. 7-2
Request code ......................................................................... 7-2
Request fields......................................................................... 7-3
Response code ........................................................................ 7-4
Response fields ....................................................................... 7-7
Parameter ............................................................................ 7-16
Request code ........................................................................ 7-16
Request fields........................................................................ 7-17
Response code ....................................................................... 7-19
8— Sy session API 8-1

8.1 Using the Sy session API ................................................................ 8-2
8.2 getSession ................................................................................ 8-2
Parameter ............................................................................. 8-2
Request code ......................................................................... 8-2
Request fields......................................................................... 8-3
Response code ........................................................................ 8-3
Response fields ....................................................................... 8-5
9— Streaming reporting API 9-1

9.1 Using the streaming reporting API.................................................... 9-2
Requests ............................................................................... 9-2
Responses.............................................................................. 9-3
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxix
Contents
9.2 ListAccountsWithFilter ................................................................. 9-3

Parameters ............................................................................ 9-3
Request code ......................................................................... 9-3
Request fields......................................................................... 9-4
Response code ........................................................................ 9-6
Response fields ...................................................................... 9-10
9.3 ListAFSessionSummary................................................................. 9-12
Parameter ............................................................................ 9-13
Request code ........................................................................ 9-13
Request fields........................................................................ 9-13
Response code ....................................................................... 9-13
Response fields ...................................................................... 9-18
9.4 ListIPCANSessionSummary ............................................................ 9-24
Parameter ............................................................................ 9-24
Request code ........................................................................ 9-24
Request fields........................................................................ 9-25
Response code ....................................................................... 9-25
Response fields ...................................................................... 9-27
9.5 ListNASREQSessionSummary .......................................................... 9-35
Parameter ............................................................................ 9-35
Request code ........................................................................ 9-35
Request fields........................................................................ 9-36
Response code ....................................................................... 9-36
Response fields ...................................................................... 9-37
9.6 ListSubscribersCrossedThreshold .................................................... 9-40
Parameter ............................................................................ 9-40
Request code ........................................................................ 9-40
Request fields........................................................................ 9-41
Response code ....................................................................... 9-41
Response fields ...................................................................... 9-42
9.7 ListSYSessionSummary................................................................. 9-43
Parameter ............................................................................ 9-44
Request code ........................................................................ 9-44
Request fields........................................................................ 9-44
Response code ....................................................................... 9-44
Response fields ...................................................................... 9-46
10 — System API 10-1

10.1 Using the system API................................................................... 10-2
10.2 exportPcrfSystemConfiguration...................................................... 10-2
Parameters ........................................................................... 10-2
Request code ........................................................................ 10-2
Request fields........................................................................ 10-3
Response code ....................................................................... 10-3
Response fields .................................................................... 10-11
10.3 exportSystemConfiguration......................................................... 10-11
Parameter .......................................................................... 10-11
Request code ...................................................................... 10-11
Response code ..................................................................... 10-11
Response fields .................................................................... 10-19
xxx May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Contents
10.4 importSystemConfiguration......................................................... 10-20

Parameter .......................................................................... 10-20
Request code ...................................................................... 10-20
Request fields...................................................................... 10-33
Response code ..................................................................... 10-33
11 — Ud Notification API 11-1

11.1 Using the Ud notification API......................................................... 11-2
Error codes ........................................................................... 11-2
11.2 notification.............................................................................. 11-3
Parameters ........................................................................... 11-3
SOAP message envelope header .................................................. 11-3
Request code ........................................................................ 11-4
Request fields........................................................................ 11-4
Response code ....................................................................... 11-5
Response fields ...................................................................... 11-5
12 — RESTFul API reference 12-1

12.1 5780 DSC RESTful API overview ...................................................... 12-2
Application QoS Integration using RESTful APIs ................................ 12-2
A. Differences in the API A-1

A.1 Differences between the 4.0 and 5.1 API ........................................... A-2
Subscriber provisioning API ......................................................... A-2
NASREQ and IP-CAN session APIs ................................................... A-2
Subscriber profile provisioning API ................................................ A-2
Reporting APIs ........................................................................ A-2
System APIs ........................................................................... A-2
Ud API .................................................................................. A-2
Af Session API ......................................................................... A-3
Sy Session API ......................................................................... A-3
Rule provisioning API ................................................................ A-3
Streaming reporting API ............................................................. A-3
A.2 Differences between the 5.0 and 5.1 API ........................................... A-3
Streaming reporting API ............................................................. A-3
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxxi
Contents
xxxii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
1— 5780 DSC API reference
1.1 5780 DSC API overview 1-2
1.2 5780 DSC provisioning web services API overview 1-2
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-1
1 — 5780 DSC API reference
1.1 5780 DSC API overview
The 5780 DSC provides both a provisioning web services API (4.0, 5.0, and 5.1 Web
provisioning services) and a RESTful API.
Communication between the 5780 DSC and the client occurs over a secure
connection using HTTPS on port 8443. However, you can change to HTTP if
security between the 5780 DSC and the client is not an issue.
Chapters 2 through 11 describe the 5.1 web services API. Appendix A describes any
differences with previous versions of the corresponding API.
1.2 5780 DSC provisioning web services API overview
This section describes the 5780 DSC APIs for the following provisioning web
services:
• AF session provisioning
• IP-CAN session provisioning
• NASREQ session provisioning
• Rule system provisioning
• Streaming reporting
• Subscriber profile provisioning
• Subscriber provisioning
• Sy session provisioning
• System
• Ud notifications
For all get and update operations, userId takes precedence over all parameters to
search for the correct subscriber. If accountid exists, it takes precedence over all
other parameters.
Note 1 — In a distributed configuration, all OSS requests must be sent
only to the CSB. The system automatically applies all APIs as
required to all clusters.
Note 2 — In all configurations, local and geo-redundancy handles
replicating the information as required to redundant blades.
Table 1-1 shows the URL locations for the API services. The services can be
accessed (sending requests) by using the URLs shown in Table 1-1 by excluding the
suffix “?wsdl” (where applicable).
The provisioning web services are JAX-WS based, with the exception of the
streaming reporting service which is a plain web service (that is, there is no WSDL).
The requests and responses for the streaming reporting service are SOAP based and
the schema for these is published at
/opt/tpa/schemas/dsc51/ReportingAPISchema.xsd.
The Ud notifications API does not provide a wsdl or schema but is based on 3GPP
TS 29.335 User Data Convergence (UDC) V11.0.0 (2012-09).
1-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
Table 1-1 Operation url locations
API name API Description WSDL

version included
Streaming reporting 5.1 http://[host]/reporting/streaming/dsc51 no
System configuration 5.1 http://[host]/systemapi/51?wsdl yes
Rule system provisioning 5.1 http://[host]/provisioningapi/51/rulesystem?wsdl yes
IP-CAN session 5.1 http://[host]/provisioningapi/51/session/ipcan?wsdl yes
NASREQ session 5.1 http://[host]/provisioningapi/51/session/nasreq?wsdl yes
AF session 5.1 http://[host]/provisioningapi/51/session/af?wsdl yes
Sy session 5.1 http://[host]/provisioningapi/51/session/sy?wsdl yes
System 5.1 http://[host]/systemapi/51?wsdl yes

Subscriber profile provisioning 5.1 http://[host]/provisioningapi/51/subscriberprofile?wsdl yes
Subscriber provisioning 5.1 http://[host]/provisioningapi/51/subscriber?wsdl yes
Ud notifications 5.1 http://[host]/notifications/_3gpp/udfe/V11.0.0 no
Note 1 — For all get and update operations, userId takes precedence
over all operations to search for the correct subscriber. However, if
userId is not provided, then subscriptionId takes precedence over all
other search operations. If accountid exists, it takes precedence over
all other parameters.
SubscriptionIds are used in the order provided until a valid one is
found.
Note 2 — Use the Streaming API rather than the Reporting API as the
Reporting API has been removed.
Note 3 — If an incorrect enumeration value is entered, the default
value is used (if one exists). However, an error message is not sent to
indicate that an incorrect value was entered.
Note 4 — Enumeration values are case-sensitive as defined in the
WSDL or XSD. For example, subscriberState would be entered as
ENABLED, not as enabled or Enabled.
Within the API, these services are described by xml messages:

• Every API operation has a request and response message
• Every xml message is sent in UTF-8 encoding
These services group together operations that are related with each other and each
service operation serves SOAP request messages (with information such as request
identifier and filter criteria, if any) as input and responds to them with a SOAP
message. Only SOAP 1.1 is supported.
Versioning of objects and APIs

The objects used in the web services APIs are versioned to be inline with the version
of the respective web services API.
5780 DSC APIs

The 5780 DSC API services and operations shown in Table 1-2 are compatible with
5780 DSC Release 5.1 R4.
Note — 5780 DSC Product Release in Table 1-2 indicates the

product release in which the API operation was last changed, added,
or deleted.
Table 1-2 Provisioning web service APIs
Service Operations 5780 DSC Product Release* Description
4.0 API 5.0 API 5.1 API
Subscriber addAccount — — 5.1R1 Adds an account.

provisioning
addSubscriber 4.0R1 — 5.1R1 Adds a subscriber.
clearPenaltyPeriod — — 5.1R1 Resets the penalty period for a given subscriber
for a given metering limit (if any).
getAccount — — 5.1R1 Gets the specified account.
getAccountCustomData — — 5.1R1 Gets the set of custom data objects from the
account.
getAccountCustomDataProfiles — — 5.1R1 Gets the list of custom data profiles assigned to

the account.
getAllowOverage 4.0R1 — 5.1R1 Gets the overage allow flag from the account.
getCategory 4.0R1 — 5.1R1 Gets the category from the subscriber object.
getCustomData 4.0R1 — 5.1R1 Gets the set of custom data objects from the
subscriber.
getCustomDataProfiles 4.0R1 — 5.1R1 Gets the list of custom data profiles assigned to
the subscriber.
getMeteringLimits 4.0R1 — 5.1R1 Returns the names of the metering limits

assigned to the subscriber.
getNotification 4.0R1 — 5.1R1 Gets the notification configuration data from the
subscriber object.
getResetDayOfMonth — — 5.1R1 Gets monthly resets, which represents the day of
the month that the usage is reset.
getResetDayOfWeek — — 5.1R1 Gets weekly resets, which can occur on any day
of the week that you configure at a specified
time.
getResetHourOfDay — — 5.1R1 Gets hour of day, which must be configured for

any reset, whether a day of the week or month.
getSubProfileNames 4.0R1 — 5.1R1 Gets the list of subscriber profile names assigned
to the subscriber.
getSubscriber 4.0R1 — 5.1R1 Returns a fully populated subscriber object.
getSubscriberState 4.0R4 — 5.1R1 Returns the subscriber state.
getSubscriptionIds 4.0R1 — 5.1R1 Gets the subscription ids from the subscriber
object.
(1 of 6)
4.0 API 5.0 API 5.1 API
Subscriber getUnknownSubscriber 4.0R1 — 5.1R1 Gets the known/unknown status of the

provisioning subscriber.
(continued)
getUsage 4.0R1 — 5.1R1 Gets the usage data from a specified subscriber
object.
removeAccount — — 5.1R1 Removes the specified account and the

associated subscriber.
removeSubscriber 4.0R1 — 5.1R1 Removes the specified subscriber object.
resetUsage 4.0R1 — 5.1R1 Resets the usage data to zero for the specified
subscriber object.
updateAccount — — 5.1R1 Updates the specified account.
updateAccountCustomData — — 5.1R1 Updates all custom data entries for the account.
updateAccountCustomDataEntry — — 5.1R1 Updates the specified custom data entry for the
account.
updateAccountCustomDataProfiles — — 5.1R1 Updates the entire list of data profiles for the
account.
updateAllowOverage 4.0R1 — 5.1R1 Updates the allow overage flag within the
subscriber object.
updateCategory 4.0R1 — 5.1R1 Updates the category of the subscriber.
updateCustomData 4.0R1 — 5.1R1 Updates all custom data entries for the
subscriber.
updateCustomDataEntry 4.0R1 — 5.1R1 Updates the specified custom data entry for the
subscriber.
updateCustomDataProfiles 4.0R1 — 5.1R1 Updates the entire list of data profiles for the
subscriber.
updateMeteringLimitEntry — — 5.1R1 Updates a metering limit while preserving usage.
updateMeteringLimits 4.0R1 — 5.1R1 Updates the entire list of metering limits

associated with the subscriber.
updateNotification 4.0R1 — 5.1R1 Updates the notification configuration data for

the subscriber.
updateResetDayOfMonth — — 5.1R1 Updates monthly resets, and represents the day

of the month that the usage is reset.
updateResetDayOfWeek — — 5.1R1 Updates weekly resets, which can occur on any
day of the week that you configure at a specified
time.
updateResetHourOfDay — — 5.1R1 Updates hour of day, which must be configured

for any reset, whether a day of the week or
month.
updateSubProfileNames 4.0R1 — 5.1R1 Updates the list of subscriber profiles assigned to

the subscriber.
updateSubscriber 4.0R1 — 5.1R1 Updates the specified subscriber object by
replacing the existing values with those
specified.
updateSubscriberState 4.0R4 — 5.1R1 Updates the subscriber state.
(2 of 6)
4.0 API 5.0 API 5.1 API
Subscriber updateSubscriptionId 4.0R1 — 5.1R1 Updates the subscriber by replacing the specified
provisioning old subscription id with the specified new
(continued) subscription id.
updateSubscriptionIds 4.0R1 — 5.1R1 Updates the subscriber by replacing the existing

set of subscription ids with the specified new set
of subscription ids.
updateUnknownSubscriber 4.0R1 — 5.1R1 Updates a subscriber to change the status from

unknown to known.
Subscriber addCalledStationIdEntry 4.0R3 — 5.1R1 Adds a called station Id entry to the subscriber
profile profile object.
provisioning
addSubscriberProfile 4.0R3 — 5.1R1 Adds a subscriber profile object.
getAFApplications 4.0R3 — 5.1R1 Gets the list of AF applications from the
subscriber profile object.
getCalledStationIds 4.0R3 — 5.1R1 Gets the list of called station Ids from the
getQciGuaranteedBitRates 4.0R3 — 5.1R1 Gets the list of QCI guaranteed bit rates from the
getQciMaxBitRates 4.0R3 — 5.1R1 Gets the list of QCI maximum bit rates from the
getSubscriberProfile 4.0R3 — 5.1R1 Gets the subscriber profile object.
getSubscriberProfileCustomData 4.0R3 — 5.1R1 Gets the set of custom data entries from the
getSubscriberProfileCustomDataProfiles — — 5.1R1 Gets the set of custom data profiles from the
removeSubscriberProfile 4.0R3 — 5.1R1 Removes the subscriber profile object.
updateAFApplicationEntry 4.0R3 — 5.1R1 Updates the specified AF application entry for

the subscriber profile object.
updateAFApplications 4.0R3 — 5.1R1 Updates all the AF application entries for the
updateCalledStationIds 4.0R3 — 5.1R1 Updates the complete list of called station Ids for
the subscriber profile object.
updateQciGuaranteedBitRateEntry 4.0R3 — 5.1R1 Updates the specified QCI guaranteed bit rate
entries for the subscriber profile object.
updateQciGuaranteedBitRates 4.0R3 — 5.1R1 Updates the complete set of QCI guaranteed bit
rate entries for the subscriber profile object.
updateQciMaxBitRateEntry 4.0R3 — 5.1R1 Updates the specified QCI maximum bit rate
entries for the subscriber profile object.
updateQciMaxBitRates 4.0R3 — 5.1R1 Updates the complete set of QCI maximum bit
rate entries for the subscriber profile object.
updateSubscriberProfile 4.0R3 — 5.1R1 Updates the specified subscriber profile object

by replacing the existing value with those
specified.
updateSubscriberProfileCustomData 4.0R3 — 5.1R1 Updates the complete set of subscriber profile
custom data entries for the subscriber profile
object.
(3 of 6)
4.0 API 5.0 API 5.1 API
Subscriber updateSubscriberProfileCustomDataEntry 4.0R3 — 5.1R1 Updates the specified subscriber profile custom
profile data entry for the subscriber profile object.
provisioning
(continued) updateSubscriberProfileCustomDataProfiles — — 5.1R1 Updates the specified subscriber profile custom
data profile for the subscriber profile object.
Rule system activateRuleSystemVersion 4.0R1 — 5.1R1 Activates the specified rule system version.
provisioning
addCustomDataProfiles 4.0R3 — 5.1R1 Adds a custom data profile object.
addMeteringLimits 4.0R1 — 5.1R1 Adds a metering limit object.

cloneRuleSystemVersion 4.0R1 — 5.1R1 Creates a new rules system version with the
specified name and data copied from the
specified existing rules system version.
exportRuleSystemVersion — — 5.0R5 Exports all of the rules as a text-formatted rule

system version from the 5780 DSC to your local
directory.
getActiveRuleSystemVersionName — — 5.1R2 Gets the active rule system version by the name
specified.
getCustomDataProfile 4.0R3 — 5.1R1 Gets a fully populated custom data profile

object.
getCustomDataProfile_CustomData 4.0R3 — 5.1R1 Gets the complete set of custom data entries
from the custom data profile object.
getCustomDataProfilePriority 4.0R3 — 5.1R1 Gets the priority from the custom data profiles
object.
getMeteringLimit 4.0R1 — 5.1R1 Returns a fully populated metering limit object.

getMeteringLimitApplicabilityConditions 4.0R1 — 5.1R1 Returns the complete set of applicability
conditions for the metering limit object.
getMeteringLimitDefaultActions — — 5.1R1 Returns the complete set of default actions for

the metering limit object.
getMeteringLimitNames — — 5.1R3 Returns the names of metering limits for a

specific rule system version.
getMeteringLimitPriority 4.0R1 — 5.1R1 Returns the priority of the metering limit.
getMeteringLimitQuota 4.0R1 — 5.1R1 Returns the quota for the metering limit object.
getMeteringLimits 4.0R4 — 5.1R1 Returns all the metering limits for the active rule
system version.
getRuleSystemVersion 4.0R4 — 5.1R1 Returns all of the metering limits for the active
rule system version.
getRuleSystemVersionDescription 4.0R1 — 5.1R1 Gets the description of the rule system version
getRuleSystemVersionNames — — 5.1R1 Gets the name of the rule system version.
importRuleSystemVersion 4.0R1 — 5.1R1 Imports an XML formatted rule system

configuration to the 5780 DSC.
removeCustomDataProfile 4.0R3 — 5.1R1 Removes the specified custom data profile.
removeMeteringLimit 4.0R1 — 5.1R1 Removes the specified meteringLimits from the

specified subscriber object.
removeRuleSystemVersion 4.0R1 — 5.1R1 Removes the specified rule system version.
(4 of 6)
4.0 API 5.0 API 5.1 API
Rule system updateCustomDataProfile 4.0R3 — 5.1R1 Updates a fully populated custom data profile
provisioning object by replacing the existing version with the
(continued) one provided.
updateCustomDataProfile_CustomData 4.0R3 — 5.1R1 Updates the complete set of custom data entries
from the custom data profile object.
updateCustomDataProfile_CustomDataEntry 4.0R3 — 5.1R1 Updates the specified custom data entry for the
custom data profile object.
updateCustomDataProfilePriority 4.0R3 — 5.1R1 Updates the priority from the custom data
profiles object.
updateMeteringLimit 4.0R1 — 5.1R1 Updates the specified metering limit object by

replacing the existing version with the one
provided.
updateMeteringLimitApplicabilityConditions 4.0R1 — 5.1R1 Updates the complete set of applicability

conditions for the metering limit.
updateMeteringLimitDefaultActions 4.0R1 — 5.1R1 Updates the complete set of default actions for
the metering limit.
updateMeteringLimitPriority 4.0R1 — 5.1R1 Updates the priority for the metering limit.
updateMeteringLimitQuota 4.0R1 — 5.1R1 Updates the quota for the metering limit.
updateMeteringLimitRateLimitRate 4.0R1 — 5.1R1 Updates the rate within a specified rating limit
for the metering limit.
updateRuleSystemVersionDescription 4.0R1 — 5.1R1 Updates the description of the rule system

version.
NASREQ bindSubscriber 4.0R1 — 5.1R1 Binds a subscriber to a NASREQ session.

session
disconnectSession 4.0R3 — 5.1R1 Disconnects a NASREQ session.
getSession 4.0R1 — 5.1R1 Gets a fully populated NASREQ session.
getSessionSummary 4.0R1 — 5.1R1 Gets a summary of the NASREQ session.
IP-CAN getSession 4.0R4 — 5.1R1 Gets a fully populated IP-CAN session.

session
getSessionSummary 4.0R4 — 5.1R1 Gets a summary of the IP-CAN session.
AF session getSession — — 5.1R2 Gets a fully populated AF session.
getSessionSummary — — 5.1R2 Gets a shortened summary of the AF session.

Sy session getSession — — 5.1R2 Gets a fully populated Sy session.
Reporting listNASREQSessions 4.0R3 — Removed Returns a list of NASREQ session summaries.
listSubscribers 4.0R3 — Removed Returns a list of subscriber objects.
listSubscribersCrossedThreshold 4.0R3 — Removed Returns a list of subscription ids for subscribers

that have crossed a metering limit threshold.
(5 of 6)
4.0 API 5.0 API 5.1 API
Streaming ListAccountsWithFilter — — 5.1R1 Returns a list of accounts information based on

reporting the given filter.
ListAFSessionSummary 5.0R5 5.1R2 Returns a list of AF session summaries for all AF

sessions.
ListIPCANSessionSummary — 5.0R5 5.1R2 Returns a list of IP-CAN session summaries for all
IP-CAN sessions.
ListNASREQSessionSummary — 5.0R2 5.1R1 Returns a list of NASREQ session summaries.
ListSubscribersCrossedThreshold — 5.0R2 5.1R1 Returns a list of subscription ids for subscribers

that have crossed a metering limit threshold.
ListSubscribers — 5.0R2 Deprecated Returns a list of subscriber objects.
ListSubscribersWithFilter — 5.0R2 Deprecated Returns a list of subscriber information based on

the given filter.
ListSYSessionSummary — 5.0R5 5.1R2 Returns a list of Sy session summaries for all Sy

sessions.
System exportPcrfSystemConfiguration — 5.0R5 5.1R2 Returns the reference PCRF default system
configuration if the request is addressed to the
CSB, or returns the local PCRF default system
configuration if the request is addressed to the
PCRF.
exportSystemConfiguration — 5.0R5 5.1R2 Returns the local CSB system configuration if the
request is addressed to the CSB, or returns the
local PCRF system configuration if the request is
addressed to the PCRF.
importSystemConfiguration — — 5.1R2 Imports the local CSB system configuration if the

request is addressed to the CSB, or imports the
local PCRF system configuration if the request is
Ud notification — — 5.1R2 The 5780 DSC Ud implementation in Release 5.1

R2 is limited to notification.
(6 of 6)
Failure response handling

A failure in a call results in a message containing an error code and description
similar to the example shown in 1-1. The error codes and messages are the same as
those currently documented for use in the GUI. See the 5780 DSC Error Messages
Reference for more information.
Code 1-1: Error Code Example

<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>The rule system version being updated is
flagged as read-only.</faultstring>
<detail>
<ns:OperationFailedException
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesyste
m/"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
">
<ns:code>RULE_00041</ns:code>
<ns:message>The rule system version being updated is
flagged as read-only.</ns:message>
</ns:OperationFailedException>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>
Under some scenarios in distributed systems, the error message response may
indicate that the request was unable to successfully complete on all components
within the distributed system. If this occurs, correct the component failure and then
operator should manually handle it based on the operation type as follows:
• Delete—retry the delete operation
• Create—delete the object from GUI and then retry the create operation
• Modify—retry the modification operation. However, if subscriber modification
was related to transitioning the subscriber from known to unknown, the
correction procedure would be to add the subscriber back. Verify the correction
by performing the getSubscriber using the userId.
Note — If an invalid value is specified for an Enum or Boolean

attribute Type, the 5780 DSC replaces this value with the default
value and processes the request.
Header information
Table 1-3 describes the header information used in the examples shown in this guide.
These fields are not used by the server and are for informational purposes only, but
can be used to aid in debugging problems. The format and content are determined by
the client.
Table 1-3 Header field descriptions
Field Description Type Qualifier
clientAppId Information about the identity and version of the Values: ranges vary Mandatory
client. Type: string
Default: n/a
requestId The requestId property contains an identifier for the Values: ranges vary Mandatory
request. Type: string
Default: n/a
API versions
The version number of the API services change when there is a change in the service
definition.
A major version change implies that a client using the previous version of the API
will be impacted if wanting to use the new version of the API (client code changes
may be required). A minor version number change implies that a client using a
previous version of the API will be able to use the new version with no impact;
however, client code changes would be required to make use of any new
functionality.
2— Subscriber provisioning API
2.1 Using the subscriber provisioning API 2-4
2.2 addAccount 2-4
2.3 addSubscriber 2-10
2.4 clearPenaltyPeriod 2-16
2.5 getAccount 2-18
2.6 getAccountCustomData 2-28
2.7 getAccountCustomDataProfiles 2-31
2.8 getAllowOverage 2-34
2.9 getCategory 2-36
2.10 getCustomData 2-39
2.11 getCustomDataProfiles 2-42
2.12 getMeteringLimits 2-45
2.13 getNotification 2-48
2.14 getResetDayOfMonth 2-51
2.15 getResetDayOfWeek 2-53
2 — Subscriber provisioning API
2.16 getResetHourOfDay 2-56
2.17 getSubProfileNames 2-59
2.18 getSubscriber 2-62
2.19 getSubscriberState 2-68
2.20 getSubscriptionIds 2-71
2.21 getUnknownSubscriber 2-74
2.22 getUsage 2-77
2.23 removeAccount 2-81
2.24 removeSubscriber 2-84
2.25 resetUsage 2-86
2.26 updateAccount 2-89
2.27 updateAccountCustomData 2-95
2.28 updateAccountCustomDataEntry 2-99
2.29 updateAccountCustomDataProfiles 2-103
2.30 updateAllowOverage 2-106
2.31 updateCategory 2-108
2.32 updateCustomData 2-111
2.33 updateCustomDataEntry 2-115
2.34 updateCustomDataProfiles 2-119
2.35 updateMeteringLimitEntry 2-121
2.36 updateMeteringLimits 2-124
2.37 updateNotification 2-127
2.38 updateResetDayOfMonth 2-129
2.39 updateResetDayOfWeek 2-132
2.40 updateResetHourOfDay 2-135
2.41 updateSubProfileNames 2-138
2.42 updateSubscriber 2-141
2.43 updateSubscriberState 2-147
2.44 updateSubscriptionId 2-150
2.45 updateSubscriptionIds 2-155
2.46 updateUnknownSubscriber 2-158
2.1 Using the subscriber provisioning API
The subscriber provisioning API is used to perform operations related to subscriber

provisioning, such as adding, updating, and removing subscribers and information
related to the subscriber provisioning.
2.2 addAccount
Adds the specified account.
Parameter
• account
Indicates the account to be added.
Request code
Code 2-1 shows a request code example for the addAccount command.
Code 2-1: addAccount request code example

<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:com="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:sub="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riber">
<soapenv:Header>
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:addAccount>

<sub:account>
<sub:accountId>accnew1</sub:accountId>

<sub:resetDayOfMonth>1</sub:resetDayOfMonth>

<sub:resetDayOfWeek>SUNDAY</sub:resetDayOfWeek>

<sub:resetHourOfDay>0</sub:resetHourOfDay>

<sub:subscribers>

<sub:subscriber>

<sub:userId>subnew1</sub:userId>

<sub:category>gold</sub:category>

<sub:password>pass123</sub:password>

<sub:description>subnew1 desc</sub:description>

<sub:unknownSubscriber>false</sub:unknownSubscribe
r>

<sub:state>ENABLED</sub:state>

<sub:subscriptionIds>
<sub:subscriptionId>
<sub:value>33012000091223</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriptionIds>

<sub:notificationConfig>

<sub:emailAddress/>

<sub:mobileNumber/>
<sub:notifyableByEmail>false</sub:notifyableByE
mail>
<sub:notifyableBySMS>false</sub:notifyableBySMS
>
</sub:notificationConfig>

<sub:allowOverage>true</sub:allowOverage>
<sub:syOCSEnabled>false</sub:syOCSEnabled>

<sub:subscriberProfiles>
<sub:subscriberProfile>subprofile1</sub:subscri
berProfile>
</sub:subscriberProfiles>

<sub:customData>
<sub:item>
<sub:name>CD1</sub:name>
<sub:value>
<sub:type>STRING</sub:type>
<sub:data>CD1</sub:data>
</sub:value>
</sub:item>
</sub:customData>

<sub:customDataProfiles>
<sub:customDataProfile>CDF1</sub:customDataProf
ile>
</sub:customDataProfiles>
</sub:subscriber>
</sub:subscribers>

<sub:meteredServices>

<sub:meteringLimitName>ml1</sub:meteringLimitName>
</sub:meteredServices>

<sub:customData>
<sub:item>
<sub:name>ACCCD2</sub:name>
<sub:value>
<sub:data>ACCCD2</sub:data>
</sub:value>
</sub:item>
</sub:customData>

<sub:customDataProfile>cdf1</sub:customDataProfile>
</sub:account>
</sub:addAccount>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-1 lists the subfields as required for the addAccount command.
Table 2-1 account field descriptions
accountid The unique identifier or name for the account. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
resetDayOfMonth Represents the billing day of the month for the account and Values: 1 to 31 Optional
also the day the monthly-based limits will be reset. Type: integer
Default: 1
resetDayOfWeek Used for weekly resets, which can occur on any day of the week Values: Optional
that you configure at a specified time. • SUNDAY
ResetDayOfWeek is for weekly resets and has no affect on • MONDAY
monthly resets. You must also configure the resetHourOfDay • TUESDAY
parameter to the time of day that you want the reset.
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
Default: SUNDAY
(1 of 4)
resetHourOfDay ResetHourOfDay must be configured for any reset, whether a Values: 0-24 Optional
day of the week or month. The reset time can be configured as Type: enum
follows:
Default: 0
• 0—which is equal to 0:00 and indicates the beginning of the
day (default)
• 1 to 23—which is equal to the hours 01:00 to 23:00 for any
time during the day
• 24—which is equal to 24:00 and indicates the end of the
day
subscribers Defines the subscriber associated with this account. — Mandatory

See Table 2-2 for a description of the following fields
associated with a subscriber.
• accountid
• userId
• category
• password
• description
• unknownSubscriber
• state
• subscriptionIds
• notificationConfig
• allowOverage
• syOCSEnabled
• subscriberProfiles
• customData
• customDataProfiles
meteredServices Defines a list of one or more metered service entries. A — Optional

metered service is defined by the metering limit name.
meteringLimitName Values: 1 to 80 characters Optional
Metering limit name to be assigned to the account. Type: string80Type
Default: n/a
(2 of 4)
customData Defines a list of one or more custom data entries (item). — Optional
item — —
Defines the custom data used for a single custom data entry
based on:
• name
• value
name Values: 1 to 16 characters Mandatory within each

A unique identifier for the custom data. Type: string item.
Default: n/a
value — Mandatory within each

Defines the value of the item using:. item.
• type
• data
type Values: Mandatory within each
Type of data held in the custom data item. • STRING item.
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
Default: no default value set
(3 of 4)
customData (continued) data Values: Dependant on the Type Mandatory within each
Contains the data for the custom data item value. Valid values selected. item.
include: Type: string
• STRING Default: no default value set
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
STRING
Contains a text string of the exact value that you require for
the action.
Values: Up to 256000 characters.
IP_ADDRESS
Contains a single IP address in any of the accepted formats for
an IP address.
Values: For a list of the supported formats, see the chapter
“Configuring and managing subscribers in the SPR” in the
5780 DSC User Guide.
LIST
List is an option for each of the following:
• String
• IP Address
Values: The encoded value must be under 256 000 characters.

ENUM
Enumeration types are pre-defined in the system and are
available depending on the Criteria attribute that you chose.
Values: For a list of the supported formats, see the 5780 DSC
User Guide.
NUMBER
Contains any whole number.
Values: Any whole number between -(263) and 263 - 1
DECIMAL
Contains any number with a decimal.
Values: Any number that contains a decimal, for example:
1.0456.
customDataProfiles Defines a list of zero or more custom data profile names that Default: Empty list Optional
are applied to the account.
customDataProfiles Values: 1 to 80 characters Optional
The name of a custom data profile. Type: string
Default: n/a
(4 of 4)
Response code
Code 2-2 shows the response code for the addSubscriber command.
Code 2-2: addAccount Response

<env:Header/>
<env:Body>
<addAccountResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
2.3 addSubscriber
Adds a subscriber object. The metering limits that have been configured in System
Preferences are automatically added to the subscriber object, along with any others
that are specified in the request.
If a tag is missing, the attribute is set to the default value provided by the 5780 DSC,
which is usually null unless otherwise indicated. See the tables in this guide for
default values.
If a tag is specified but is left empty, the system will attempt to set the attribute to an
empty value. If the value cannot be set to an empty value, an error message is
returned. An attribute with a default value that is not null cannot be set to empty.
Note — When adding a new subscriber through the addSubscriber

API, if there are multiple existing “unknown” subscribers that share
Subscription Ids with the new subscriber, the “unknown” subscribers
are merged into the new “known” subscriber. In addition, when the
subscribers are merged, the account name is updated too.
Sessions associated with the merged subscribers are updated
accordingly and SPR update rules are triggered. This is not supported
for distributed systems if more than one unknown subscriber object
exists on different pcrf blades that match this new subscriber.
Parameter
• subscriber
Indicates the subscriber record to be added.
Request code
Code 2-3 shows a request code example for the addSubscriber command.
Code 2-3: addSubscribers request code example

<soapenv:Envelope
n"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscr
iber">
<soapenv:Header>
<ns1:header>
<ns1:clientAppId>4821</ns1:clientAppId>
<ns1:requestId>396321</ns1:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:addSubscriber>

<ns:subscriber>

<ns:accountId>ML2User</ns:userId>
<ns:userId>451131AB</ns:userId>

<ns:category>gold</ns:category>

<ns:password>!@123Abc</ns:password>

<ns:description>VIP customer</ns:description>

<ns:unknownSubscriber>false</ns:unknownSubscriber>


<ns:State>DISABLED</ns:State>
<ns:subscriptionIds>
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriptionIds>

<ns:notificationConfig>

<ns:emailAddress>johnsmith@abccompany.com</ns:emailAd
dress>

<ns:mobileNumber>6135551212</ns:mobileNumber>
<ns:notifyableByEmail>false</ns:notifyableByEmail>
<ns:notifyableBySMS>true</ns:notifyableBySMS>
</ns:notificationConfig>

<ns:allowOverage>true</ns:allowOverage>

<ns:subscriberProfiles>
<ns:subscriberProfile>Subprofile1</ns:subscriberProfi
le>
</ns:subscriberProfiles>

<ns:customData>
<ns:item>
<ns:name>CD1</ns:name>
<ns:value>
<ns:type>DECIMAL</ns:type>
<ns:data>999.999</ns:data>
</ns:value>
</ns:item>
</ns:customData>

<ns:customDataProfiles>
<ns:item>customProfile1</ns:item>
</ns:customDataProfiles>
</ns:subscriber>
</ns:addSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-2 lists the subfields for the subscriber parameter as required for the
addSubscriber command.
Table 2-2 subscriber field descriptions
accountid The unique identifier or name for the account. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a accountId, userId or
subscriptionId.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
category A predetermined level of service groupings or subgroupings for Values: 1 to 255 characters Optional
a subscriber (for example, Gold, Silver, or Bronze). Type: string
Default: null
password A case-sensitive password for the subscriber. Applies to Values: 1 to 128 characters Optional
NASREQ sessions only. Type: string
Default: null
description Information about the subscriber. Values: 0 to 255 characters Optional

Type: string
Default: null
unknownSubscriber Indicates an unknown subscriber. Values: false or true Optional

true Type: boolean
Indicates the subscriber is unknown. Default: false
false
Indicates the subscriber is known.
state Indicates the state of the subscriber. Values: DISABLED or ENABLED Optional
DISABLED Type: Enumerated
The state of the subscriber is disabled. Default: ENABLED
ENABLED
The state of the subscriber is enabled.
(1 of 4)
subscriptionIds Contains a list of subscription ids for this subscriber. Default: Empty list Optional
subscriptionId — Optional
The subscriptionId identifies the subscription based on a valid
subscriptionId type.
Multiple subscriptionIds can be specified; however, the
5780 DSC uses the first subscriptionId that matches a
subscriber.
The 5780 DSC uses the subscriptionId to match the incoming
network messages to the subscriber object. The subscriptionId
must exactly match the E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
value Values: Valid values as allowed Mandatory within

The identifier of the subscription. by the type; for example, subscriptionId.
sip:9251234567@example.com.
Type: string
Default: n/a
type Values: Mandatory within
The type of identifier that is carried by the associated value. • END_USER_E164 subscriptionId.
END_USER_E164 • END_USER_IMSI
International E.164 format (for example, MSISDN), according to • END_USER_SIP_URI
the ITU-T E.164 numbering plan defined in [E164] and [CE164]. • END_USER_NAI
END_USER_IMSI • END_USER_PRIVATE
End User IMSI format, according to the ITU-T E.212 numbering Type: enum
plan as defined in [E212] and [CE212].
Default: none
END_USER_SIP_URI
A SIP URI, as defined in [SIP].
END_USER_NAI
NAI format, as defined in [NAI].
END_USER_PRIVATE
A credit-control server private identifier.
notificationConfig Configuration used to determine how the 5780 DSC notification — Optional
is sent to the subscriber.
emailAddress Values: 1 to 80 characters; for Optional

The e-mail address of the subscriber to be notified according example,
to a metering limit, 9900 WNG policy, or 5780 DSC rule. johnsmith@Alcatel-Lucent.com
Type: string
Default: null
mobileNumber Values: 1 to 32 characters; for Optional

The mobile number of the subscriber to be notified by SMS example, 6135551212
according to a metering limit, 9900 WNG policy, or 5780 DSC Type: string
rule. Default: null
notifyableByEmail Values: true or false Optional

Notification is to be sent to the subscriber by e-mail. Type: boolean
Default: false
notifyableBySMS Values: true or false Optional

Notification is to be sent to the subscriber by SMS. Type: boolean
Default: true
(2 of 4)
allowOverage Indicates if overage is allowed for the subscriber. Values: true or false Optional
true Type: boolean
Allows overage Default: true
false
Disallows overage
subscriberProfiles List of subscriber profiles to be assigned to the subscriber. Default: Empty list Optional
subscriberProfile Values: 1 to 255 characters Optional

Name of subscriber profile. (case-sensitive)
Type: string
Default: n/a
item — —
based on:
• name
• value

Default: n/a

• type
• data
(3 of 4)
customData (continued) type Values: Mandatory within each

• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
data Values: Dependant on the Type Mandatory within each

Contains the data for the custom data item value. selected. item.
STRING Type: string
Contains a text string of the exact value that you require for Default: no default value set
the action.
Values: Up to 256000 characters
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
are applied to the subscriber.
item Values: 1 to 80 characters Optional

Default: n/a
(4 of 4)
Response code
Code 2-4 shows the response code for the addSubscriber command.
Code 2-4: addSubscriber Response

<env:Header/>
<env:Body>
<addSubscriberResponse
r"
"/>
</env:Body>
</env:Envelope>
2.4 clearPenaltyPeriod
Resets the penalty period for a given account for a given metering limit (if any).
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• meteringLimitName
Metering limit name to be assigned to the account.
Note — You must enter accountId, userId or subscriptionId. If

multiple identifiers are provided, only one is used. The order of
precedence is accountId, userId, subscriptionId.
Request code
Code 2-5 shows a request code example for the clearPenaltyPeriod command.
Code 2-5: clearPenaltyPeriod request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:clearPenaltyPeriod>



<sub:subscriberId>

<sub:userId>451131AB</sub:userId>

<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriberId>

<sub:meteringLimitName>ML</sub:meteringLimitName>
</sub:clearPenaltyPeriod>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-3 lists the fields required for the clearPenaltyPeriod command.
Table 2-3 clearPenaltyPeriod field descriptions
subscriptionId.
subscriberId userId Values: 1 to 32 characters Optional

The unique identifier or name for the subscriber. Type: string
Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a
(1 of 2)
subscriberId type Values: Mandatory within

(continued) The type of identifier that is carried by the associated value. • END_USER_E164 subscriptionId.
End User IMSI format, according to the ITU-T E.212 numbering
Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
meteringLimitName Metering limit name to be assigned to the subscriber. Values: 1 to 80 characters Optional
Type: string80Type
Default: n/a
(2 of 2)
Response code
Code 2-6 shows the response code for the clearPenaltyPeriod command.
Code 2-6: clearPenaltyPeriod response code

<env:Header/>
<env:Body>
<clearPenaltyPeriodResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.5 getAccount
Gets the specified account.
Parameters
• accountid
• subscriberId

Request code
Code 2-7 shows a request code example for the getAccount command.
Code 2-7: getAccount request code example

soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getAccount>

<sub:accountId>ML2User</sub:accountId>

<sub:subscriberId>


</sub:subscriberId>
</sub:getAccount>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-4 lists the fields required for the getAccount command.
Table 2-4 getAccount field descriptions
subscriptionId.

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-8 shows the response code for the getAccount command.
Code 2-8: getAccount response code

<env:Header/>
<env:Body>
<getAccountResponse
r"
n"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/common">
<account>
<accountId>accnew1</accountId>
<resetDayOfMonth>1</resetDayOfMonth>
<resetDayOfWeek>SUNDAY</resetDayOfWeek>
<resetHourOfDay>0</resetHourOfDay>
<subscribers>
<subscriber>
<accountId>accnew1</accountId>
<userId>subnew1</userId>
<category>gold</category>
<password>pass123</password>
<description>subnew1 desc</description>
<unknownSubscriber>false</unknownSubscriber>
<state>ENABLED</state>
<subscriptionIds>
<subscriptionId>
<value>33012000091223</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
<notificationConfig>
<emailAddress/>
<mobileNumber/>
<notifyableByEmail>false</notifyableByEmail>
<notifyableBySMS>false</notifyableBySMS>
</notificationConfig>
<allowOverage>true</allowOverage>
<syOCSEnabled>false</syOCSEnabled>
<subscriberProfiles>
<subscriberProfile>subprofile1</subscriberProfi
le>
</subscriberProfiles>
<customData>
<item>
<name>CD1</name>
<value>
<type>STRING</type>
<data>CD1</data>
</value>
</item>
</customData>
<customDataProfiles>
<customDataProfile>CDF1</customDataProfile>
</customDataProfiles>
</subscriber>
</subscribers>
<meteredServices>
<meteringLimitName>ml1</meteringLimitName>
</meteredServices>
<usageDataReport>
<usageData>
<subscriber>subnew1</subscriber>
<meteringLimit>ml1</meteringLimit>
<direction>TOTAL</direction>
<accumulatedUsage>0.0</accumulatedUsage>
<limit>1000.0</limit>
<usageType>REGULAR</usageType>
<nextScheduledReset>2012-11-01T00:00:00-04:00</nex
tScheduledReset>
</usageData>
</usageDataReport>
<customData>
<item>
<name>ACCCD2</name>
<value>
<type>STRING</type>
<data>ACCCD2</data>
</value>
</item>
</customData>
<customDataProfile>cdf1</customDataProfile>
</account>
</getAccountResponse>
</env:Body>
</env:Envelope>
Type: string
Default: n/a
Default: 1
monthly resets. You must also configure the resetHourOfDay
meter to the time of day that you want the reset.
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
Default: SUNDAY
(1 of 6)
follows:
Default: 0
day (default)
time during the day
day

• accountid
• userId
• category
• password
• description
• state
• subscriptionIds
• allowOverage
• syOCSEnabled
• customData
meteredservices Defines a list of one or more metered service entries. A — Optional

Metering limit name to be assigned to the subscriber. Type: string80Type
Default: n/a
usageDataReport Allows you to view the usage data report in its entirety on a — Optional
subscriber-by-subscriber basis.
(2 of 6)
usageDataReport subscriber — Optional

(continued) Indicates the subscriber record to be added.
• accountid
• userId
• category
• password
• description
• state
• subscriptionIds
• allowOverage
• syOCSEnabled
• customData
meteringLimit Values: 1 to 80 characters Optional

The metering limit name for which usage is processed. Type: string
direction Values: Optional

Specifies the direction of the usage as monitored or the type • UP_LINK
of unit as measured for the quota value for the metering limit.. • DOWN_LINK
Valid options are: • TOTAL
• DOWN_LINK • TIME
Usage monitored in the down link direction.
Type: enum
• TOTAL
Value usage monitored in both directions.
• UP_LINK
Usage monitored in the up link direction.
• TIME
Usage as a function of time monitored in both directions.
accumulatedUsage Values: Long values of up to a Optional

The usage accumulated for the metering limit since the last maximum of
reset. 4503599627370495, or 252. You
cannot enter 0 or a negative
value.
Type: double
(3 of 6)
usageDataReport limit Values: Optional

(continued) Identifies the quota value. • UP_LINK
Valid options are: • DOWN_LINK
• DOWN_LINK • TOTAL
Usage monitored in the down link direction. • TIME
• TOTAL Type: enum
• UP_LINK
• TIME
usageType Values: Optional

Identifies whether the usage amount is from a metering limit • REGULAR
that is tracking a carry-over or a regular usage. • CARRY_OVER
Type: enum
lastResetDate Values: date and time value; Optional

The date of the last reset. 2011-12-15T00:00:00-05:00
Type: dateTime
nextScheduledReset Values: date and time value; Optional

The date of the next scheduled usage rest for this metering 2011-12-15T00:00:00-05:00
limit. Type: dateTime
penaltyExpirationDate Values: date and time value; Optional

The date that the penalty expires. 2011-12-15T00:00:00-05:00
Type: dateTime
(4 of 6)
customData Defines a list of one or more custom — Optional

data entries (item).
cutomDataEntry — —
Defines the custom data used for a
single custom data entry based on:
• name
• value

A unique identifier for the custom Type: string item.
data. Default: n/a

• type
• data
Type of data held in the custom data • STRING item.
item. • IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(5 of 6)
Contains the data for the custom data selected. item.
item value. Valid values include: Type: string
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
STRING
Contains a text string of the exact
value that you require for the action.
IP_ADDRESS
Contains a single IP address in any of
the accepted formats for an IP
address.
Values: For a list of the supported
formats, see the chapter “Configuring
and managing subscribers in the SPR”
in the 5780 DSC User Guide.
LIST
List is an option for each of the
following:
• String
• IP Address
Values: The encoded value must be

under 256 000 characters.
ENUM
Enumeration types are pre-defined in
the system and are available
depending on the Criteria attribute
that you chose.
formats, see the 5780 DSC User Guide.
NUMBER
Values: Any whole number between
-(263) and 263 - 1
DECIMAL
Values: Any number that contains a
decimal, for example: 1.0456.
customDataProfiles Defines a list of zero or more custom Default: Empty list Optional
data profile names that are applied to
the subscriber.
customDataProfile Values: 1 to 80 characters Optional

Default: n/a
(6 of 6)
Note
(1) Note: If ResetDayOfWeek/ResetHourOfDay/ResetDayOfMonth is “NOT SET” (null) the response does not contain a line
showing that the value is null; instead, it ignores this line. This can be interpreted as the value being set to null. However,
if a value has been set, the line will be in the response. In addition, for the get object operation, the response contains
a line for the null valued attribute showing nil="true".
2.6 getAccountCustomData
Gets the set of custom data objects from the account.
Parameters
• accountid
• subscriberId

Request code
Code 2-9 shows a request code example for the getAccountCustomData command.
Code 2-9: getAccountCustomData request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getAccountCustomData>


<sub:subscriberId>


</sub:subscriberId>
</sub:getAccountCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-6 lists the fields required for the getAccountCustomData command.
Table 2-6 getAccountCustomData field descriptions
subscriptionId.
Default: n/a
subscriber.
• value
• type
Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-10 shows the response code for the getAccountCustomData command.
Code 2-10: getAccountCustomData response code

<env:Header/>
<env:Body>
<getAccountCustomDataResponse
r"
n"
<customData>
<name>ACCCD2</name>
<value>
<type>STRING</type>
<data>ACCCD2</data>
</value>
</customData>
</getAccountCustomDataResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-7 lists the fields for the getAccountCustomData command.
Table 2-7 getAccountCustomData response field descriptions
Field Description Type
customData Defines the custom data used for a single custom data entry —
based on:
• name
• value
name Values: 1 to 16 characters

A unique identifier for the custom data. Type: string
value —
Defines the value of the item using:
• type
• data
type Values:
Type of data held in the custom data item. • STRING
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData data Values: Dependant on the Type

(continued) Contains the data for the custom data item value. selected.
STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
Values: Any whole number between -(263) and 263 - 1.
DECIMAL
1.0456.
(2 of 2)
2.7 getAccountCustomDataProfiles
Gets the list of CustomDataProfiles assigned to the account.
Parameters
• accountid
• subscriberId

Request code
Code 2-11 shows a request code example for the getAccountCustomDataProfiles
command.
Code 2-11: getAccountCustomDataProfiles request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getAccountCustomDataProfiles>


<sub:subscriberId>


</sub:subscriberId>
</sub:getAccountCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-8 lists the fields required for the getAccountCustomDataProfiles command.
Table 2-8 getAccountCustomDataProfiles field descriptions
subscriptionId.

Default: n/a
(1 of 2)
subscriberId subscriptionId — Optional

(continued) The subscriptionId identifies the subscription based on a valid
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-12 shows the response code for the getAccountCustomDataProfiles
command.
Code 2-12: getAccountCustomDataProfiles response code example

<env:Header/>
<env:Body>
<getAccountCustomDataProfilesResponse
r"
n"
<customDataProfile>cdf1</customDataProfile>
</getAccountCustomDataProfilesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-9 lists the fields for the getAccountCustomDataProfiles command.
Table 2-9 getAccountCustomDataProfiles response field descriptions
Name Description Type
customDataProfile A unique name for the Custom Data Profile. Values: 1 to 80 characters
Type: string
2.8 getAllowOverage
Gets the allow overage flag from the subscriber object.
Parameter
• subscriberId
Note — You must enter userId or subscriptionId. If multiple

identifiers are provided, only one is used. The order of precedence is
userId, then subscriptionId.
Request code
Code 2-13 shows a request code example for the getAllowOverage command.
Code 2-13: getAllowOverage request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
<ns1:clientAppId>4821</ns:clientAppId>
<ns1:requestId>396321</ns:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getAllowOverage>

<ns:subscriberId>


<ns:subscriptionId>
<ns:value>31007012345678</ns:value>
<ns:type>END_USER_IMSI</ns:type>
</ns:subscriberId>
</ns:getAllowOverage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-10 lists the fields required for the getAllowOverage command.
Table 2-10 subscriberId field descriptions
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Default: n/a either userId or
subscriberId.
subscriptionId The subscriptionId identifies the subscription based on a valid — Optional

subscriptionId type. Note: You must enter
Multiple subscriptionIds can be specified; however, the either userId or
5780 DSC uses the first subscriptionId that matches a subscriberId.
subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-14 shows the response code for the getAllowOverage command.
Code 2-14: getAllowOverage response code

<env:Header/>
<env:Body>
<getAllowOverageResponse
r"
">
<allowOverage>true</allowOverage>
</getAllowOverageResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-11 lists the fields for the getAllowOverage command.
Table 2-11 allowOverage response field descriptions
allowOverage Indicates if overage is allowed for the Values: true or false

subscriber. Type: boolean
true
Allows overage
false
Disallows overage
2.9 getCategory
Gets the category from the subscriber object.
Parameter
• subscriberId

Request code
Code 2-15 shows a request code example for the getCategory command.
Code 2-15: getCategory request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getCategory>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getCategory>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-12 lists the fields for the getCategory command.

Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-16 shows the response code for the getCategory command.
Code 2-16: getCategory response code

<env:Header/>
<env:Body>
<getCategoryResponse
r"
">

<category>gold</category>
</getCategoryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-13 lists the fields for the getCategory command.
Table 2-13 getCategory response field descriptions
category A predetermined level of service groupings or Values: 1 to 255 characters

subgroupings for a subscriber (for example, Type: string
Gold, Silver, or Bronze).
2.10 getCustomData
Gets the set of custom data objects from the subscriber object.
Parameter
• subscriberId

Request code
Code 2-17 shows a request code example for the getCustomData command.
Code 2-17: getCustomData request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getCustomData>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-14 lists the fields required for the getCustomData command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-18 shows the response code for the getCustomData command.
Code 2-18: getCustomData response code

<env:Header/>
<env:Body>
<getCustomDataResponse
r"
">
<customData>
<name>CD1</name>
<value>
<type>DECIMAL</type>
<data>999.99</data>
</value>
</customData>
</getCustomDataResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-15 lists the fields for the getCustomData command.
Table 2-15 getCustomData response field descriptions
customData Defines the custom data used for a single custom data entry —
based on:
• name
• value

value —
• type
• data
type Values:
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)

STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
Values: Any whole number between -(263) and 263 - 1.
DECIMAL
1.0456.
(2 of 2)
2.11 getCustomDataProfiles
Gets the list of CustomDataProfiles assigned to the subscriber.
Parameter
• subscriberId

Request code
Code 2-19 shows a request code example for the getCustomDataProfiles command.
Code 2-19: getCustomDataProfiles request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getCustomDataProfiles>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-16 lists the fields required for the getCustomDataProfiles command.

Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-20 shows the response code for the getCustomDataProfiles command.
Code 2-20: getCustomDataProfiles response code example

<env:Header/>
<env:Body>
<getCustomDataProfilesResponse
r"
">
<customDataProfile>gold_customer_profile</customDataProfile
>
</getCustomDataProfilesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-17 lists the fields for the getCustomDataProfiles command.
Table 2-17 getCustomDataProfiles response field descriptions
customDataProfile A unique name for the Custom Data Profile. Values: 1 to 80 characters
Type: string
2.12 getMeteringLimits
Returns the names of the metering limits assigned to the account.
Parameters
• accountid
• subscriberId

Request code
Code 2-21 shows a request code example for the getMeteringLimits command.
Code 2-21: getMeteringLimits request code example

soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getMeteringLimits>


<sub:subscriberId>


</sub:subscriberId>
</sub:getMeteringLimits>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-18 lists the fields required for the getMeteringLimits command.
Table 2-18 getMeteringLimits field descriptions
subscriptionId.
(1 of 2)

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-22 shows the response code for the getMeteringLimits command.
Code 2-22: getMeteringLimits response code example

<env:Header/>
<env:Body>
<getMeteringLimitsResponse
r"
n"
</getMeteringLimitsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-19 lists the fields for the getMeteringLimits command.
Table 2-19 getMeteringLimit field descriptions
meteringLimit Name of the metering limit to be assigned to the Values: 1 to 255 characters
subscriber. Type: string
2.13 getNotification
Gets the notification configuration data from the subscriber object.
Parameter
• subscriberId

Request code
Code 2-23 shows a request code example for the getNotification command.
Code 2-23: getNotification request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getNotification>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getNotification>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-20 lists the fields required for the getNotification command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-24 shows the response code for the getNotification command.
Code 2-24: getNotification response code example

<env:Header/>
<env:Body>
<getNotificationResponse
r"
">

<notificationConfig>

<emailAddress>johnsmith@abccompany.com</emailAddress>

<mobileNumber>6135551212</mobileNumber>
<notifyableByEmail>false</notifyableByEmail>
<notifyableBySMS>true</notifyableBySMS>
</notificationConfig>
</getNotificationResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-21 lists the fields for the getNotification command.
Table 2-21 getNotification response field descriptions
notificationConfig Configuration used to determine how the 5780 DSC notification —

emailAddress Values: 1 to 80 characters; for
Type: string
mobileNumber Values: 1 to 32 characters; for

rule.
notifyableByEmail Values: true or false

notifyableBySMS Values: true or false
2.14 getResetDayOfMonth
Gets the account monthly reset day which represents the day of the month that the
usage is reset.
Parameters
• accountid
• subscriberId

Request code
Code 2-25 shows a request code example for the getResetDayOfMonth command.
Code 2-25: getResetDayOfMonth request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getResetDayOfMonth>


<sub:subscriberId>


</sub:subscriberId>
</sub:getResetDayOfMonth>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-22 lists the fields required for the getResetDayOfMonth command.
Table 2-22 getResetDayOfMonth field descriptions
subscriptionId.

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a
Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-26 shows the response code for the getResetDayOfMonth command.
Code 2-26: getResetDayOfMonth response code example

<env:Header/>
<env:Body>
<getResetDayOfMonthResponse
r"
n"
</getResetDayOfMonthResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-23 lists the fields for the getResetDayOfMonth command.
Table 2-23 getResetDayOfMonth response field descriptions
getResetDayOfMonth Gets monthly resets, and represents the day of the Values: 1 to 31
month that the usage is reset. Type: string
2.15 getResetDayOfWeek
Gets the account weekly reset day, which represents the day of the week that weekly
resets occur.
Parameters
• accountid
• subscriberId

Request code
Code 2-27 shows a request code example for the getResetDayOfWeek command.
Code 2-27: getResetDayOfWeek request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getResetDayOfMonth>


<sub:subscriberId>


</sub:subscriberId>
</sub:getResetDayOfMonth>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-24 lists the fields required for the getResetDayOfWeek command.
Table 2-24 getResetDayOfWeek field descriptions
subscriptionId.
(1 of 2)

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-28 shows the response code for the getResetDayOfWeek command.
Code 2-28: getResetDayOfWeek response code example

<env:Header/>
<env:Body>
<getResetDayOfWeekResponse
r"
n"
</getResetDayOfWeekResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-25 lists the fields for the getResetDayOfWeek command.
Table 2-25 getResetDayOfWeek response field descriptions
resetDayOfWeek Used for weekly resets, which can occur on any day of the week Values:
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
2.16 getResetHourOfDay
Gets the reset hour of day which represents the hour of day on which resets occur.
Parameters
• accountid
• subscriberId

Request code
Code 2-29 shows a request code example for the getResetHourOfDay command.
Code 2-29: getResetHourOfDay request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getResetHourOfDay>


<sub:subscriberId>


</sub:subscriberId>
</sub:getResetHourOfDay>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-26 lists the fields required for the getResetHourOfDay command.
Table 2-26 getResetHourOfDay field descriptions

subscriptionId.
(1 of 2)

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-30 shows the response code for the getResetHourOfDay command.
Code 2-30: getResetHourOfDay response code example

<env:Header/>
<env:Body>
<getResetHourOfDayResponse
r"
n"
</getResetHourOfDayResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-27 lists the fields for the getResetHourOfDay command.
Table 2-27 getResetHourOfDay response field descriptions
getResetHourOfDay ResetHourOfDay must be configured for any reset, whether a Values: 0-24
follows:
day (default)
time during the day
day
2.17 getSubProfileNames
Gets the list of subscriber profile names assigned to the subscriber.
Parameter
• subscriberId

Request code
Code 2-31 shows a request code example for the getSubProfileNames command.
Code 2-31: getSubProfileNames request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getSubProfileNames>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getSubProfileNames>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-28 lists the fields required for the getSubProfileNames command.

Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-32 shows the response code for the getSubProfileNames command.
Code 2-32: getSubProfileNames response code example

<env:Header/>
<env:Body>
<getSubProfileNamesResponse
r"
">
<subProfileName>gold_subscriber_profile</subProfileName>
</getSubProfileNamesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-29 lists the fields for the getSubProfileNames command.
Table 2-29 getSubProfileNames response field descriptions
subProfilename A unique name for the subscriber Values: 1 to 255 characters

profile. Type: string
2.18 getSubscriber
Returns a fully populated subscriber object.
Note — GetSubscriber does not return the subscriber usage

information. To return the subscriber usage information, use the
GetUsage command.
Parameter
• subscriberId

Request code
Code 2-33 shows a request code example for the getSubscriber command.
Code 2-33: getSubscriber request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getSubscriber>

<sub:subscriberId>

<sub:userId>ML2User</sub:userId>

</sub:subscriberId>
</sub:getSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-30 lists the fields required for the getSubscriber command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a
(1 of 2)
subscriptionId type Values: Mandatory within

(continued) The type of identifier that is carried by the associated value. • END_USER_E164 subscriptionId.
Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-34 shows a response code example for the getSubscriber command.
Code 2-34: getSubscriber command response code example

<env:Header/>
<env:Body>
<ns2:getSubscriberResponse
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riber"
n"
<ns2:subscriber>
<ns2:accountId>ML2User</ns2:accountId>
<ns2:userId>ML2User</ns2:userId>
<ns2:category>Gold</ns2:category>
<ns2:unknownSubscriber>false</ns2:unknownSubscriber>
<ns2:state>ENABLED</ns2:state>
<ns2:subscriptionIds>
<ns2:subscriptionId>
<ns2:value>33012000091</ns2:value>
<ns2:type>END_USER_IMSI</ns2:type>
</ns2:subscriptionId>
<ns2:value>0300091</ns2:value>
<ns2:type>END_USER_E164</ns2:type>
<ns2:value>nai3@3gppnetwork.com</ns2:value>
<ns2:type>END_USER_NAI</ns2:type>
</ns2:subscriptionIds>
<ns2:notificationConfig>
<ns2:emailAddress>test@hotmail.com</ns2:emailAddress>
<ns2:mobileNumber>12345</ns2:mobileNumber>
<ns2:notifyableByEmail>true</ns2:notifyableByEmail>
<ns2:notifyableBySMS>false</ns2:notifyableBySMS>
</ns2:notificationConfig>
<ns2:allowOverage>true</ns2:allowOverage>
<ns2:syOCSEnabled>false</ns2:syOCSEnabled>
<ns2:subscriberProfiles/>
<ns2:customData/>
<ns2:customDataProfiles/>
</ns2:subscriber>
</ns2:getSubscriberResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-31 lists the fields for the getSubscriber command.
Table 2-31 getSubscriber response field descriptions
accountid The unique identifier or name for the account. Values: 1 to 32 characters
Type: string
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
category A predetermined level of service groupings or subgroupings for Values: 1 to 255 characters
password A case-sensitive password for the subscriber. Applies to Values: 1 to 128 characters
description Information about the subscriber. Values: 0 to 255 characters
Type: string
unknownSubscriber Indicates an unknown subscriber. Values: false or true

true Type: boolean
Indicates the subscriber is unknown.
false
state Indicates the state of the subscriber. Values: DISABLED or ENABLED

The state of the subscriber is disabled.
ENABLED
(1 of 4)
subscriptionIds Contains a list of subscription ids for this subscriber. —
subscriptionId —
subscriber.
• value
• type
value Values: Valid values as allowed

The identifier of the subscription. by the type; for example,
Type: string
type Values:
The type of identifier that is carried by the associated value. • END_USER_E164
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
notificationConfig Configuration used to determine how the 5780 DSC notification —
emailAddress Values: 1 to 80 characters; for

Type: string
mobileNumber Values: 1 to 32 characters; for

rule.
notifyableByEmail Values:true or false

notifyableBySMS Values:true or false

(2 of 4)
syOCSEnabled Enables the use of an OCS over the Sy interface. Values: true or false
true Type: boolean
syOCS Enabled
false
syOCS Disabled
allowOverage Indicates if overage is allowed for the subscriber. Values: true or false
true Type: boolean
Allows overage
false
Disallows overage
subscriberProfiles List of subscriber profiles to be assigned to the subscriber. —
subscriberProfile Values: 1 to 255 characters

Name of subscriber profile. (case-sensitive)
Type: string
customData Defines a list of one or more custom data entries (item). —
item —
based on:
• name
• value

value —
• type
• data
type Values:
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(3 of 4)

STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
customDataProfiles Defines a list of zero or more custom data profile names that Optional
item Values: 1 to 80 characters
(4 of 4)
2.19 getSubscriberState
Returns the state of the subscriber object.
Note — The subscriber state values are case-sensitive.
Parameter
• subscriberId

Request code
Code 2-35 shows a request code example for the GetSubscriberState command.
Code 2-35: GetSubscriberState request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getSubscriberState>

<sub:subscriberId>

<sub:userId>peter</sub:userId>

</sub:subscriberId>
</sub:getSubscriberState>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-32 lists the fields required for the GetSubscriberState command.
Table 2-32 subscriberid field descriptions
userId The unique identifier or name for the Values: 1 to 32 characters Mandatory
subscriber. Type: string Note: You must enter
subscriberId.
subscriptionId The subscriptionId identifies the — Optional

subscription based on a valid
Multiple subscriptionIds can be
specified; however, the 5780 DSC uses
the first subscriptionId that matches a
subscriber.
The 5780 DSC uses the subscriptionId to
match the incoming network messages
to the subscriber object. The
subscriptionId must exactly match the
E164 or IMSI expected in the message.
Each subscriptionId identifies the
subscription based on:
• value
• type
value Values: Valid values as allowed by Mandatory within

The identifier of the subscription. the type; for example, subscriptionId.
Type: string
Default: n/a

The type of identifier that is carried by • END_USER_E164 subscriptionId.
the associated value. • END_USER_IMSI
END_USER_E164 • END_USER_SIP_URI
International E.164 format (for example, • END_USER_NAI
MSISDN), according to the ITU-T E.164 • END_USER_PRIVATE
numbering plan defined in [E164] and
[CE164]. Type: enum
END_USER_IMSI Default: none
End User IMSI format, according to the
ITU-T E.212 numbering plan as defined in
[E212] and [CE212].
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
A credit-control server private
identifier.
Response code
Code 2-36 shows a response code example for the GetSubscriberState command.
Code 2-36: GetSubscriberState response code example

<env:Header/>
<env:Body>
<getSubscriberStateResponse
r"
n"
<subscriberState>ENABLED</subscriberState>
</getSubscriberStateResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-33 lists the fields for the GetSubscriberState command.
Table 2-33 getSubscriberState response field descriptions
subscriberState The subscriber state is used to enable or disable the Values: false or true
subscriber’s privilege to bind with a session. Type: boolean
DISABLED
The state of the subscriber is disabled.
ENABLED
2.20 getSubscriptionIds
Gets the subscription ids from the subscriber object.
Parameter
• subscriberId

Request code
Code 2-37 shows a request code example for the getSubscriptionIds command.
Code 2-37: getSubscriptionIds request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getSubscriptionIds>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getSubscriptionIds>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-34 lists the fields required for the getSubscriptionIds command.
Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-38 shows the response code for the getSubscriptionIds command.
Code 2-38: getSubscriptionIds response code

<env:Header/>
<env:Body>
<getSubscriptionIdsResponse
r"
">
<subscriptionId>
<value>31007012345678</value>
</subscriptionId>
</getSubscriptionIdsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-35 lists the fields for the getSubscriptionIds command.
Table 2-35 getSubsriptionIds response field descriptions
subscriptionId The subscriptionId identifies the subscription based on a valid —

subscriber.
• value
• type

Type: string
type Values:
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
2.21 getUnknownSubscriber
Gets the known/unknown status of the subscriber.
Parameter
• subscriberId

Request code
Code 2-39 shows a request code example for the getUnknownSubscriber command.
Code 2-39: getUnknownSubscriber request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getUnknownSubscriber>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:getUnknownSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-36 lists the fields required for the getUnknownSubscriber command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-40 shows the response code for the getUnknownSubscriber command.
Code 2-40: getUnknownSubscriber response code example

<env:Header/>
<env:Body>
<getUnknownSubscriberResponse
r"
">
<unknownSubscriber>true</unknownSubscriber>
</getUnknownSubscriberResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-37 lists the fields for the getUnknownSubscriber command.
Table 2-37 getUnknownSubscriber response field descriptions
unknownSubscriber Indicates an unknown subscriber. Values: false or true

true Type: boolean
Indicates the subscriber is unknown.
false
2.22 getUsage
Gets the usage data from a specified subscriber object.
Parameters
• accountid
• subscriberId

Request code
Code 2-41 shows a request code example for the getUsage command.
Code 2-41: getUsage request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getUsage>


<sub:subscriberId>


</sub:subscriberId>
</sub:getUsage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-38 lists the fields required for the getUsage command.
Table 2-38 getUsage field descriptions
subscriptionId.
(1 of 2)

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Response code
Code 2-42 shows the response code for the getUsage command.
Code 2-42: getUsage response code example

<env:Header/>
<env:Body>
<getUsageResponse
r"
n"
<usageData>
<subscriber>subnew1</subscriber>
<direction>TOTAL</direction>
<accumulatedUsage>0.0</accumulatedUsage>
<limit>1000.0</limit>
<usageType>REGULAR</usageType>
<nextScheduledReset>2012-11-01T00:00:00-04:00</nextSched
uledReset>
</usageData>
</getUsageResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-39 lists the fields for the getUsage command.
Table 2-39 getUsage response field descriptions
usageData Used to collect, format, transfer, and evaluate information —

related to a chargeable event. Usage data for a subscriber is
updated in real-time automatically and is available after each
network usage report. Usage data is listed per metering limit.
subscriber —
Indicates the subscriber record to be added.
• accountid
• userId
• category
• password
• description
• state
• subscriptionIds
• allowOverage
• syOCSEnabled
• customData
meteringLimit Values: 1 to 80 characters

(1 of 2)
usageData direction Values:

(continued) Specifies the direction of the usage as monitored or the type • UP_LINK
Type: enum
• TOTAL
• UP_LINK
• TIME
accumulatedUsage Values: Long values of up to a
reset. 4503599627370495, or 252. You
value.
Type: double
limit Values:
Identifies the quota value. • UP_LINK
Valid options are: • DOWN_LINK
• DOWN_LINK • TOTAL
Usage monitored in the down link direction. • TIME
• TOTAL
Type: enum
• UP_LINK
• TIME
usageType Values:
Identifies whether the usage amount is from a metering limit • REGULAR
that is tracking a carry-over or a regular usage. • CARRY_OVER
Type: enum
lastResetDate Values: date and time value;

The date of the last reset. 2011-12-15T00:00:00-05:00
Type: dateTime
nextScheduledReset Values: date and time value;
penaltyExpirationDate Values: date and time value;

The date that the penalty expires 2011-12-15T00:00:00-05:00
Type: dateTime
(2 of 2)
2.23 removeAccount
Removes the specified account and the associated subscriber.
Parameters
• accountid
• subscriberId

Request code
Code 2-43 shows a request code example for the removeAccount command.
Code 2-43: removeAccount request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:removeAccount>


<sub:subscriberId>


</sub:subscriberId>
</sub:removeAccount>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-40 lists the fields required for the removeAccount command.
Table 2-40 removeAccount field descriptions
subscriptionId.

Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-44 shows the response code for the removeAccount command.
Code 2-44: removeAccount response code example

<env:Header/>
<env:Body>
<removeAccountResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.24 removeSubscriber
Removes the specified subscriber object.
Note — The account object is deleted when the last subscriber

associated with the account is deleted.
Parameter
• subscriberId

Request code
Code 2-45 shows a request code example for the removeSubscriber command.
Code 2-45: removeSubscriber request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:removeSubscriber>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
</ns:removeSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-41 lists the fields required for the removeSubscriber command.

Type: string
Default: n/a

subscriber.
• value
• type
Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-46 shows the response code for the removeSubscriber command.
Code 2-46: removeSubscriber response code example

<env:Header/>
<env:Body>
<removeSubscriberResponse
r"
"/>
</env:Body>
</env:Envelope>
2.25 resetUsage
Resets the usage data to zero for the specified account.
Note — One or all usage data for the account can be reset to 0.
Parameters
• accountid
• subscriberId
• meteringLimit
Name of the metering limit to be assigned to the subscriber.

Request code
Code 2-47 shows a request code example for the resetUsage command.
Code 2-47: resetUsage request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:resetUsage>


<sub:subscriberId>


</sub:subscriberId>
<sub:meteringLimit>ML</sub:meteringLimit>
</sub:resetUsage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-42 lists the fields required for the resetUsage command.
Table 2-42 resetUsage field descriptions
subscriptionId.
(1 of 2)

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
meteringLimit Name of the metering limit to be assigned to the subscriber. Values: 1 to 255 characters Optional
Type: string
Default: n/a
(2 of 2)
Response code
Code 2-48 shows the response code for the resetUsage command.
Code 2-48: resetUsage response code example

<env:Header/>
<env:Body>
<ns2:resetUsageResponse
riber"
n"
>
</env:Body>
</env:Envelope>
2.26 updateAccount
Updates the specified account.
Parameter
• account
Request code
Code 2-49 shows a request code example for the updateAccount command.
Code 2-49: updateAccount request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAccount>

<sub:account>


<sub:resetDayOfWeek>MONDAY</sub:resetDayOfWeek>


<sub:subscribers>
<sub:subscriber>

<sub:userId>subnew1</sub:userId>

<sub:category>silver</sub:category>

<sub:password>pass</sub:password>

<sub:description>update desc</sub:description>

<sub:unknownSubscriber>false</sub:unknownSubscribe
r>




<sub:emailAddress/>

<sub:mobileNumber/>
<sub:notifyableByEmail>false</sub:notifyableByE
mail>
<sub:notifyableBySMS>false</sub:notifyableBySMS
>

<sub:syOCSEnabled>false</sub:syOCSEnabled>

<sub:subscriberProfile>updatepf</sub:subscriber
Profile>

<sub:customData>
<sub:item>
<sub:name>updatecd</sub:name>
<sub:value>
<sub:data>updatecd</sub:data>
</sub:value>
</sub:item>
</sub:customData>

<sub:customDataProfile>updatecdf</sub:customDat
aProfile>
</sub:subscriber>
</sub:subscribers>

<sub:meteredServices>
<sub:meteringLimitName>ml</sub:meteringLimitName>
</sub:meteredServices>

<sub:customData>
<sub:item>
<sub:name>updatecd</sub:name>
<sub:value>
<sub:type>NUMBER</sub:type>
<sub:data>888</sub:data>
</sub:value>
</sub:item>
</sub:customData>

<sub:customDataProfile>updatecdf</sub:customDataProfi
le>
</sub:account>
</sub:updateAccount>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-43 lists the fields required for the updateAccount command.
Type: string
Default: n/a
Default: 1
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
Default: SUNDAY
(1 of 4)
follows:
Default: 0
day (default)
time during the day
day

• accountid
• userId
• category
• password
• description
• state
• subscriptionIds
• allowOverage
• syOCSEnabled
• customData
meteredservices Defines a list of one or more metered service entries. A — Optional

Metering limit name to be assigned to the subscriber. Type: string80Type
Default: n/a
(2 of 4)
cutomDataEntry — —
based on:
• name
• value

Default: n/a

• type
• data
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(3 of 4)
Contains the data for the custom data item value. Valid values selected. item.
include: Type: string
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
STRING
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
item Values: 1 to 80 characters Optional
Default: n/a
(4 of 4)
Response code
Code 2-50 shows the response code for the updateAccount command.
Code 2-50: updateAccount response code example

<env:Header/>
<env:Body>
<updateAccountResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.27 updateAccountCustomData
Updates all custom data entries for the account.
Note — A customer supplied xml file exists restricting use of custom

data attributes may exist. See subscriberCustomDataEntry for more
information.
Parameters
• accountid
• subscriberId
• customData
Defines the custom data used for a single custom data entry based on name and
value.

Request code
Code 2-51 shows a request code example for the updateAccountCustomData
command.
Code 2-51: updateAccountCustomData request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAccountCustomData>


<sub:subscriberId>


</sub:subscriberId>
<sub:customData>
<sub:name>cd1</sub:name>
<sub:value>
<sub:data>updatecd1</sub:data>
</sub:value>
</sub:customData>
<sub:customData>
<sub:value>
<sub:data>updatecd2</sub:data>
</sub:value>
</sub:customData>
</sub:updateAccountCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-44 and 2-45 lists the fields required for the updateAccountCustomData
command.
subscriptionId.

Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Table 2-45 customData field descriptions
customData Defines the custom data used for a single custom data entry — —
based on:
• name
• value

Default: n/a
value — —
• type
• data
(1 of 2)
customData type Values: Mandatory within each

(continued) Type of data held in the custom data item. • STRING item.
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum

STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
NUMBER
DECIMAL
Any number that contains a decimal for example: 1.0456.
Values: Any value of a floating-point type, taking into account
both precision and magnitude.
Type: string
(2 of 2)
Response code
Code 2-52 shows the response code for the updateAccountCustomData command.
Code 2-52: updateAccountCustomData response code example

<env:Header/>
<env:Body>
<updateAccountCustomDataResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.28 updateAccountCustomDataEntry
Updates the specified custom data entry for the account.
Parameters
• accountid
• subscriberId
• customData
value.

Request code
Code 2-53 shows a request code example for the updateAccountCustomDataEntry
command.
Code 2-53: updateAccountCustomDataEntry request code example

soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAccountCustomDataEntry>


<sub:subscriberId>


</sub:subscriberId>

<sub:customData>
<sub:value>
<sub:data>cd2</sub:data>
</sub:value>
</sub:customData>
</sub:updateAccountCustomDataEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-46 and 2-47 list the fields required for the updateAccountCustomDataEntry
command.
Table 2-46 updateAccountCustomDataEntry field descriptions
subscriptionId.

Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
based on:
• name
• value

Name of the custom data entry to be updated. Type: string item.
Default: n/a
value — —
• type
• data
(1 of 2)

• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum

STRING Type: string
Contains a text string of the exact value that you require for Default: n/a
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
(2 of 2)
Response code
Code 2-54 shows the response code for the updateAccountCustomDataEntry
command.
Code 2-54: updateAccountCustomDataEntry Entry response code example

<env:Header/>
<env:Body>
<updateAccountCustomDataEntryResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.29 updateAccountCustomDataProfiles
Updates the list of custom data profiles for the account.
Parameters
• accountid
• subscriberId
• customDataProfile
The name of a custom data profile.

Request code
Code 2-55 shows a request code example for the updateAccountCustomDataProfiles
command.
Code 2-55: updateAccountCustomDataProfiles request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAccountCustomDataProfiles>


<sub:subscriberId>


</sub:subscriberId>
<sub:customDataProfile>cdf1</sub:customDataProfile>
</sub:updateAccountCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-48 lists the fields required for the updateAccountCustomDataProfiles
command.
Table 2-48 updateAccountCustomDataProfiles field descriptions
accountid The unique identifier or name for the Values: 1 to 32 characters Optional
account. Type: string Note: You must enter
subscriptionId.
The unique identifier or name for the Type: string
subscriber. Default: n/a
(1 of 2)

(continued) The subscriptionId identifies the subscription
based on a valid subscriptionId type.
Multiple subscriptionIds can be specified;
however, the 5780 DSC uses the first
subscriptionId that matches a subscriber.
match the incoming network messages to the
subscriber object. The subscriptionId must
exactly match the E164 or IMSI expected in
the message.
• value
• type

Type: string
Default: n/a

The type of identifier that is carried by the • END_USER_E164 subscriptionId.
associated value. • END_USER_IMSI
[CE164]. Type: enum
End User IMSI format, according to the ITU-T
E.212 numbering plan as defined in [E212]
and [CE212].
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
customDataProfile The name of a custom data profile. Values: 1 to 80 characters Optional

Type: string
Default: n/a
(2 of 2)
Response code
Code 2-56 shows the response code for the updateAccountCustomDataProfiles
command.
Code 2-56: updateCustomDataProfiles response code example

<env:Header/>
<env:Body>
<updateAccountCustomDataProfilesResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.30 updateAllowOverage
Updates the allow overage flag within the subscriber.
Parameters
• subscriberId
• allowOverage
Indicates if overage is allowed for the subscriber.

Request code
Code 2-57 shows a request code example for the updateAllowOverage command.
Code 2-57: updateAllowOverage request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateAllowOverage>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
<ns:allowOverage>true</ns:allowOverage>
</ns:updateAllowOverage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-49 and 2-50 lists the fields required for the updateAllowOverage command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Table 2-50 allowOverage field description
Name Description Type Qualifier
allowOverage Indicates if overage is allowed for the Values: true or false Optional
subscriber. Type: boolean
true Default: true
Allows overage
false
Disallows overage
Response code
Code 2-58 shows the response code for the updateAllowOverage command.
Code 2-58: updateAllowOverage response code example

<env:Header/>
<env:Body>
<updateAllowOverageResponse
r"
"/>
</env:Body>
</env:Envelope>
2.31 updateCategory
Updates the category of the subscriber.
Parameters
• subscriberId
• category
A predetermined level of service groupings or subgroupings for a subscriber (for
example, Gold, Silver, or Bronze).

Request code
Code 2-59 shows a request code example for the updateCategory command.
Code 2-59: updateCategory request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCategory>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>

<ns:category>gold</ns:category>
</ns:updateCategory>
</soapenv:Body>
</soapenv:Envelope>
Subparameters
Tables 2-51 and 2-52 lists the subparameters required for the updateCategory
command.
Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Table 2-52 category field descriptions
category A predetermined level of service groupings or Values: 1 to 255 characters Optional

subgroupings for a subscriber (for example, Gold, Type: string
Silver, or Bronze).
Default: null
Response code
Code 2-60 shows the response code for the updateCategory command.
Code 2-60: updateCategory response code example

<env:Header/>
<env:Body>
<updateCategoryResponse
r"
"/>
</env:Body>
</env:Envelope>
2.32 updateCustomData
Updates all custom data entries for the subscriber.

information.
Parameters
• subscriberId
• customData
value.

Request code
Code 2-61 shows a request code example for the updateCustomData command.
Code 2-61: updateCustomData request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomData>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
<ns:customData>
<ns:value>
</ns:value>
</ns:customData>
</ns:updateCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-53 and 2-54 lists the fields required for the updateCustomData command.
Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
based on:
• name
• value

Default: n/a
value — —
• type
• data
(1 of 2)

• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum

STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
NUMBER
DECIMAL
Any number that contains a decimal for example: 1.0456.
Values: Any value of a floating-point type, taking into account
both precision and magnitude.
Type: string
(2 of 2)
Response code
Code 2-62 shows the response code for the updateCustomData command.
Code 2-62: updateCustomData response code example

<env:Header/>
<env:Body>
<updateCustomDataResponse
r"
"/>
</env:Body>
</env:Envelope>
2.33 updateCustomDataEntry
Updates the specified custom data entry for the subscriber.

information.
Parameters
• subscriberId
• customData
value.

Request code
Code 2-63 shows a request code example for the updateCustomDataEntry command.
Code 2-63: updateCustomDataEntry request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataEntry>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>

<ns:customData>
<ns:value>
</ns:value>
</ns:customData>
</ns:updateCustomDataEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-55 and 2-56 list the fields required for the updateCustomDataEntry
command.
Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
based on:
• name
• value

Name of the custom data entry to be updated. Type: string item.
Default: n/a
value — —
• type
• data
(1 of 2)

• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum

STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
(2 of 2)
Response code
Code 2-64 shows the response code for the updateCustomDataEntry command.
Code 2-64: updateCustomData Entry response code example

<env:Header/>
<env:Body>
<updateCustomDataEntryResponse
r"
"/>
</env:Body>
</env:Envelope>
2.34 updateCustomDataProfiles
Updates the list of custom data profiles for the subscriber.
Parameters
• subscriberId
The name of a custom data profile.

Request code
Code 2-65 shows a request code example for the updateCustomDataProfiles
command.
Code 2-65: updateCustomData Profiles request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataProfiles>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
<ns:customDataProfile>gold_usage_profile</ns:customDataProf
ile>
</ns:updateCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-57 and 2-58 lists the fields required for the updateCustomDataProfiles
command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Table 2-58 customDataProfile field descriptions

Type: string
Default: n/a
Response code
Code 2-66 shows the response code for the updateCustomDataProfiles command.
Code 2-66: updateCustomDataProfiles response code example

<env:Header/>
<env:Body>
<updateCustomDataProfilesResponse
r"
"/>
</env:Body>
</env:Envelope>
2.35 updateMeteringLimitEntry
Removes the specified old metering limit from the account and assigns the specified
new metering limit. Any remaining usage against the old metering limit is moved to
the new metering limit. However any unused carryover usage is lost. Any usage
reported after the deactivation of the old meteringLimit occurred is not recorded.
Parameters
• accountid
• subscriberId
• oldmeteringLimit
Identifies the old meteringLimit to be replaced.
• newmeteringLimit
Identifies the new meteringLimit to be assigned.

Request code
Code 2-67 shows a request code example for the updateMeteringLimitEntry
command.
Code 2-67: updateMeteringLimitEntry request code example

soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateMeteringLimitEntry>


<sub:subscriberId>


</sub:subscriberId>

<sub:oldMeteringLimit>ML2</sub:oldMeteringLimit>

<sub:newMeteringLimit>ML</sub:newMeteringLimit>
</sub:updateMeteringLimitEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-59, 2-60, 2-61, and 2-62 list the fields required for the
updateMeteringLimitEntry command.
Table 2-59 accountId field descriptions
subscriptionId.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Table 2-61 OldmeteringLimit field descriptions
oldmeteringLimit Name of the metering limit to be replaced. Values: 1 to 255 characters Optional
Type: string
Default: n/a
Table 2-62 newmeteringLimit field descriptions
newmeteringLimit Name of the new metering limit. Values: 1 to 255 characters Optional
Type: string
Default: n/a
Response code
Code 2-68 shows the response code for the updateMeteringLimitEntry command.
Code 2-68: updateMeteringLimitEntry response code example

<env:Header/>
<env:Body>
<updateMeteringLimitsResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.36 updateMeteringLimits
Updates the list of metering limits associated with the account, replacing the existing
set of metering limits with those provided. If no metering limits are provided, any
existing metering limits are removed.
Parameters
• accountid
• subscriberId
• meteringLimit
Name of the metering limit to be assigned to the subscriber.

Request code
Code 2-69 shows a request code example for the updateMeteringLimits command.
Code 2-69: updateMeteringLimits request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateMeteringLimits>


<sub:subscriberId>


</sub:subscriberId>
<sub:meteringLimit>ML</sub:meteringLimit>
</sub:updateMeteringLimits>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-63 lists the fields required for the updateMeteringLimits command.
Table 2-63 updateMeteringLimits field descriptions
subscriptionId.
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
meteringLimit Name of the metering limit to be assigned to the subscriber. Values: 1 to 255 characters Optional
Type: string
Default: n/a
(2 of 2)
Response code
Code 2-70 shows the response code for the updateMeteringLimits command.
Code 2-70: updateMeteringLimits response code example

<env:Header/>
<env:Body>
<updateMeteringLimitsResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.37 updateNotification
Updates the notification configuration data for the subscriber.
Parameters
• subscriberId
Configuration used to determine how the 5780 DSC notification is sent to the
subscriber.

Request code
Code 2-71 shows a request code example for the updateNotification command.
Code 2-71: updateNotification request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateNotification>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>

<ns:notificationConfig>

</ns:emailAddress>johnsmith@abccompany.com</ns:emailAddr
ess>

<ns:mobileNumber>6135551212</ns:mobileNumber>
<ns:notifyableByEmail>false</ns:notifyableByEmail>
<ns:notifyableBySMS>true</ns:notifyableBySMS>
</ns:notificationConfig>
</ns:updateNotification>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-64 and 2-65 list the fields required for the updateNotification command.

Type: string
Default: n/a

subscriber.
• value
• type
Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Table 2-65 notificationConfig request field descriptions

Type: string
Default: null

rule. Default: null

Default: false
notifyableBySMS Values:true or false Optional

Default: true
Response code
Code 2-72 shows the response code for the updateNotification command.
Code 2-72: updateNotification response code example

<env:Header/>
<env:Body>
<updateNotificationResponse
r"
"/>
</env:Body>
</env:Envelope>
2.38 updateResetDayOfMonth
Updates the account reset day of month, which represents the day of the month that
monthly usage rests occurs.
Parameters
• accountid
• subscriberId
• resetDayOfMonth
Updates monthly resets, and represents the day of the month that the usage is
reset.

Request code
Code 2-73 shows a request code example for the updateResetDayOfMonth
command.
Code 2-73: updateResetDayOfMonth request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateResetDayOfMonth>


<sub:subscriberId>


</sub:subscriberId>

</sub:updateResetDayOfMonth>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-66 lists the fields required for the updateResetDayOfMonth command.
Table 2-66 updateResetDayOfMonth field descriptions
subscriptionId.

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
resetDayOfMonth The Reset Day of Month is used for monthly resets and Values: Any number between 1 Optional
represents the day of the month that the usage is reset. and 31
You must also configure the Reset Hour of Day parameter to Type: string
the time of day that you want the reset to occur. Default: 1
Response code
Code 2-74 shows the response code for the updateResetDayOfMonth command.
Code 2-74: updateResetDayOfMonth response code example

<env:Header/>
<env:Body>
<updateResetDayOfMonthResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.39 updateResetDayOfWeek
Updates the account reset day of week, which represents the day of week on which
weekly resets occur.
Parameters
• accountid
• subscriberId
• resetDayOfWeek
Used for weekly resets, which can occur on any day of the week that you
configure at a specified time.

Request code
Code 2-75 shows a request code example for the updateResetDayOfWeek command.
Code 2-75: updateResetDayOfWeek request code example

soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateResetDayOfWeek>


<sub:subscriberId>


</sub:subscriberId>

<sub:resetDayOfWeek>MONDAY</sub:resetDayOfWeek>
</sub:updateResetDayOfWeek>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-67 lists the fields required for the updateResetDayOfWeek command.
Table 2-67 updateResetDayOfWeek field descriptions
subscriptionId.
(1 of 2)

Default: n/a
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
monthly resets. You must also configure the resetHourOfDay • TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
Default: SUNDAY
(2 of 2)
Response code
Code 2-76 shows the response code for the updateResetDayOfWeek command.
Code 2-76: updateResetDayOfWeek response code example

<env:Header/>
<env:Body>
<updateResetDayOfWeekResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.40 updateResetHourOfDay
Updates the account reset hour of day, which represents the hour of day on which
usage resets occur.
Parameters
• accountid
• subscriberId
• resetHourOfDay
ResetHourOfDay must be configured for any reset, whether a day of the week or
month

Request code
Code 2-77 shows a request code example for the updateResetHourOfDay command.
Code 2-77: updateResetHourOfDay request code example

soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateResetHourOfDay>


<sub:subscriberId>


</sub:subscriberId>

</sub:updateResetHourOfDay>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-68 lists the fields required for the updateResetHourOfDay command.
Table 2-68 updateResetHourOfDay field descriptions
subscriptionId.
(1 of 2)

Default: n/a
The subscriptionId identifies the subscription
The 5780 DSC uses the subscriptionId to match
the incoming network messages to the
subscriber object. The subscriptionId must
exactly match the E164 or IMSI expected in the
message.
Each subscriptionId identifies the subscription
based on:
• value
• type

Type: string
Default: n/a

The type of identifier that is carried by the • END_USER_E164 subscriptionId.
numbering plan defined in [E164] and [CE164].
END_USER_IMSI Type: enum
End User IMSI format, according to the ITU-T Default: none
E.212 numbering plan as defined in [E212] and
[CE212].
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
ResetHourOfDay ResetHourOfDay must be configured for any Values: 0-24 Optional

reset, whether a day of the week or month. The Type: enum
reset time can be configured as follows:
Default: 0
• 0—which is equal to 0:00 and indicates the
beginning of the day (default)
• 1 to 23—which is equal to the hours 01:00 to
23:00 for any time during the day
• 24—which is equal to 24:00 and indicates the
end of the day
(2 of 2)
Response code
Code 2-78 shows the response code for the updateResetHourOfDay command.
Code 2-78: updateResetHourOfDay response code example

<env:Header/>
<env:Body>
<updateResetHourOfDayResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.41 updateSubProfileNames
Updates the list of subscriber profiles assigned to the subscriber, replacing the
existing set with those specified. If no subprofile is specified, any existing
subprofiles are replaced.
Parameters
• subscriberId
• subscriberProfile
Name of subscriber profile.

Request code
Code 2-79 shows a request code example for the updateSubProfileNames command.
Code 2-79: updateSubProfileNames request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateSubProfileNames>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
<ns:subscriberProfile>gold_subscriber_profile</ns:subscribe
rProfile>
</ns:updateSubProfileNames>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-69 and 2-70 list the fields required for the updateSubProfileNames
command.
Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Table 2-70 subscriberProfile field descriptions
subscriberProfile Name of subscriber profile. Values: 1 to 255 characters Optional

Type: string
Default: n/a
Response code
Code 2-80 shows the response code for the updateSubProfileNames command.
Code 2-80: updateSubProfileNames response code example

<env:Header/>
<env:Body>
<updateSubProfileNamesResponse
r"
"/>
</env:Body>
</env:Envelope>
2.42 updateSubscriber
Updates the specified subscriber object by replacing the existing values with those
specified.
default values.
When you change from a known to unknown state of the subscriber, the following
occurs:
• unknown flag is set to true
• Subscription IDs are preserved
• category is set to "unknown"
• the password and description are deleted
• sub-profile associations/assignments are deleted
• custom data and custom data profile associations/assignments are deleted from
the subscriber
• metering limit assignments are deleted
• WNG events are cleared
Parameter
• subscriber
Updates the specified subscriber object identified by provided user id or
subscription id.
Request code
Code 2-81 shows a request code example for the updateSubscriber command.
Code 2-81: updateSubscriber request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriber>

<sub:subscriber>

<sub:userId>ML2User</sub:userId>

<sub:category>Silver</sub:category>

<sub:password>pass123</sub:password>

<sub:description>Renew subscriber</sub:description>

<sub:unknownSubscriber>false</sub:unknownSubscriber>




<sub:emailAddress>newEmail@gmail.com
</sub:emailAddress>

<sub:mobileNumber>61378941234</sub:mobileNumber>
<sub:notifyableByEmail>true</sub:notifyableByEmail>
<sub:notifyableBySMS>true</sub:notifyableBySMS>

<sub:syOCSEnabled>true</sub:syOCSEnabled>

<sub:subscriberProfile>sub_profile</sub:subscriberPro
file>

<sub:customData>
<sub:item>
<sub:name>LANGUAGE</sub:name>
<sub:value>
<sub:data>FRENCH</sub:data>
</sub:value>
</sub:item>
</sub:customData>

<sub:customDataProfile>sub_cdp</sub:customDataProfile
>
</sub:subscriber>
</sub:updateSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-71 lists the fields required for the updateSubscriber command.
Table 2-71 subscriber field descriptions
Type: string
Default: n/a
Type: string
Default: n/a
category A predetermined level of service groupings or subgroupings for Values: 1 to 255 characters Optional
Default: null
password A case-sensitive password for the subscriber. Applies to Values: 1 to 128 characters Optional
Default: null
description Information about the subscriber. Values: 0 to 255 characters Optional
Type: string
Default: null

true Type: boolean
false
state Indicates the state of the subscriber. Values: DISABLED or ENABLED Optional
ENABLED
(1 of 4)
subscriptionIds Contains a list of subscription ids for this subscriber. Default: Empty list Optional
subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Type: string
Default: null

rule. Default: null

Default: false
notifyableBySMS Values: true or false Optional
Default: true
(2 of 4)
allowOverage Indicates if overage is allowed for the subscriber. Values: true or false Optional
true Type: boolean
Allows overage Default: true
false
Disallows overage
syOCSEnabled Enables the use of an OCS over the Sy interface. Values: true or false Optional
true Type: boolean
syOCS Enabled Default: false
false
syOCS Disabled
subscriberProfiles List of subscriber profiles to be assigned to the subscriber. Default: Empty list Optional
subscriberProfile Values: 1 to 255 characters n/a

Name of the subscription profile in the subscriber list. Type: string
Default: n/a
customData Defines a list of one or more custom data entries (item). Default: Empty list Optional
item Default: n/a —

based on:
• name
• value

Default: n/a
(3 of 4)
customData value — Mandatory within each

(continued) Defines the value of the item using: item.
• type
• data

• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum

STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
customDataProfiles Defines a list of zero or more custom data profile names that — Optional
item Values: 1 to 80 characters n/a

Default: n/a
(4 of 4)
Response code
Code 2-82 shows the response code for the updateSubscriber command.
Code 2-82: updateSubscriber response code example

<env:Header/>
<env:Body>
<ns2:updateSubscriberResponse
riber"
n"
>
</env:Body>
</env:Envelope>
2.43 updateSubscriberState
Updates the state of the subscriber.
Parameters
• subscriberId
• subscriberState
Updates the state of the subscriber object.

Request code
Code 2-83 shows a request code example for the UpdateSubscriberState command.
Code 2-83: UpdateSubscriberState request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriberState>

<sub:subscriberId>


</sub:subscriberId>

<sub:subscriberState>ENABLED</sub:subscriberState>
</sub:updateSubscriberState>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-72 lists the fields required for the UpdateSubscriberState command.
Table 2-72 subscriberid field descriptions

userId The unique identifier or name for the Values: 1 to 32 characters Optional
subscriber. Type: string Note: You must enter
subscriberId.
(1 of 2)
subscriptionId The subscriptionId identifies the Default: Empty list Optional

subscription based on a valid
Multiple subscriptionIds can be
specified; however, the 5780 DSC uses
the first subscriptionId that matches a
subscriber.
match the incoming network messages
to the subscriber object. The
subscriptionId must exactly match the
• value
• type
value Values: Valid values as allowed by Mandatory within

The identifier of the subscription. the type; for example, subscriptionId.
Type: string
Default: n/a

The type of identifier that is carried by • END_USER_E164 subscriptionId.
the associated value. • END_USER_IMSI
[CE164]. Type: enum
End User IMSI format, according to the
ITU-T E.212 numbering plan as defined in
[E212] and [CE212].
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
A credit-control server private
identifier.
subscriberState Indicates the state of the subscriber. Values: DISABLED or ENABLED Optional
ENABLED
(2 of 2)
Response code
Code 2-84 shows a response code example for the UpdateSubscriberState command.
Code 2-84: UpdateSubscriberState response code example

<env:Header/>
<env:Body>
<updateSubscriberStateResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.44 updateSubscriptionId
Updates the subscriber by replacing the specified old subscription id with the
specified new subscription id.
Parameters
• subscriberId
• oldSubscriptionId
Identifies the old subscription id to be replaced.
• newSubscriptionId
Identifies the new subscription id.

Request code
Code 2-85 shows a request code example for the updateSubscriptionId command.
Code 2-85: updateSubscriptionId request code example

<soapenv:Envelope
n"
riber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriptionId>

<sub:subscriberId>


</sub:subscriberId>

<sub:oldSubscriptionId>
</sub:oldSubscriptionId>

<sub:newSubscriptionId>
</sub:newSubscriptionId>
</sub:updateSubscriptionId>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-73, 2-74, 2-75 list the fields required for the updateSubscriptionId
command.

Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Table 2-74 oldSubscriptionId field descriptions
oldSubscriptionId Identifies the old subscription id to be replaced. — Mandatory

subscriber.
Identifies the subscriptionid to be replaced based on:
• value
• type
value Values: Valid values as allowed Mandatory

Type: string
Default: n/a
type Values: Mandatory

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Table 2-75 newSubscriptionId field descriptions
newSubscriptionId Identifies the new subscription id. — Optional

subscriber.
Identifies the subscriptionId to be added based on:
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-86 shows the response code for the updateSubscriptionId command.
Code 2-86: updateSubscriptionId response code example

<env:Header/>
<env:Body>
<updateSubscriptionIdResponse
r"
n"
>
</env:Body>
</env:Envelope>
2.45 updateSubscriptionIds
Updates the subscriber by replacing the existing set of subscription ids with the
specified new set of subscription ids.
Parameters
• subscriberId
• subscriptionId
Contains the identity of the subscription.

Request code
Code 2-87 shows a request code example for the updateSubscriptionIds command.
Code 2-87: updateSubscriptionIds request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header><ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateSubscriptionIds>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
<ns:subscriptionId>
</ns:updateSubscriptionIds>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-76 lists the fields required for the updateSubscriptionIds command.
Type: string
Default: n/a

subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Table 2-77 subscriptionId field descriptions

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Response code
Code 2-88 shows the response code for the updateSubscriptionIds command.
Code 2-88: updateSubscriptionIds response code example

<env:Header/>
<env:Body>
<updateSubscriptionIdsResponse
r"
"/>
</env:Body>
</env:Envelope>
2.46 updateUnknownSubscriber
Updates the state of a subscriber from known to unknown or visa versa. When you
change the known to an unknownstate of the subscriber, the following occurs:
• unknown flag is set to true/false
• Subscription IDs are preserved
• category is set to "unknown"
• the password and description are deleted
• sub-profile associations/assignments are deleted
• custom data and custom data profile associations/assignments are deleted from
the subscriber
• metering limit assignments are deleted
• WNG events are cleared
When you change from an unknown to known subscriber, nothing gets deleted
because an unknown subscriber has only subscription id.
Parameters
• subscriberId
Indicates an unknown subscriber.

Request code
Code 2-89 shows a request code example for the updateUnknownSubscriber
command.
Code 2-89: updateUnknownSubscriber request code example

<soapenv:Envelope
n"
iber">
<soapenv:Header>
<ns1:header><ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateUnknownSubscriber>

<ns:subscriberId>


<ns:subscriptionId>
</ns:subscriberId>
<ns:unknownSubscriber>true</ns:unknownSubscriber>
</ns:updateUnknownSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 2-78 and 2-79 list the fields required for the updateUnknownSubscriber
command.
Type: string
Default: n/a
(1 of 2)

subscriber.
• value
• type
value — Mandatory within

The identifier of the subscription. subscriptionId.

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 2)
Table 2-79 unknownSubscriber field descriptions

true Type: boolean
false
Response code
Code 2-90 shows the response code for the updateUnknownSubscriber command.
Code 2-90: updateUnknownSubscriber response code example

<env:Header/>
<env:Body>
<updateUnknownSubscriberResponse
r"
"/>
</env:Body>
</env:Envelope>
3— Subscriber profile provisioning API
3.1 Using the subscriber profile provisioning 3-3
3.2 addCalledStationIdEntry 3-3
3.3 addSubscriberProfile 3-4
3.4 getAFApplications 3-13
3.5 getCalledStationIds 3-15
3.6 getQciGuaranteedBitRates 3-17
3.7 getQciMaxBitRates 3-19
3.8 getSubscriberProfile 3-21
3.9 getSubscriberProfileCustomData 3-30
3.10 getSubscriberProfileCustomDataProfiles 3-33
3.11 removeSubscriberProfile 3-35
3.12 updateAFApplicationEntry 3-36
3.13 updateAFApplications 3-39
3.14 updateCalledStationIds 3-42
3.15 updateQciGuaranteedBitRateEntry 3-44
3 — Subscriber profile provisioning API
3.16 updateQciGuaranteedBitRates 3-46
3.17 updateQciMaxBitRateEntry 3-49
3.18 updateQciMaxBitRates 3-51
3.19 updateSubscriberProfile 3-53
3.20 updateSubscriberProfileCustomData 3-62
3.21 updateSubscriberProfileCustomDataEntry 3-65
3.22 updateSubscriberProfileCustomDataProfiles 3-68
3.1 Using the subscriber profile provisioning
The subscriber profile provisioning API is used to perform operations related to

subscriber profiles provisioning, such as adding, updating, and removing subscriber
profiles and the information contained within the subscriber profiles.
3.2 addCalledStationIdEntry
Adds a called station Id entry to the subscriber profile object.
Parameters
• profileName
A unique name for the subscriber data.
• calledStationId
A unique identifier for the called station ID.
Request code
Code 3-1 shows a request code example for the addCalledStationIdEntry command.
Code 3-1: addCalledStationIdEntry request code example

<soapenv:Envelope
n"
riberprofile"
xmlns:sub1="http://www.alcatellucent.com/dsc/provisioningapi/51/subs
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:addCalledStationIdEntry>

<sub1:profileName>subProfile1</sub1:profileName>

<sub1:calledStationId>Apn2</sub1:calledStationId>
</sub:addCalledStationIdEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-1 and 3-2 lists the fields for the addCalledStationIdEntry command.
Table 3-1 profileName field descriptions
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Table 3-2 calledStationId field descriptions
calledStationId A unique identifier for the called station ID. Values: 1 to 255 characters Optional
Type: string
Default: empty
Response code
Code 3-2 shows the response code for the addCalledStationIdEntry command.
Code 3-2: addCalledStationIdEntry response code example

<env:Header/>
<env:Body>
<ns2:addCalledStationIdEntryResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.3 addSubscriberProfile
Adds a subscriber profile object.
Parameter
• subProfile
The subscriber profile object to be added.
Request code
Code 3-3 shows a request code example for the addSubscriberProfile command.
Code 3-3: addSubscriberProfile request code example

soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:addSubscriberProfile>

<sub1:subProfile>
<sub1:name>subProfile1</sub1:name>
<sub1:ueAccessToKnownApps>true</sub1:ueAccessToKnownApps
>
<sub1:ueAccessToUnKnownApps>true</sub1:ueAccessToUnKnown
Apps>
<sub1:calledStationIds>
<sub1:item>apn1</sub1:item>
</sub1:calledStationIds>

<sub1:defaultQCI>QCI_9</sub1:defaultQCI>

<sub1:arp>

<sub1:priorityLevel>9</sub1:priorityLevel>

<sub1:preEmptionCapability>PRE_EMPTION_CAPABILITY_DIS
ABLED</sub1:preEmptionCapability>

<sub1:preEmptionVulnerability>PRE_EMPTION_VULNERABILI
TY_ENABLED</sub1:preEmptionVulnerability>
</sub1:arp>

<sub1:aggregateMaxBitRate>
<sub1:upLinkBw>120000</sub1:upLinkBw>
<sub1:downLinkBw>110000</sub1:downLinkBw>
</sub1:aggregateMaxBitRate>

<sub1:qciGuaranteedBitRates>
<sub1:qciGuaranteedBitRate>
<sub1:qosId>QCI_1</sub1:qosId>
<sub1:guaranteedBitRate>

<sub1:maxGBR>
</sub1:maxGBR>

<sub1:maxMBR>
</sub1:maxMBR>
</sub1:guaranteedBitRate>
</sub1:qciGuaranteedBitRate>
</sub1:qciGuaranteedBitRates>

<sub1:qciMaxBitRates>
<sub1:qciMaxBitRate>
<sub1:maxBitRate>
</sub1:maxBitRate>
</sub1:qciMaxBitRate>
</sub1:qciMaxBitRates>

<sub1:afApplications>
<sub1:afApplication>
<sub1:applicationIdentifier>AFApn1</sub1:applicati
onIdentifier>

<sub1:requestedPriority>7</sub1:requestedPriority>

<sub1:bandwidth>
</sub1:bandwidth>

<sub1:online>ENABLE_ONLINE</sub1:online>

<sub1:offline>ENABLE_OFFLINE</sub1:offline>

<sub1:meteringMethod>VOLUME</sub1:meteringMethod>

<sub1:ratingGroup>2</sub1:ratingGroup>
</sub1:afApplication>
</sub1:afApplications>

<sub1:customData>
<sub1:item>
<sub1:name>BCM_1</sub1:name>
<sub1:value>
<sub1:type>LIST</sub1:type>
<sub1:data>ENUM:BearerControlMode.RESERVED|Bear
erControlMode.UE_ONLY</sub1:data>
</sub1:value>
</sub1:item>
</sub1:customData>

<sub1:customDataProfiles>
<sub1:customDataProfile>CdProfile_1</sub1:customDataP
rofile>
</sub1:customDataProfiles>
</sub1:subProfile>
</sub:addSubscriberProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-3 lists the fields for the addSubscriberProfile command.
Table 3-3 subprofile request field descriptions
name A unique name for the subscriber Values: 1 to 80 characters Mandatory

Default: not set
ueAccessToKnownApps Establish the mode in which UE-initiated Values: true or false Optional
requests are handled by the 5780 DSC Type: boolean
for the subscriber. When set to false,
access to known applications is not Default: false
allowed.
ueAccessToUnKnownApps Establish the mode in which UE-initiated Values: true or false Optional
access to unknown applications is not Default: false
allowed.
calledStationIds This field is mandatory such that there — —

must be at least one item in the list.
item Values: 1 to 255 characters Mandatory
The identifier must match the value in Type: string
the Called-Station-Id AVP that is Default: not set
received during the creation of the
subscriber IP-CAN session. You can add
more than one called station ID to the
list.
defaultQCI Default QoS Class Identifier. Values: QCI 5 to QCI 9 Optional

Type: string
Default: not set
(1 of 6)
arp ARP is a group AVP that consists of three Values: n/a Optional
AVPs as follows: Type: tns:AllocationRetentionPriority
• priorityLevel Default: not set
• preEmptionCapability
• preEmptionVulnerability
priorityLevel Values: 1 to 15 Optional

Ensures that the request for the bearer Type: integer
with the higher priority level is Default: not set
preferred. In addition, the ARP can be
used by the eNodeB to decide which
bearer to drop during exceptional
resource limitations.
preEmptionCapability Values: Optional

Defines whether a bearer with a lower • PRE_EMPTION_CAPABILITY_ENABLED
ARP priority level should be dropped to • PRE_EMPTION_CAPABILITY_DISABLED
free up the required resources.
Type: string
Default: not set
preEmptionVulnerability Values: Optional

Defines whether a bearer can be • PRE_EMPTION_VULNERABILITY_ENABLED
dropped by a preemption capable • PRE_EMPTION_VULNERABILITY_DISABLED
bearer with a higher ARP priority value.
Type: string
Default: not set
aggregateMaxBitRate The APN-Aggregated-Max-Bitrate-DL — Optional

and APN-Aggregated-Max-Bitrate-UL
AVPs indicate the maximum aggregate
bit rate in bps for the downlink and
uplink directions across all non-GBR
bearers related to the same APN.
When provided in a CC-Request, it
indicates the subscribed maximum
bitrate. When provided in a CC-Answer,
it indicates the maximum bandwidth
authorized by the PCRF.
upLinkBw Values: Long values of up to a maximum of Optional

Aggregate maximum bit rate for the 4503599627370495, or 252. You cannot enter
traffic toward the network. 0 or a negative value.
Type: long
Default: not set
downLinkBw Values: Long values of up to a maximum of Optional

traffic toward the end user. 0 or a negative value.
Type: long
Default: not set
(2 of 6)
qciGuaranteedBitRates Contains the list of QoS identifiers with — Optional

the associated values for GBR
qciGuaranteedBitRate Values: complex type. It is composed of a Optional

Contains the guaranteed and maximum QCI (values 1-4), a GBR DL, MBR DL, GBR UL
bit rate for the specified GBR QCI. and MBR UL in bps
Type: string
Default: empty
qosId Values: QCI 1 to QCI 9 Optional

Indicates QoS-Class-Identifier for which Type: string
the maximum GBR and MBR are Default: not set
configured.
quaranteedBitRate — Optional
Contains the guaranteed and maximum
bit rate for the specified GBR QCI as
follows:
• maxGBR
• maxMBR
maxGBR Values: Long values of up to a maximum of Optional
Contains the maximum GBR uplink and 4503599627370495, or 252. You cannot enter
downlink values as follows: 0 or a negative value.
upLinkBw Type: long
Maximum guaranteed uplink bit rate for Default: not set
the specified QoS.
downLinkBw
Maximum guaranteed downlink bit rate
for the specified QoS.
maxMBR Values: Long values of up to a maximum of Optional
Contains the maximum MBR uplink and 4503599627370495, or 252. You cannot enter
upLinkBw Type: long
Maximum bit rate for downlink for the Default: not set
specified QoS.
downLinkBw
Maximum bit rate for download for the
specified QoS.
(3 of 6)
qciMaxBitRates Contains the list of QoS identifiers with — Optional

the associated values for non-GBR
values.
qciMaxbitRate Values: As defined in the enum Optional

Contains the maximum allowed limit for Type: Object
a non-GBR for each specified QCI. Default: none
qosId Values: OCI 1 to QCI 9 Mandatory

Indicates QoS-Class-Identifier for which Type: string within
the maximum bit rate is configured qciMaxBitRates
Default: not set
maxBitRate Values: Long values of up to a maximum of Optional

Contains the maximum bit rate values as 4503599627370495, or 252. You cannot enter
follows: 0 or a negative value.
upLinkBw Type: integer
Maximum bit rate for uplinks Default: not set
downLinkBw
Maximum bit rate for downlinks.
afApplications A list of application date. — Optional
afApplication Values: Optional

Represents a given set of application Complex type made up of an afApplication
data for a subscriber in the context of a Identifier (string), an ARP priority level
particular APN. (integer value between 1-15), charging
information (online, offline, metering
method and rating group) and acceptable
service information (max requested BW DL
and UL in bps)
Type: List of SubscriberApplicationData
Default: n/a
applicationidentifier Values: Mandatory

The AF Application Identifier is a • 1 and 255 characters (ASCII) within the
mandatory field and can be either ASCII application
• 1 and 510 characters (Hexadecimal)
or Hexadecimal.
The value must match the value in the Type: string
AF-Application-Identifier AVP received Default: not set
during the AF creation of a PCC Rule
requestedPriority Values: 1 to 15 Optional
The value used as the Priority Level in a Type: integer
PCC rule Allocation Retention Priority. Default: not set
bandwidth Values: Long values of up to a maximum of Optional

The bandwidth consists of the following: 4503599627370495, or 252. You cannot enter
0 or a negative value.
upLinkBw
Type: integer
The traffic toward the network
Default: not set
downLinkBw
The traffic toward the end user
online Values: Optional

A subscriber account is queried before • DISABLE_ONLINE
permission to use the requested network • ENABLE_ONLINE
resources is granted.
Type: string
Default: not set
(4 of 6)
afApplications (continued) offline Values: Optional

The resource usage is reported from the • DISABLE_OFFLINE
network to the billing domain after the • ENABLE_OFFLINE
resource usage occurred.
Type: string
Default: not set
meteringMethod Values: Optional

Defines the parameters that are • DURATION
metered for offline charging. • VOLUME
DURATION • DURATION_VOLUME
The duration of the service flow is
metered. Type: string
VOLUME Default: not set
The volume of the service flow traffic is
metered.
DURATION_VOLUME
The duration and the volume of the
service flow traffic are metered.
ratingGroup Values: integer Optional
The usage is reported on at the rating Type: string
group level. Default: 0
customData List of custom data entries . — —
item — —
• name
• value
name Values: 1 to 255 characters Mandatory

A unique identifier for the custom data. Type: string within each
item.
Default: not set
value Values: Optional

Defines the value of the item using: • STRING
• type • IP_ADDRESS
• data • LIST
• ENUM
type Optional
• NUMBER
Type of data held in the custom data • DECIMAL
item.
Type: string
(5 of 6)
customData (continued) data Values: Dependant on the Type selected. Optional

Contains the data for the custom data Type: string
item value. Default: no default value set
STRING
Contains a text string of the exact value
that you require for the action.
IP_ADDRESS
Contains a single IP address in any of the
accepted formats for an IP address.
and managing subscribers in the SPR” in
the 5780 DSC User Guide.
LIST
following:
• String
• IP Address

ENUM
the system and are available depending
on the Criteria attribute that you chose.
NUMBER
-(263) and 263 - 1
DECIMAL
customDataProfiles Defines a list of zero or more custom — Optional

the subscriber.

(6 of 6)
Response code
Code 3-4 shows the response code for the addSubscriberProfile command.
Code 3-4: addSubscriberProfile response code example

<env:Header/>
<env:Body>
<ns2:addSubscriberProfileResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.4 getAFApplications
Gets the list of AF applications from the subscriber profile object.
Parameter
• profileName
Request code
Code 3-5 shows a request code example for the getAFApplications command.
Code 3-5: getAFApplications request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getAFApplications>

</sub:getAFApplications>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-4 lists the fields for the getAFApplications command.
profileName A unique name for the subscriber data. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-6 shows the response code for the getAFApplications command.
Code 3-6: getAFApplications response code example

<env:Header/>
<env:Body>
<ns2:getAFApplicationsResponse
r"
riberprofile"
n"
<afApplication>
<applicationIdentifier>AFApn3</applicationIdentifier>
<requestedPriority>9</requestedPriority>
<bandwidth>
<upLinkBw>300</upLinkBw>
<downLinkBw>350</downLinkBw>
</bandwidth>
<online>ENABLE_ONLINE</online>
<offline>DISABLE_OFFLINE</offline>
<ratingGroup>6</ratingGroup>
</afApplication>
</ns2:getAFApplicationsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-5 lists the fields for the getAFApplications command.
Table 3-5 afApplication response field descriptions
applicationIdentifier The AF Application Identifier is a mandatory field and Values:

can be either ASCII or Hexadecimal. • 1 and 255 characters (ASCII)
Type: string
(1 of 2)
requestedPriority The value used as the Priority Level in a PCC rule Values: 1 to 15
Allocation Retention Priority. Type: integer
bandwidth upLinkBw Values: Long values of up to a maximum of

The traffic toward the network 4503599627370495, or 252. You cannot enter 0 or
a negative value.
downLinkBw
Type: integer
online A subscriber account is queried before permission to Values:

use the requested network resources is granted. • DISABLE_ONLINE
• ENABLE_ONLINE
Type: string
offline The resource usage is reported from the network to Values:

the billing domain after the resource usage occurred. • DISABLE_OFFLINE
• ENABLE_OFFLINE
Type: string
meteringMethod Defines the parameters that are metered for offline Values:
charging. • DURATION
DURATION • VOLUME
The duration of the service flow is metered. • DURATION_VOLUME
VOLUME
Type: string
The volume of the service flow traffic is metered.
DURATION_VOLUME
The duration and the volume of the service flow
traffic are metered.
ratingGroup The usage is reported on at the rating group level. Values: integer
Type: string
(2 of 2)
3.5 getCalledStationIds
Gets the list of called station Ids from the subscriber profile object.
Parameter
• profileName
Request code
Code 3-7 shows a request code example for the getCalledStationIds command.
Code 3-7: getCalledStationIds request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getCalledStationIds>

</sub:getCalledStationIds>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-6 lists the fields for the getCalledStationIds command.
Type: string
Default: empty
Response code
Code 3-8 shows the response code for the getCalledStationIds command.
Code 3-8: getCalledStationIds response code example

<env:Header/>
<env:Body>
<ns2:getCalledStationIdsResponse
r"
riberprofile"
n"
<calledStationId>apn1</calledStationId>
</ns2:getCalledStationIdsResponse>
</env:Body>
</env:Envelope
Response fields
Table 3-7 lists the fields for the getCalledStationIds command.
Table 3-7 getCalledStationIds response field descriptions
calledStationId A unique identifier for the called station ID. Values: 1 to 255 characters
Type: string
3.6 getQciGuaranteedBitRates
Gets the list of QCI guaranteed bit rates from the subscriber profile object.
Parameter
• profileName
Request code
Code 3-9 shows a request code example for the getQciGuaranteedBitRates
command.
Code 3-9: getQciGuaranteedBitRates request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getQciGuaranteedBitRates>

</sub:getQciGuaranteedBitRates>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-8 lists the fields for the getQciGuaranteedBitRates command.
Type: string
Default: empty
Response code
Code 3-10 shows the response code for the getQciGuaranteedBitRates command.
Code 3-10: getQciGuaranteedBitRates response code example

<env:Header/>
<env:Body>
<ns2:getQciGuaranteedBitRatesResponse
r"
riberprofile"
n"
<qciGuaranteedBitRate>
<qosId>QCI_1</qosId>
<guaranteedBitRate>
<maxGBR>
</maxGBR>
<maxMBR>
</maxMBR>
</guaranteedBitRate>
</qciGuaranteedBitRate>
</ns2:getQciGuaranteedBitRatesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-9 lists the fields for the getQciGuaranteedBitRates command.
Table 3-9 getQciGuaranteedBitRates response field descriptions
qosId Indicates QoS-Class-Identifier for which the maximum Values:

GBR and MBR are configured. QCI_1
QCI_2
QCI_3
QCI_4
QCI_5
QCI_6
QCI_7
QCI_8
QCI_9
Type: string
guaranteedBitRate quaranteedBitRate —
Contains the guaranteed and maximum bit rate for the
specified GBR QCI as follows:
• maxGBR
• maxMBR
maxGBR Values: Long values of up to a maximum of

Contains the maximum GBR uplink and downlink 4503599627370495, or 252. You cannot enter 0 or
values as follows: a negative value.
upLinkBw Type: long
Maximum guaranteed uplink bit rate for the specified
QoS.
downLinkBw
Maximum guaranteed downlink bit rate for the
specified QoS.
maxMBR Values: Long values of up to a maximum of

Contains the maximum MBR uplink and downlink 4503599627370495, or 252. You cannot enter 0 or
values as follows: a negative value.
upLinkBw Type: long
Maximum bit rate for downlink for the specified QoS.
downLinkBw
Maximum bit rate for download for the specified QoS.
3.7 getQciMaxBitRates
Gets the list of QCI maximum bit rates from the subscriber profile object.
Parameter
• profileName
Request code
Code 3-11 shows a request code example for the getQciMaxBitRate command.
Code 3-11: getQciMaxBitRate request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getQciMaxBitRates>

</sub:getQciMaxBitRates>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-10 lists the fields for the getQciMaxBitRates command.
Table 3-10 getQciMaxBitRates field descriptions
Type: string
Default: empty
Response code
Code 3-12 shows the response code for the getQciMaxBitRates command.
Code 3-12: getQciMaxBitRates response code example

<env:Header/>
<env:Body>
<ns2:getQciMaxBitRatesResponse
r"
riberprofile"
n"
<qciMaxBitRate>
<maxBitRate>
</maxBitRate>
</qciMaxBitRate>
</ns2:getQciMaxBitRatesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-11 lists the fields for the getQciMaxBitRates command.
Table 3-11 getQciMaxBitRates response field descriptions
qosId Indicates QoS-Class-Identifier for which the maximum Values:

GBR and MBR are configured.Values: QCI 1 to QCI 9 QCI_1
QCI_2
QCI_3
QCI_4
QCI_5
QCI_6
QCI_7
QCI_8
QCI_9
Type: string
maxBitRate Contains the maximum bit rate values as follows: Values: Long values of up to a maximum of
4503599627370495, or 252. You cannot enter 0 or
upLinkBw a negative value.
Maximum bit rate for uplinks Type: integer
downLinkBw
3.8 getSubscriberProfile
Gets the subscriber profile object.
Parameter
• profileName
Request code
Code 3-13 shows a request code example for the getSubscriberProfile command.
Code 3-13: getSubscriberProfile request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getSubscriberProfile>

</sub:getSubscriberProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-12 lists the fields for the getSubscriberProfile command.
Table 3-12 getSubscriberProfile field descriptions
Type: string
Default: empty
Response code
Code 3-14 shows the response code for the getSubscriberProfile command.
Code 3-14: getSubscriberProfile response code example

<env:Header/>
<env:Body>
<ns2:getSubscriberProfileResponse
r"
riberprofile"
n"
<subProfile>
<name>subProfile1</name>
<ueAccessToKnownApps>true</ueAccessToKnownApps>
<ueAccessToUnKnownApps>true</ueAccessToUnKnownApps>
<calledStationIds>
<item>apn1</item>
</calledStationIds>
<defaultQCI>QCI_9</defaultQCI>
<arp>
<priorityLevel>9</priorityLevel>
<preEmptionCapability>PRE_EMPTION_CAPABILITY_DISABLED
</preEmptionCapability>
</arp>
<aggregateMaxBitRate>
</aggregateMaxBitRate>
<qciGuaranteedBitRates>
<qciGuaranteedBitRate>
<guaranteedBitRate>
<maxGBR>
</maxGBR>
<maxMBR>
</maxMBR>
</guaranteedBitRate>
</qciGuaranteedBitRate>
</qciGuaranteedBitRates>
<qciMaxBitRates>
<qciMaxBitRate>
<maxBitRate>
</maxBitRate>
</qciMaxBitRate>
</qciMaxBitRates>
<afApplications>
<afApplication>
<applicationIdentifier>AFApn1</applicationIdentifi
er>
<requestedPriority>7</requestedPriority>
<bandwidth>
</bandwidth>
<offline>ENABLE_OFFLINE</offline>
<meteringMethod>VOLUME</meteringMethod>
<ratingGroup>2</ratingGroup>
</afApplication>
</afApplications>
<customData>
<item>
<name>BCM_1</name>
<value>
<type>LIST</type>
<data>ENUM:BearerControlMode.RESERVED|BearerCon
trolMode.UE_ONLY</data>
</value>
</item>
</customData>
<customDataProfile>CdProfile_1</customDataProfile>
</subProfile>
</ns2:getSubscriberProfileResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-13 lists the fields for the getSubscriberProfile command.

Default: not set
allowed.
allowed.

list.

Type: string
Default: not set
(1 of 7)
arp ARP is a group AVP that consists of three — Optional

AVPs as follows:
• priorityLevel


Type: string
Default: not set

Type: string
Default: not set


Type: long
Default: not set

Type: long
Default: not set
(2 of 7)


Type: string
Default: empty

configured.
follows:
• maxGBR
• maxMBR
upLinkBw Type: long
the specified QoS.
downLinkBw
upLinkBw Type: long
specified QoS.
downLinkBw
specified QoS.
(3 of 7)

values.


Default: not set

downLinkBw
afApplications A list of application date. — Optional
afApplication Values: Optional

Represents a given set of application Complex type made up of an afApplication
data for a subscriber in the context of a Identifier (string), an ARP priority level
particular APN. (integer value between 1-15), charging
and UL in bps)
Default: n/a

or Hexadecimal.
(4 of 7)
afApplications (continued) bandwidth Values: Long values of up to a maximum of Optional

upLinkBw
Type: integer
Default: not set
downLinkBw

Type: string
Default: not set
offline Values: Optional
Type: string
Default: not set

metered.
DURATION_VOLUME

(5 of 7)
item — —
• name
• value

item.
Default: not set
value Values: Optional

Defines the value of the item using: • STRING
• type • IP_ADDRESS
• data • LIST
• ENUM
type Optional
• NUMBER
item.
Type: string
(6 of 7)

STRING
IP_ADDRESS
LIST
following:
• String
• IP Address

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL

the subscriber.
customDataProfile Values: 1 to 80 characters

(7 of 7)
3.9 getSubscriberProfileCustomData
Gets the set of custom data entries from the subscriber profile object.
Parameter
• profileName
Request code
Code 3-15 shows a request code example for the getSubscriberProfileCustomData
command.
Code 3-15: getSubscriberProfileCustomData request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getSubscriberProfileCustomData>

</sub:getSubscriberProfileCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-14 lists the fields for the getSubscriberProfileCustomData command.
Table 3-14 getSubscriberProfileCustomData field descriptions

Type: string
Default: empty
Response code
Code 3-16 shows the response code for the getSubscriberProfileCustomData
command.
Code 3-16: getSubscriberProfileCustomData response code example

<env:Header/>
<env:Body>
<ns2:getSubscriberProfileCustomDataResponse
r"
riberprofile"
n"
<customData>
<name>BCM_1</name>
<value>
<type>LIST</type>
<data>ENUM:BearerControlMode.RESERVED|BearerControlMo
de.UE_ONLY</data>
</value>
</customData>
</ns2:getSubscriberProfileCustomDataResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-15 lists the fields for the getSubscriberProfileCustomData command.
Table 3-15 getSubscriberProfileCustomData field descriptions
customData Defines the custom data used for a single custom data entry — Optional
based on:
• name
• value

Default: n/a

Defines the value of the item using: item.
• type
• data

• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData data Values: Dependant on the Type Mandatory within each

(continued) Contains the data for the custom data item value. selected. item.
STRING Type: string
the action.
IP_ADDRESS
an IP address.
LIST
• String
• IP Address

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
(2 of 2)
3.10 getSubscriberProfileCustomDataProfiles
Gets the set of custom data profile from the subscriber profile.
Parameter
• profileName
Request code
Code 3-17 shows a request code example for the
getSubscriberProfileCustomDataProfiles command.
Code 3-17: getSubscriberProfileCustomDataProfiles request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getSubscriberProfileCustomDataProfiles>

</sub:getSubscriberProfileCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-16 lists the fields for the getSubscriberProfileCustomDataProfiles
command.
Table 3-16 getSubscriberProfileCustomDataProfiles field descriptions
Type: string
Default: empty
Response code
Code 3-18 shows the response code for the getSubscriberProfileCustomDataProfiles
command.
Code 3-18: getSubscriberProfileCustomDataProfiles response code example

<env:Header/>
<env:Body>
<ns2:getSubscriberProfileCustomDataProfilesResponse
r"
riberprofile"
n"
<customDataProfile>CdProfile_1</customDataProfile>
</ns2:getSubscriberProfileCustomDataProfilesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-17 lists the fields for the getSubscriberProfileCustomDataProfile command.
Table 3-17 getSubscriberProfileCustomDataProfile field descriptions

Type: string
3.11 removeSubscriberProfile
Removes the subscriber profile object.
Parameter
• profileName
Request code
Code 3-19 shows a request code example for the removeSubscriberProfile
command.
Code 3-19: removeSubscriberProfile request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:removeSubscriberProfile>

</sub:removeSubscriberProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-18 lists the fields for the removeSubscriberProfile command.
Table 3-18 removeSubscriberProfile field descriptions
Type: string
Default: empty
Response code
Code 3-20 shows the response code for the removeSubscriberProfile command.
Code 3-20: removeSubscriberProfile response code example

<env:Header/>
<env:Body>
<ns2:removeSubscriberProfileResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.12 updateAFApplicationEntry
Updates the specified AF application entry for the subscriber profile object.
Parameters
• profileName
• afApplication
Represents a given set of application data for a subscriber in the context of a
particular APN.
Request code
Code 3-21 shows a request code example for the updateAFApplicationEntry
command.
Code 3-21: updateAFApplicationEntry request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAFApplicationEntry>


<sub1:applicationIdentifier>AFApn2</sub1:applicationIden
tifier>


<sub1:bandwidth>
</sub1:bandwidth>

<sub1:online>DISABLE_ONLINE</sub1:online>

<sub1:offline>DISABLE_OFFLINE</sub1:offline>

<sub1:meteringMethod>DURATION_VOLUME</sub1:meteringMetho
d>

</sub:updateAFApplicationEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-19 and 3-20 list the fields for the updateAFApplicationEntry command.
Type: string
Default: empty
Table 3-20 afApplication field descriptions
afApplication Represents a given set of application data for a subscriber in Values: Optional
the context of a particular APN. Complex type made up of an
afApplication Identifier (string),
an ARP priority level (integer
value between 1-15), charging
information (online, offline,
metering method and rating
group) and acceptable service
information (max requested BW
DL and UL in bps)
Type: List of
SubscriberApplicationData
Default: n/a
applicationidentifier Values: Mandatory within the

The AF Application Identifier is a mandatory field and can be • 1 and 255 characters (ASCII) application
either ASCII or Hexadecimal. • 1 and 510 characters
The value must match the value in the (Hexadecimal)
AF-Application-Identifier AVP received during the AF creation
of a PCC Rule Type: string
Default: not set

The value used as the Priority Level in a PCC rule Allocation Type: integer
Retention Priority. Default: not set
Bandwidth Values: Long values of up to a Optional
The bandwidth consists of the following: maximum of
4503599627370495, or 252. You
upLinkBw cannot enter 0 or a negative
The traffic toward the network value.
downLinkBw Type: integer
The traffic toward the end user Default: not set

A subscriber account is queried before permission to use the • DISABLE_ONLINE
requested network resources is granted. • ENABLE_ONLINE
Type: string
Default: not set
(1 of 2)
afApplication offline Values: Optional

(continued) The resource usage is reported from the network to the billing • DISABLE_OFFLINE
domain after the resource usage occurred. • ENABLE_OFFLINE
Type: string
Default: not set

Defines the parameters that are metered for offline charging. • DURATION
DURATION • VOLUME
VOLUME Type: string
The volume of the service flow traffic is metered. Default: not set
DURATION_VOLUME
The duration and the volume of the service flow traffic are
metered.
The usage is reported on at the rating group level. Type: string
Default: 0
(2 of 2)
Response code
Code 3-22 shows the response code for the updateAFApplicationEntry command.
Code 3-22: updateAFApplicationEntry response code example

<env:Header/>
<env:Body>
<ns2:updateAFApplicationEntryResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.13 updateAFApplications
Updates all the AF application entries for the subscriber profile object.
Parameters
• profileName
• afApplication
Represents a given set of application data for a subscriber in the context of a
particular APN.
Request code
Code 3-23 shows a request code example for the updateAFApplications command.
Code 3-23: updateAFApplications request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAFApplications>

<sub1:applicationIdentifier>AFApn2</sub1:applicationIden
tifier>


<sub1:bandwidth>
</sub1:bandwidth>

<sub1:online>DISABLE_ONLINE</sub1:online>


<sub1:meteringMethod>DURATION_VOLUME</sub1:meteringMetho
d>

</sub:updateAFApplications>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-21 and 3-22 lists the fields for the updateAFApplications command.
Type: string
Default: empty
Table 3-22 afApplication field descriptions
afApplication Represents a given set of application data for a subscriber in Values: Optional
the context of a particular APN. Complex type made up of an
afApplication Identifier (string),
an ARP priority level (integer
value between 1-15), charging
information (online, offline,
metering method and rating
group) and acceptable service
information (max requested BW
DL and UL in bps)
Type: List of
SubscriberApplicationData
Default: n/a
applicationidentifier Values: Mandatory within the

The AF Application Identifier is a mandatory field and can be • 1 and 255 characters (ASCII) application
either ASCII or Hexadecimal. • 1 and 510 characters
The value must match the value in the (Hexadecimal)
AF-Application-Identifier AVP received during the AF creation
of a PCC Rule Type: string
Default: not set

The value used as the Priority Level in a PCC rule Allocation Type: integer
Retention Priority. Default: not set
bandwidth Values: Long values of up to a Optional

The bandwidth consists of the following: maximum of
4503599627370495, or 252. You
The traffic toward the network value.
The traffic toward the end user Default: not set

Type: string
Default: not set
(1 of 2)
afApplication offline Values: Optional

(continued) The resource usage is reported from the network to the billing • DISABLE_OFFLINE
Type: string
Default: not set

DURATION • VOLUME
VOLUME Type: string
The volume of the service flow traffic is metered. Default: not set
DURATION_VOLUME
metered.
Default: 0
(2 of 2)
Response code
Code 3-24 shows the response code for the updateAFApplications command.
Code 3-24: updateAFApplications response code example

<env:Header/>
<env:Body>
<ns2:updateAFApplicationsResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.14 updateCalledStationIds
Updates the complete list of called station Ids for the subscriber profile object.
Parameters
• profileName
• calledstationId
A unique identifier for the called station ID.
Request code
Code 3-25 shows a request code example for the updateCalledStationIds command.
Code 3-25: updateCalledStationIds request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateCalledStationIds>

<sub1:calledStationId>Apn3</sub1:calledStationId>
</sub:updateCalledStationIds>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-23 and 3-24 lists the fields for the updateCalledStationIds command.
Type: string
Default: empty
Table 3-24 calledStationId field descriptions
calledStationId A unique identifier for the called station ID. Values: 1 to 255 characters Optional
Type: string
Default: empty
Response code
Code 3-26 shows the response code for the updateCalledStationIds command.
Code 3-26: updateCalledStationIds response code example

<env:Header/>
<env:Body>
<ns2:updateCalledStationIdsResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.15 updateQciGuaranteedBitRateEntry
Updates the specified QCI guaranteed bit rate entries for the subscriber profile
object.
Parameters
• profileName
• qciGuaranteedBitRate
The specified QCI guaranteed bit rate entries for the subscriber profile object.
Request code
Code 3-27 shows a request code example for the UpdateQciGuaranteedBitRateEntry
command.
Code 3-27: updateQciGuaranteedBitRateEntry request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateQciGuaranteedBitRateEntry>



<sub1:maxGBR>
</sub1:maxGBR>

<sub1:maxMBR>
</sub1:maxMBR>
</sub:updateQciGuaranteedBitRateEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-25 and 3-26 list the fields for the UpdateQciGuaranteedBitRateEntry
command.
Type: string
Default: empty
Table 3-26 qciGuaranteedBitRate field descriptions
qosId Indicates QoS-Class-Identifier for which the maximum GBR and Values: QCI 1 to QCI 9 Optional
MBR are configured. Type: string
Default: not set
quaranteedBitRate Contains the guaranteed and maximum bit rate for the — Optional
• maxGBR
• maxMBR
maxGBR Values: Long values of up to a Optional

Contains the maximum GBR uplink and downlink values as maximum of
follows: 4503599627370495, or 252. You
upLinkBw value.
Maximum guaranteed uplink bit rate for the specified QoS. Type: long
downLinkBw Default: not set
Maximum guaranteed downlink bit rate for the specified QoS.
maxMBR Values: Long values of up to a Optional

Contains the maximum MBR uplink and downlink values as maximum of
follows: 4503599627370495, or 252. You
upLinkBw value.
Maximum bit rate for downlink for the specified QoS. Type: long
Response code
Code 3-28 shows the response code for the UpdateQciGuaranteedBitRateEntry
command.
Code 3-28: UpdateQciGuaranteedBitRateEntry response code example

<env:Header/>
<env:Body>
<ns2:updateQciGuaranteedBitRateEntryResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.16 updateQciGuaranteedBitRates
Updates the complete set of QCI guaranteed bit rate entries for the subscriber profile
object.
Parameters
• profileName
• qciGuaranteedBitRate
The complete set of QCI guaranteed bit rate entries for the subscriber profile
object.
Request code
Code 3-29 shows a request code example for the updateQciGuaranteedBitRates
command.
Code 3-29: updateQciGuaranteedBitRates request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateQciGuaranteedBitRates>


<sub1:maxGBR>
</sub1:maxGBR>

<sub1:maxMBR>
</sub1:maxMBR>
</sub:updateQciGuaranteedBitRates>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-27 and 3-28 list the fields for the updateQciGuaranteedBitRates command.
Type: string
Default: empty
Table 3-28 qciGuaranteedBitRate field descriptions
qciGuaranteedBitRate Contains the guaranteed and maximum bit rate for the Values: complex type. It is Optional
specified GBR QCI. composed of a QCI (values 1-4),
a GBR DL, MBR DL, GBR UL and
MBR UL in bps
Type: string
Default: empty

Indicates QoS-Class-Identifier for which the maximum GBR Type: string
and MBR are configured. Default: not set
Contains the guaranteed and maximum bit rate for the
• maxGBR
• maxMBR
maxGBR Values: Long values of up to a Optional

Contains the maximum GBR uplink and downlink values as maximum of
follows: 4503599627370495, or 252. You
upLinkBw value.
Maximum guaranteed uplink bit rate for the specified QoS. Type: long
Maximum guaranteed downlink bit rate for the specified
QoS.
maxMBR Values: Long values of up to a Optional
Contains the maximum MBR uplink and downlink values as maximum of
follows: 4503599627370495, or 252. You
upLinkBw value.
Maximum bit rate for downlink for the specified QoS. Type: long
Response code
Code 3-30 shows the response code for the updateQciGuaranteedBitRates command.
Code 3-30: updateQciGuaranteedBitRates response code example

<env:Header/>
<env:Body>
<ns2:updateQciGuaranteedBitRatesResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.17 updateQciMaxBitRateEntry
Updates the specified QCI maximum bit rate entries for the subscriber profile object.
Parameters
• profileName
• qciMaxBitRate
The specified QCI maximum bit rate entries for the subscriber profile object.
Request code
Code 3-31 shows a request code example for the updateQciMaxBitRateEntry
command.
Code 3-31: updateQciMaxBitRateEntry request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateQciMaxBitRateEntry>


<sub1:maxBitRate>
</sub1:maxBitRate>
</sub:updateQciMaxBitRateEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-29 and 3-30 lists the fields for the updateQciMaxBitRateEntry command.
Type: string
Default: empty
Table 3-30 qciMaxBitRate field descriptions
qosId Indicates QoS-Class-Identifier for which the maximum bit rate Values: OCI 1 to QCI 9 Mandatory within
is configured Type: string qciMaxBitRates
Default: not set
maxBitRate Contains the maximum bit rate values as follows: — Optional

• upLinkBw
• downLinkBw
upLinkBw Values: Long values of up to a Optional

Maximum bit rate for uplinks maximum of
4503599627370495, or 252. You
value.
Type: integer
Default: not set
downLinkBw Values: Long values of up to a Optional
Maximum bit rate for downlinks. maximum of
4503599627370495, or 252. You
value.
Type: integer
Default: not set
Response code
Code 3-32 shows the response code for the updateQciMaxBitRateEntry command.
Code 3-32: updateQciMaxBitRateEntry response code example

<env:Header/>
<env:Body>
<ns2:updateQciMaxBitRateEntryResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.18 updateQciMaxBitRates
Updates the complete set of QCI maximum bit rate entries for the subscriber profile
object.
Parameters
• profileName
• qciMaxBitRate
The specified QCI maximum bit rate entries for the subscriber profile object.
Request code
Code 3-33 shows a request code example for the updateQciMaxBitRates command.
Code 3-33: updateQciMaxBitRates request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateQciMaxBitRates>

<sub1:maxBitRate>
</sub1:maxBitRate>
</sub:updateQciMaxBitRates>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-31 and 3-32 list the fields for the updateQciMaxBitRates command.
Type: string
Default: empty
Table 3-32 qciMaxBitRate field descriptions
qosId Indicates QoS-Class-Identifier for which the maximum bit rate Values: OCI 1 to QCI 9 Mandatory within
is configured Type: string qciMaxBitRates
Default: not set
maxBitRate Contains the maximum bit rate values as follows: — Optional

• upLinkBw
• downLinkBw
upLinkBw Values: Long values of up to a Optional

Maximum bit rate for uplinks maximum of
4503599627370495, or 252. You
value.
Type: integer
Default: not set
downLinkBw Values: Long values of up to a Optional
Maximum bit rate for downlinks. maximum of
4503599627370495, or 252. You
value.
Type: integer
Default: not set
maxBitRate Values: Long values of up to a Optional

Contains the maximum bit rate values as follows: maximum of
4503599627370495, or 252. You
Maximum bit rate for uplinks value.
Maximum bit rate for downlinks. Default: not set
Response code
Code 3-34 shows the response code for the updateQciMaxBitRates command.
Code 3-34: updateQciMaxBitRates response code example

<env:Header/>
<env:Body>
<ns2:updateQciMaxBitRatesResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.19 updateSubscriberProfile
Updates the specified subscriber profile object by replacing the existing value with
those specified.
Parameters
• subProfile
The subscriber profile object to be added.
Request code
Code 3-35 shows a request code example for the updateSubscriberProfile command.
Code 3-35: updateSubscriberProfile request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriberProfile>

<sub1:subProfile>
<sub1:name>subProfile1</sub1:name>
<sub1:ueAccessToKnownApps>true</sub1:ueAccessToKnownApps
>
<sub1:ueAccessToUnKnownApps>true</sub1:ueAccessToUnKnown
Apps>
<sub1:calledStationIds>
<sub1:item>Apn9</sub1:item>
</sub1:calledStationIds>

<sub1:defaultQCI>QCI_7</sub1:defaultQCI>

<sub1:arp>

<sub1:priorityLevel>8</sub1:priorityLevel>

<sub1:preEmptionCapability>PRE_EMPTION_CAPABILITY_DIS
ABLED</sub1:preEmptionCapability>

<sub1:preEmptionVulnerability>PRE_EMPTION_VULNERABILI
TY_ENABLED</sub1:preEmptionVulnerability>
</sub1:arp>

<sub1:aggregateMaxBitRate>
</sub1:aggregateMaxBitRate>

<sub1:qciGuaranteedBitRates>

<sub1:maxGBR>
</sub1:maxGBR>

<sub1:maxMBR>
</sub1:maxMBR>
</sub1:qciGuaranteedBitRates>

<sub1:qciMaxBitRates>
<sub1:maxBitRate>
</sub1:maxBitRate>
</sub1:qciMaxBitRates>

<sub1:afApplications>
<sub1:applicationIdentifier>AFApn3</sub1:applicati
onIdentifier>


<sub1:bandwidth>
</sub1:bandwidth>

<sub1:online>ENABLE_ONLINE</sub1:online>


<sub1:meteringMethod>VOLUME</sub1:meteringMethod>

</sub1:afApplications>

<sub1:customData>
<sub1:item>
<sub1:name>Language</sub1:name>
<sub1:value>
<sub1:data>STRING:English|French|BahasaMalaysia
</sub1:data>
</sub1:value>
</sub1:item>
</sub1:customData>

<sub1:customDataProfiles>
<sub1:customDataProfile>Euro_Zone_1</sub1:customDataP
rofile>
</sub1:customDataProfiles>
</sub1:subProfile>
</sub:updateSubscriberProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-33 lists the fields for the updateSubscriberProfile command.

Default: not set
allowed.
allowed.


list.

Type: string
Default: not set
arp ARP is a group AVP that consists of three Values: Optional

AVPs as follows: Type: tns:AllocationRetentionPriority
• priorityLevel Default: not set


Type: string
Default: not set

Type: string
Default: not set
(1 of 6)


Type: long
Default: not set

Type: long
Default: not set
(2 of 6)


Type: string
Default: empty

configured.
follows:
• maxGBR
• maxMBR
upLinkBw Type: long
the specified QoS.
downLinkBw
upLinkBw Type: long
specified QoS.
downLinkBw
specified QoS.
(3 of 6)

values.


Default: not set

downLinkBw
afApplications Represents a given set of application Values: Optional

data for a subscriber in the context of a Complex type made up of an afApplication
particular APN. Identifier (string), an ARP priority level
(integer value between 1-15), charging
and UL in bps)
Default: n/a

or Hexadecimal.

Bandwidth Values: Long values of up to a maximum of Optional

upLinkBw
Type: integer
Default: not set
downLinkBw

Type: string
Default: not set
(4 of 6)
afApplications (continued) offline Values: Optional

Type: string
Default: not set

metered.
DURATION_VOLUME
item — —
• name
• value

item.
Default: not set
value Values:
Defines the value of the item using: • STRING Mandatory
• type • IP_ADDRESS within each
• LIST item.
• data
• ENUM
type
• NUMBER
item.
Type: string
(5 of 6)

STRING
IP_ADDRESS
LIST
following:
• String
• IP Address

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL

the subscriber.
customDataProfile Values: 1 to 80 characters

(6 of 6)
Response code
Code 3-36 shows the response code for the updateSubscriberProfile command.
Code 3-36: updateSubscriberProfile response code example

<env:Header/>
<env:Body>
<ns2:updateSubscriberProfileResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.20 updateSubscriberProfileCustomData
Updates the complete set of subscriber profile custom data entries for the subscriber
profile object.
Parameters
• profileName
• customData
Defines a list of one or more custom data entries (item).
Request code
updateSubscriberProfileCustomData command.
Code 3-37: updateSubscriberProfileCustomData request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriberProfileCustomData>

<sub1:customData>
<sub1:name>Language</sub1:name>
<sub1:value>
<sub1:data>STRING:English|French|BahasaMalaysia</sub1
:data>
</sub1:value>
</sub1:customData>
</sub:updateSubscriberProfileCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-34 and 3-35 list the fields for the updateSubscriberProfileCustomData
command.
Type: string
Default: empty
customData Defines the custom data used for a — —

• name
• value
name Values: 1 to 255 characters Mandatory within

A unique identifier for the custom data. Type: string each item.
Default: n/a
value — —
• type
• data

Type of data held in the custom data • STRING each item.
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData (continued) data Values: Dependant on the Type —

Contains the data for the custom data selected.
item value. Type: string
STRING Default: no default value set
IP_ADDRESS
LIST
following:
• String
• IP Address

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL
(2 of 2)
Response code
Code 3-38 shows the response code for the updateSubscriberProfileCustomData
command.
Code 3-38: updateSubscriberProfileCustomData response code example

<env:Header/>
<env:Body>
<ns2:updateSubscriberProfileCustomDataResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.21 updateSubscriberProfileCustomDataEntry
Updates the specified subscriber profile custom data entry for the subscriber profile
object.
Parameters
• profileName
• customData
Defines a list of one or more custom data entries (item).
Request code
updateSubscriberProfileCustomDataEntry command.
Code 3-39: updateSubscriberProfileCustomDataEntry request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriberProfileCustomDataEntry>


<sub1:customData>
<sub1:name>Segment</sub1:name>
<sub1:value>
<sub1:data>STRING:B|R|S|Z</sub1:data>
</sub1:value>
</sub1:customData>
</sub:updateSubscriberProfileCustomDataEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-36 and 3-37 lists the fields for the
Type: string
Default: empty
customData Defines the custom data used for a — —

• name
• value
Default: n/a
value — —
• type
• data

• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData (continued) data Values: Dependant on the Type Optional

IP_ADDRESS
LIST
following:
• String
• IP Address

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL
(2 of 2)
Response code
Code 3-40 shows the response code for the
Code 3-40: updateSubscriberProfileCustomDataEntry response code example

<env:Header/>
<env:Body>
<ns2:updateSubscriberProfileCustomDataEntryResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
3.22 updateSubscriberProfileCustomDataProfiles
Updates the specified subscriber profile custom data profile for the subscriber profile
object.
Parameters
• profileName
Defines a list of zero or more custom data profile names that are applied to the
subscriber.
Request code
updateSubscriberProfileCustomDataProfiles command.
Code 3-41: updateSubscriberProfileCustomDataProfiles request code example

<soapenv:Envelope
n"
riberprofile"
criber">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriberProfileCustomDataProfiles>

<sub1:customDataProfile>Upd_CustomDataProfile9</sub1:custom
DataProfile>
</sub:updateSubscriberProfileCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-38 and 3-39 lists the fields for the
Type: string
Default: empty
Table 3-39 customDataProfiles field descriptions

the subscriber.

Response code
Code 3-42: updateSubscriberProfileCustomDataProfiles response code example

<env:Header/>
<env:Body>
<ns2:updateSubscriberProfileCustomDataProfilesResponse
r"
riberprofile"
n"
>
</env:Body>
</env:Envelope>
4— Rule provisioning API
4.1 Using the rule provisioning API 4-3
4.2 activateRuleSystemVersion 4-3
4.3 addCustomDataProfiles 4-4
4.4 addMeteringLimits 4-8
4.5 cloneRuleSystemVersion 4-22
4.6 exportRuleSystemVersion 4-24
4.7 getActiveRuleSystemVersionName 4-35
4.8 getCustomDataProfile 4-37
4.9 getCustomDataProfile_CustomData 4-40
4.10 getCustomDataProfilePriority 4-43
4.11 getMeteringLimit 4-45
4.12 getMeteringLimitApplicabilityConditions 4-51
4.13 getMeteringLimitDefaultActions 4-55
4.14 getMeteringLimitNames 4-60
4.15 getMeteringLimitPriority 4-61
4 — Rule provisioning API
4.16 getMeteringLimitQuota 4-63
4.17 getMeteringLimits 4-65
4.18 getRuleSystemVersion 4-74
4.19 getRuleSystemVersionDescription 4-76
4.20 getRuleSystemVersionNames 4-78
4.21 importRuleSystemVersion 4-79
4.22 removeCustomDataProfile 4-91
4.23 removeMeteringLimit 4-93
4.24 removeRuleSystemVersion 4-94
4.25 updateCustomDataProfile 4-95
4.26 updateCustomDataProfile_CustomData 4-99
4.27 updateCustomDataProfile_CustomDataEntry 4-102
4.28 updateCustomDataProfilePriority 4-105
4.29 updateMeteringLimit 4-106
4.30 updateMeteringLimitApplicabilityConditions 4-114
4.31 updateMeteringLimitDefaultActions 4-118
4.32 updateMeteringLimitPriority 4-122
4.33 updateMeteringLimitQuota 4-124
4.34 updateMeteringLimitRateLimitRate 4-125
4.35 updateRuleSystemVersionDescription 4-128
4.1 Using the rule provisioning API
The rule system provisioning API is used to perform operations related to rule
system provisioning, such as adding, updating, and removing rule system versions
and the managed object that are contained within, for example, metering limits,
notification templates, and rules.
4.2 activateRuleSystemVersion
Activates the specified rule system version.

While activating the specified rule system version, the currently active rule system
version is moved to a RELEASE state. On success, nothing is returned. On failure, a
functional error is thrown.
When sending a rule provisioning API request to a rule system version in a
RELEASE state, the rule system version is updated to DRAFT and the rule request
is performed.
Parameter
• name
The name of the rule system version to activate.
Request code
Code 4-1 shows a request code example for the activateRuleSystemVersion
command.
Code 4-1: activateRuleSystemVersion request code example

<soapenv:Envelope
n"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesy
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:activateRuleSystemVersion>

<ns:name>RSV1</ns:name>
</ns:activateRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-1 lists the fields required for the activateRuleSystemVersion command.
Table 4-1 name field descriptions
name The name of the rule system version to Values: 1 to 255 characters Mandatory
activate. Type: string
Default: n/a
Response code
Code 4-2 shows the response code for the activateRuleSystemVersion command.
Code 4-2: activateRuleSystemVersion response code example

<env:Header/>
<env:Body>
<activateRuleSystemVersionResponse
m"
"/>
</env:Body>
</env:Envelope>
4.3 addCustomDataProfiles
Adds a custom data profile object to the specified rule system version.
Parameter
Identifies the custom data profile.
Request code
Code 4-3 shows a request code example for the addCustomDataProfile command.
Code 4-3: addCustomDataProfile request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
<ns1:requestId>396321</ns1:requestId
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:addCustomDataProfile>
<ns:customDataProfile>
<ns:versionedObjectId>
<ns:name>CDP1</ns:name>
<ns:ruleSystemVersionName>ns</ns:ruleSystemVersionNam
e>
</ns:versionedObjectId>

<ns:description>c1</ns:description>
<ns:priority>0</ns:priority>

<ns:customData>
<ns:item>
<ns:value>
<ns:value>999.999</ns:value>
</ns:value>
</ns:item>
</ns:customData>
</ns:customDataProfile>
</ns:addCustomDataProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-2 lists the fields required for the addCustomDataProfile command.
Table 4-2 addCustomDataProfile field descriptions
versionedObjectId The ID of the custom data profile. — Mandatory

The name of a custom data profile to be Type: string
added. Default: n/a
ruleSystemVersionName Values: 1 to 80 characters Mandatory

The name of the rule system version in Type: string
which the custom data profile is Default: n/a
defined.
Note: A null value for the RSV name will
result in an error.
description A description to provide more Values: 0 to 255 characters Optional

information about the rule system Type: string
version.
Default: n/a
(1 of 3)
priority A number that states the precedence of Values:1 to 15 Mandatory

this custom data profiles opposed to Type: integer
other custom data profiles that may be
assigned to the subscriber (1=high; Default: 0
15=low).
customData Defines a list of one or more custom data — Optional

entries (item).
item — —
• name
• value

Default: n/a
value — —
• type
• value

• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(2 of 3)
customData (continued) value Values: Dependant on the Type Optional

IP_ADDRESS
LIST
following:
• STRING
• IP_ADDRESS

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL
(3 of 3)
Response code
Code 4-4 shows the response code for the addCustomDataProfile command.
Code 4-4: addCustomDataProfile response code example

<env:Header/>
<env:Body>
<addCustomDataProfileResponse
m"
"/>
</env:Body>
</env:Envelope>
4.4 addMeteringLimits
Adds a metering limit object to the specified rule system version.
Parameter
• meteringLimit
Metering limit to be added.
Request code
Code 4-5 shows a request code example for the addMeteringLimits command.
Code 4-5: addMeteringLimits request code example

<soapenv:Envelope
xmlns:cm="http://www.alcatellucent.com/dsc/provisioningapi/51/common
"
m">
<soapenv:Header>
<cm:header>
<cm:clientAppId>4821</cm:clientAppId>
<cm:requestId>396321</cm:requestId>
</cm:header>
</soapenv:Header>
<soapenv:Body>
<addMeteringLimits>
<meteringLimit>
<versionedObjectId>
<name>mlnew</name>
<ruleSystemVersionName>clone1</ruleSystemVersionName>
</versionedObjectId>
<description>Roaming_7_6_N</description>
<sessionMonitoringKey>a</sessionMonitoringKey>
<flowLevelArming>VFBIL_flowKey</flowLevelArming>
<meteringLimitType>BASIC</meteringLimitType>
<priority>2114901</priority>
<quotaType>TOTAL</quotaType>
<quota>2.0992E7</quota>
<overageAllowed>false</overageAllowed>
<baseUnit>102400.0</baseUnit>
<minimumBaseUnit>4</minimumBaseUnit>
<recurrence>MONTHLY</recurrence>
<validityPeriod>1</validityPeriod>
<carryOverExpiration>TWO_MONTHS</carryOverExpiration>
<applicabilityConditions>
<condition>
<criteria>
<sourceContext>WNG_EVENTS</sourceContext>
<name>WNG-Event.Severity</name>
</criteria>
<criteriaArguments>
<argument>
<name>Event-Type</name>
<value>
<type>ENUM</type>
<value>WNGEventType.BATTERYATTACK_DISTRIB
UTED</value>
</value>
</argument>
</criteriaArguments>
<operator>EQUAL</operator>
<value>
<type>ENUM</type>
<value>WNGEventSeverity.CRITICAL_CLEARED</value
>
</value>
<valueArguments/>
<adjustmentOperator/>
<adjustmentValues/>
</condition>
<condition>
<criteria>
<sourceContext>WNG_ALERT</sourceContext>
<name>Congestion-Intensity</name>
</criteria>
<criteriaArguments/>
<operator>GREATER_THAN</operator>
<value>
<type>NUMBER</type>
<value>9999</value>
</value>
<valueArguments/>
<adjustmentOperator>ADD</adjustmentOperator>
<adjustmentValues>
<value>
<value>
<value>99</value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
</applicabilityConditions>
<defaultActions>
<action>
<actionAttribute>
<resultContext>METERING_FLOW_DEFAULT</resultCon
text>
<name>Penalty-Period</name>
</actionAttribute>
<data>
<type>NUMBER</type>
<value>12</value>
</data>
<dataArguments/>
</action>
</defaultActions>
</meteringLimit>
<meteringLimit>
<versionedObjectId>
<name>NeverExpired_ML2</name>
<description>Never_Expired_ML2</description>
<flowLevelArming>ML_flowKey</flowLevelArming>
<quotaType>TIME</quotaType>
<overageAllowed>true</overageAllowed>
<baseUnit>160</baseUnit>
<recurrence>WEEKLY</recurrence>
<carryOverExpiration>NEVER_EXPIRE</carryOverExpiration>
<condition>
<criteria>
<sourceContext>ACCOUNT</sourceContext>
<name>Account-Billing-Day</name>
</criteria>
<value>
<type>NUMBER</type>
<value>15</value>
</value>
<valueArguments/>
<adjustmentValues>
<value>
<value>
<type>TIME_DURATION</type>
<value>93785000</value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
<defaultActions>
<action>
<actionAttribute>
<resultContext>NOTIFICATION_VARS</resultContext
>
<name>Is-In-Penalty-State</name>
</actionAttribute>
<data>
<type>STRING</type>
<value>TimeUp</value>
</data>
<dataArguments/>
</action>
</defaultActions>
</meteringLimit>
</addMeteringLimits>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-3 lists the fields required for the addMeteringLimits command.
Table 4-3 addMeteringLimits field descriptions
versionedObjectId The ID of the metering limit for which the — Mandatory

rule will be updated.

The name of the metering limit to be Type: string
added. Default: n/a

which the metering limit is defined. Default: n/a
result in an error.

information about the metering limit. Type: string
Default: n/a
sessionMonitoringKey Defines a metering limit as being for a Values: 0 to 255 characters Optional
session and allows you to provide a name Type: string
that identifies the metering limit as a
session-level monitoring key. Default: n/a
flowLevelArming Defines a metering limit as being for a Values: 0 to 255 characters Optional
flow and allows you to provide a name Type: string
that identifies the metering limit as a
flow-level monitoring key. Default: n/a
(1 of 7)
meteringLimitType The type of metering limit defines the Values: Mandatory

metering limit classification. • BASIC
The options are: • UNLIMITED
• BASIC • VIRTUAL
Used to meter subscriber usage with • CONTROLLED_OVERAGE
a cap of the configured Quota.
• UNLIMITED Type: enum
Used to meter subscriber usage Default: n/a
• VIRTUAL
Used to generate notifications to the
subscriber produced from crossing
configured thresholds based on the
aggregated limits assigned to the
subscriber.
• CONTROLLED_OVERAGE
A limit that can be used to cap the
usage allowed after the applicable
limit has been reached.
When configuring a Controlled
Overage Limit, you cannot specify
the Quota Type, Overage Allowed,
Validity Period, and Rating
Information.
However, you can specify Reference
Overage Information, which is the
Overage Information Name
configured in the related BASIC or
UNLIMITED metering limit.

this metering limit opposed to other Type: integer
metering limits that may be assigned to
the subscriber (1=high; 15=low) Default: 0
quotaType Defines what type of usage has to be Values: Mandatory

metered. • DOWN_LINK
Specifies the direction of the usage to be • TOTAL
monitored or the type of unit to be
measured for the quota value.
• UP_LINK
• TIME
Valid options are:
• DOWN_LINK Type: enum
Usage monitored in the down link Default: n/a
direction.
• TOTAL
Value usage monitored in both
directions.
• UP_LINK
Usage monitored in the up link
direction.
• TIME
Usage as a function of time
monitored in both directions.
quota The maximum amount of a specified Values: Long values of up to a Mandatory

baseUnit allowed to the subscriber on maximum of 4503599627370495,
this metering limit, as configured in the or 252. You cannot enter 0 or a
quota type and reported by the network. negative value.
This only applies to the BASIC Type: double
meteringLimitType. Default: n/a
(2 of 7)
overageAllowed Determines if the metering limit can be Values: true or false Optional
used to assign a quota once the limit has Type: boolean
reached 100%.
Default: true
true
Allows overage
false
Disallows overage
baseUnit Defines the smallest block of usage that Values: Long values of up to a Optional
can be metered in the system. Any usage maximum of 4503599627370495,
lesser than this value may be rounded or 252. You cannot enter 0 or a
using rules specified in the System negative value.
Preferences Metering Limit Base Unit Type: double
Rounding Type.
Default: 1.0
minimumBaseUnit The minimum number of baseUnits Values: Long values of up to a Optional

blocks that are metered for a session. maximum of 4503599627370495,
or 252. You cannot enter 0 or a
negative value.
Type: integer
Default: 1
recurrence Defines the type of recurrence of the Values: Mandatory
metering limit. • DAILY (reset daily)
• WEEKLY (reset weekly)
• MONTHLY (on the billing day)
• NONE (never reset)
Type: enum
Default: n/a
validityPeriod For non-recurring or one time meter Values: Long values of up to a

limits, the duration for which the maximum of 4503599627370495,
metering limit is applicable. or 252. You cannot enter 0 or a
negative value.
Type: integer
Default: 1
carryOverExpiration Carry Over Expiration enables the quota Values: Optional
leftover from one metering limit to be • ONE_MONTH
used before the quota of the next
metering limit is applied. • TWO_MONTHS
When the carry-over quota is calculated

• THREE_MONTHS
for time-based metering, the time-based • SIX_MONTHS
usage between last usage report and the • TWELVE_MONTHS
reset is excluded. If there is existing • NEVER_EXPIRE
carryover quota, the time usage between • ONE_WEEK
the last usage report and the reset is not
added to the carryover quota that has • TWO_WEEKS
the closest expiry date. • THREE_WEEKS
• FOUR_WEEKS
• EIGHT_WEEKS
• TWELVE_WEEKS
• TWENTY_SIX_WEEKS
• FIFTY_TWO_WEEKS
Type: enum
Default: n/a
(3 of 7)
applicabilityConditions List of conditions in which the metering Values: empty list Optional
limit applies. If no conditions are listed, Type:
the metering limit always applies. tns:getMeteringLimitApplicability
See Table 4-4 for a description of the Conditions
applicability Conditions. Default: empty list
defaultActions Defines actions that are applied by Values: Contains Optional

default when the metering limit is meteringLimitThreshold, which
invoked. consists of a name,
See Table 4-5 for a description of the thresholdType, thresholdValue,
default actions. recurringThreshold,
thresholdConditions and actions
Type: set of actions
Default: empty list
(4 of 7)
thresholds The type of threshold defined in the Values: Contains Optional

metering limit. meteringLimitThreshold which
consists of a name,
thresholdType, thresholdValue,
recurringThreshold,
thresholdConditions and actions.
Type: Set of metering limit
thresholds
threshold — —
Defines threshold crossings and the
actions to be taken.

The name of the threshold. Type: string
Default: n/a
thresholdType Values: Mandatory

Defines the threshold type to configure. • PERCENTAGE
PERCENTAGE • VALUE
Any number entered is treated as a • RESET
percentage threshold. • PENALTY_CLEAR
VALUE
Type: string
Any number entered is treated as a
Default: n/a
volume threshold.
RESET
Resets the usage to zero (0). The Reset
type supports Send-Notification type
actions only.
PENALTY_CLEAR
Configures a metering limit that provides
threshold actions for notifications and
SPR record updates when a penalty is
cleared. The Penalty Clear type supports
Send-Notification type actions and SPR/
account actions only.
thresholdValue Values: Long values of up to a Mandatory
The value of the threshold defined. maximum of 4503599627370495,
negative value.
Type: string
Default: n/a
recurringThreshold Values: true or false Optional

Indicates if the threshold is to be Type: boolean
recurring. Default: false
thresholdConditions Default: empty list Optional

List of conditions under which threshold
actions are applied.
See Table 4-4 for a description of the
Threshold Conditions.
Actions Default: empty list Optional

List of session-level actions to be applied
when the applicable threshold is
reached.
Session Actions.
(5 of 7)
ratingInfos List of rating factors to be used under the Default:empty list Optional
specified conditions. If none are
specified, a rating factor is not applied.
ratinginfo Values: n/a —

Defines the rating information for Type: Object
managed or aggregate or controlled Default: none
overage rating.
rcfName Values: 1 to 80 characters Mandatory

Unique name for the rating information Type: string
entry. Default: n/a
rate Values: Double-precision 64-bit Optional

Provides a numerical value that is IEEE 754 floating point
multiplied within the raw counter usage Type: double
values from the network in order to rate Default: none
the usage data.
rateConditions — Optional
List of conditions under which the rating
factor is applied. If none are specified,
this rating factor is always used.
rateConditions
overageInfos overageInfo Values: 1 to 255 characters Optional

Overage information that can be used in Type: string
a metering limit when this metering limit Default: n/a
is in effect. This only applies to BASIC and
UNLIMITED metering limits. Multiple
overage information can be provisioned
within a metering limit.
oiName Values: 1 to 80 characters Optional

The name of the overage information. Type: string
Default: none

applied against the raw counter base Type: double
values from the network. The rate used Default: none
when a metering limit selects this
Overage Information to be used.
baseUnit Values: Long values of up to a Optional

Defines the smallest block of usage that maximum of 4503599627370495,
can be metered in the system. Any usage or 252. You cannot enter 0 or a
lesser than this value may be rounded negative value.
using rules specified in the System Type: double
Preferences Metering Limit Base Unit Default: 1.0
Rounding Type.
minUnit Values: 16-bit signed int value Optional

The minimum amount of overage Type: integer
baseUnits that are metered for a session. Default: none
The minUnit used when a metering limit
selects this Overage Information to be
used.
(6 of 7)
overageReferenceData Set of the reference data for the Values: Consists of a precedence, Optional
metering limit from which to retrieve type, key and a set of conditions
rating information in an overage Type: meteringLimitPullData
scenario. This only applies to a
Controlled Overage metering limit
(7 of 7)
Table 4-4 Condition field descriptions
criteria The criteria is made up of a source context and criteria attribute tns:Criteria
which represents the attribute that the 5780 DSC evaluates in the
specified source context.
See Appendix A, Context and criteria parameters in the 5780 DSC User
Guide for more information.
sourceContext tns:SourceContextType
Represents the source context in which the rule criteria are used.
• GX_MESSAGE
• GXX_MESSAGE
• RX_MESSAGE
• IPCAN_SESSION
• GWC_SESSION
• AF_SESSION
• NASREQ_SESSION
• SPR_SUBSCRIBER
• PREVIOUS_SPR_SUBSCRIBER
• SERVICE_INFORMATION
• NAS_CLUSTER
• NASREQ_MESSAGE
• SYSTEM
• DSC
• WNG_ALERT
• AUXILIARY_GX_SESSION
• MO_CACHE
• DATA_PROFILE
• GX_COMBIMNED_MSG_SESSION
• WNG_EVENTS
• ACCOUNT
• SY_SESSION

A Rule System Version to associate with the metering limit. Type: string
(1 of 3)
criteriaArguments argument tns:AttributeArgument

The values displayed depend on the criteria that you chose for the
Criteria parameter in a particular context based on:
• name
• value

A unique identifier for the criteria. Type: string
value —
• type
• value
type Values:
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
value —
The Value parameter defines how the value(s) are input for the
comparison or collection.
operator The operators are: tns:RelationalOperator

• EQUAL
• NOT_EQUAL
• GREATER_THAN
• LESS_THAN
• CONTAINS
• DOES_NOT_CONTAIN
• GREATER_THAN_OR_EQUAL
• LESS_THAN_OR_EQUAL
• PRESENT
• NOT_PRESENT
• CONTAINS_SUBSTRING
• DOES_NOT_CONTAIN_SUBSTRING
• WITHIN_NETMASK
• NOT_WITHIN_NETMASK
• CONTAINS_NETMASK
• DOES_NOT_CONTAIN_NETMASK
• MATCH_PATTERN
• DOES_NOT_MATCH_PATTERN
• CONTAINS_PATTERN_MATCH
• DOES_NOT_CONTAIN_PATTERN_MATCH
• MATCH_SUBSTRING
• DOES_NOT_MATCH_SUBSTRING
(2 of 3)
value Value available depends on the criteria that you have selected. The GenericValue
value type can be one of the following:
• STRING
• NUMBER
• DECIMAL
• ENUM
• IP_ADDRESS
• TIME_DURATION
• DATE_TIME
• TIME_OF_DAY
• MANAGED_OBJECT
• LIST
• ATTRIBUTE
• CHARGING_INFORMATION
• ARP
• SUBSCRIBER_QOS_OVERRIDE
• CUSTOM_DATA
valueArguments Set of arguments for the value. The value depends on the value you Values: Consists of a name
chose for the Value parameter. and a value.
• value Type: AttributeArgument
• type
adjustment Operator Only appears if the Condition value is an Attribute and the Attribute is Values:
a numeric, custom data value, or a list of Strings or IP Addresses tns:FormulaOperator
Valid values are: Type: string
• ADD
• SUBTRACT
• MULTIPLY
• UNION
• CONCATENATE
adjustmentValues Used to specify the amount of adjustment to apply to the Data. The tns:adjustmentValues
value can one of:
• ATTRIBUTE
• DECIMAL
• NUMBER
• TIME_DURATION
ConditionAdjustmentValue This parameter appears depending on the Type value that you chose tns:
for the Adjustment Value parameter. If you chose Attribute as the ConditionAdjustmentValue
Adjustment Value Type, more options for adjusting the data may
appear. Not all attributes have arguments so the adjustment
arguments section may not be needed.
(3 of 3)
Table 4-5 Action field descriptions
actionAttribute The action attribute consists of a result context and attribute name. —
Type: string
(1 of 4)
resultContext Displays the Result Context Types that are available. Values:
• DSC tns:ResultContextType
• GX_MESSAGE Type: string
• GXX_MESSAGE
• RX_MESSAGE
• IPCAN_SESSION
• GWC_SESSION
• AF_SESSION
• NASREQ_SESSION
• SPR_SUBSCRIBER
• NAS_CLUSTER
• NASREQ_MESSAGE (rules tables only)
• DEFAULTS
• METERING
• METERING_NOTIFICATION
• METERING_NOTIFICATION_DEFAULT
• METERING_SESSION
• METERING_SESSION_DEFAULT
• METERING_FLOW
• METERING_FLOW_DEFAULT
• NOTIFICATION_VARS
• NASREQ_METERING (metering limits only)
• NASREQ_METERING_SESSION
• MPS_SESSION
• WNG
• WNG_FLOW
• WNG_SESSION
• SPR_SUBSCRIBER_METERING
• SPR_SUBSCRIBER_WNG
• SPR_SUBSCRIBER_METERING_DEFAULT
• SPR_ACCOUNT
• SPR_ACCOUNT_METERING
• SPR_ACCOUNT_WNG
• SPR_ACCOUNT_METERING_DEFAULT
name The name of the action attribute. Values: 1 to 255

characters
Type: string
(2 of 4)
data The options that appear are dynamic based on the Action Attribute that Values: tns:GenericValue
was selected. Type: string
Exercise caution when entering custom attributes. Ensure that the type
is correct. If a non-numeric value is configured on an action
assignment, the value will not be assigned to the action. The values are
as follows:
• STRING
• NUMBER
• DECIMAL
• ENUM
• IP_ADDRESS
• TIME_DURATION
• DATE_TIME
• TIME_OF_DAY
• MANAGED_OBJECT
• LIST
• ATTRIBUTE
• ARP
• CUSTOM_DATA
dataArguments This parameter appears depending on the values that you chose for the Argument Name
Data Type parameter. The Argument name is displayed and you can Argument Value Type
configure the Argument value.
adjustmentOperator This parameter only appears if the selected Action Attribute is a Values:
numeric value and you selected the Attribute option for the Data Type. tns:FormulaOperator
You can use this parameter to adjust Data, for example adding or Type: string
decreasing a percentage of their bandwidth allocation, or adding or
decreasing their time allotment. The valid options are:
• ADD
• SUBTRACT
• MULTIPLY
• UNION
• CONCATENATE
adjustmentDataType This parameter appears when the Adjustment Operator parameter is Values: tns:GenericValue
configured. This parameter specifies the data type that is used when Type: string
calculating the adjustment for the Data. The adjustment data type
used here is dependant on you using the Data Type ‘Attribute’. That is,
you must have chosen Attribute as the Data Type.
Then you must choose another attribute, which causes the adjustment
operator field to appear where you can choose an adjustment
operator. Choose the Adjustment Data Type so that it aligns with the
attribute chosen. If the Data Type is:
• Number, the Adjustment Data Type can be Number or Attribute
• Decimal, the Adjustment Data Type can be Decimal, Number, or
Attribute
• Date Time, the Adjustment Data Type can be Time of Day, Time
Duration, or Attribute
adjustmentData Used to specify the amount of adjustment to apply to the Data Values: tns:GenericValue
Type: string
(3 of 4)
adjustmentDataArguments This parameter appears depending on the Type value that you chose for Values:
the Adjustment Data parameter. If you chose Attribute as the tns:AttributeArgument
Adjustment Data Type, more options for adjusting the data may Type: string
arguments section may not appear.
(4 of 4)
Response code
Code 4-6 shows the response code for the addMeteringLimits command.
Code 4-6: addMeteringLimits response code example

<env:Header/>
<env:Body>
<addMeteringLimitsResponse
m"
n"
>
</env:Body>
</env:Envelope>
4.5 cloneRuleSystemVersion
Creates a new rule system version with the data copied from the specified existing
rules system version.
Parameters
• existingName
The name of the rules system version to clone.
• cloneName
The name of the new rules system version.
Request code
Code 4-7 shows a request code example for the cloneRuleSystemVersion command.
Code 4-7: cloneRuleSystemVersion request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:cloneRuleSystemVersion>

<ns:existingName>Default</ns:existingName>

<ns:cloneName>clonedRSns</ns:cloneName>
</ns:cloneRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-6 lists the fields required for the cloneRuleSystemVersion command.
Table 4-6 cloneRuleSystemVersion field descriptions

existingName Name of the rule system name to clone; Values: 1 to 255 Optional
clone the active if not specified. characters
Type: string
Default: n/a
cloneName Name of the rule system name to create. Values: 1 to 255 Mandatory
characters
Type: string
Default: n/a
Response code
Code 4-8 shows the response code for the cloneRuleSystemVersion command.
Code 4-8: cloneRuleSystemVersion response code example

<env:Header/>
<env:Body>
<cloneRuleSystemVersionResponse
m"
"/>
</env:Body>
</env:Envelope>
4.6 exportRuleSystemVersion
Exports, in XML format, the entire rule system configuration from the 5780 DSC.
The entire rule system configuration is exported along with the notification
templates, custom data profiles, Provisioned/Predefined rules for charging and QoS,
associated 9900 WNG policies, and associated metering limits that were present in
the original version.
Parameter
• name
The name of the existing rules system version.
Request code
Code 4-9 shows a request code example for the exportRuleSystemVersion
command.
Code 4-9: exportRuleSystemVersion request code example

<soapenv:Envelope
n"
xmlns:rul="http://www.alcatellucent.com/dsc/provisioningapi/40/rules
ystem">
<soapenv:Header>
<com:header>
<com:clientAppId>test123</com:clientAppId>
<com:requestId>req123</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:exportRuleSystemVersion>

<rul:name>Default</rul:name>
</rul:exportRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-7 lists the fields required for the exportRuleSystemVersion command.
Table 4-7 exportRuleSystemVersion field descriptions
name Name of the existing rule system version. Values: 1 to 255 Mandatory
characters
Type: string
Default: n/a
Response code
Code 4-10 shows the response code for the exportRuleSystemVersion command.
Code 4-10: exportRuleSystemVersion response code example

<env:Header/>
<env:Body>
<exportRuleSystemVersionResponse
m"
n"
<exportData>{
"DSCVersion": "DSC51R4",
"RuleSets": [
{"name": "GATEWAY_SESSION_MODIFICATION"},
{
"name": "GATEWAY_SESSION_ESTABLISHMENT",
"action": [
{
"name": "DSC.Bearer-Control-Mode",
"value": "null"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.LOSS_OF_BEARER"
},
{
"value":
"EventTrigger.DEFAULT_EPS_BEARER_QOS_CHANGE"
},
{
"value": "EventTrigger.QOS_CHANGE"
},
{
"value": "EventTrigger.USER_LOCATION_CHANGE"
},
{
"value": "EventTrigger.RECOVERY_OF_BEARER"
},
{
"value": "EventTrigger.RAT_CHANGE"
}
]
},
{"name": "AUXGX_SESSION_MODIFICATION"},
{
"name": "NASREQ_SESSION_STOP",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "USAGE_RESET",
Variables"]
},
{
"name": "IPCAN_SESSION_TERMINATION",
Variables"]
},
{"name": "SPR_NOTIFICATION_DELETE"},
{
"name": "SPR_NOTIFICATION_UPDATE",
"RuleTablePrecedence": [
"Default Notification Variables",
"Reject-Disabled-Subscriber-SPR-Modification"
]
},
{
"name": "IPCAN_SESSION_MODIFICATION",
"action": [{
"name": "DSC.IPCanSessionModificationResult",
"value": "IPCanSessionModificationResult.REMOVE"
}],
Variables"]
},
{
"name": "AUXGX_SESSION_ESTABLISHMENT",
"action": [
{
},
{
"value": "EventTrigger.RAI_CHANGE"
},
{
}
]
},
{
"name": "DYNAMIC_RULE_CREATION",
"action": [
{
"name": "DSC.Rating-Group",
"value": "5"
},
{
"name": "DSC.Service-Identifier",
"value": "1"
},
{
"name": "DSC.Reporting-Level",
"value": "ReportingLevel.RATING_GROUP_LEVEL"
},
{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_5"
},
{
"name": "DSC.Metering-Method",
"value": "MeteringMethod.DURATION_VOLUME"
}
],
"Media-Type to QCI",
"PCC Rule default QCI",
"Reservation Priority to ARP Priority",
"Default Notification Variables"
]
},
{
"name": "AF_SESSION_TERMINATION",
Variables"]
},
{"name": "GATEWAY_SESSION_TERMINATION"},
{
"name": "NASREQ_SESSION_CREATION",
"Reject-Disabled-Subscriber-NAS-Creation"
]
},
{
"name": "NASREQ_SESSION_START",
Variables"]
},
{
"name": "IPCAN_SESSION_ESTABLISHMENT",
"action": [
{
},
{
"name": "DSC.Online",
"value": "null"
},
{
"name": "DSC.Offline",
"value": "null"
},
{
"name": "DSC.Charging\/QoS-Rule-Definition",
"value": "null"
},
{
},
{
},
{
"name": "DSC.Charging-Information",
"value": "null"
},
{
"value": "EventTrigger.IP_CAN_CHANGE"
},
{
"value": "null"
},
{
}
],
"Reject-Disabled-Subscriber-IP-CAN-Establishment"
]
},
{
"name": "AF_SESSION_MODIFICATION",
Variables"]
},
{"name": "AUXGX_SESSION_TERMINATION"},
{
"name": "AF_SESSION_ESTABLISHMENT",
Variables"]
},
{
"name": "QOS_MANAGEMENT",
"action": [
{
"name": "DSC.Default-Bandwidth-UL",
"value": "0"
},
{
"name": "DSC.QoS-Negotiation-MBR-Result",
"value":
"BitRateCheckResult.AUTHORIZE_AT_LOWER_RATE"
},
{
"name": "DSC.QoS-Negotiation-GBR-Result",
"value":
},
{
"name": "DSC.Default-Bearer-QCI",
"value": "null"
},
{
"name": "DSC.QoS-Upgrade-MBR-Result",
"value":
"QosUpgradeCheckResult.AUTHORIZE_AT_HIGHER_RATE"
},
{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "null"
},
{
"name":
"DSC.Allocation-Retention-Priority.Pre-emption-Capability",
"value": "null"
},
{
"name":
"DSC.Allocation-Retention-Priority.Pre-emption-Vulnerability",
"value": "null"
},
{
"name": "DSC.Default-Bandwidth-DL",
"value": "0"
},
{
"name": "DSC.QoS-Upgrade-GBR-Result",
"value":
}
],
Variables"]
},
{
"name": "NASREQ_DYNAMIC_AUTHORIZATION",
Variables"]
},
{
"name": "NASREQ_AUX_DYNAMIC_AUTHORIZATION",
"RuleTablePrecedence": ["Auxiliary Request Type"]
}
],
"RuleTables": [
{
"name": "Reject-Disabled-Subscriber-SPR-Modification",
"rules": [{
"name": "Reject Disabled Subscriber",
"precedence": 1,
"enabled": true,
"condition": "(SPR_SUBSCRIBER.Subscriber-State ==
SubscriberState.DISABLED) AND (DSC.Emergency-APNs DOES NOT CONTAIN
IPCAN_SESSION.Called-Station-ID)",
"actions": [{
"name": "DSC.Session-Command",
"value": "SessionCommandType.TERMINATE"
}]
}]
},
{
"name": "Reject-Disabled-Subscriber-NAS-Creation",
"rules": [{
"precedence": 1,
"enabled": true,
SubscriberState.DISABLED)",
"actions": [{
}]
}]
},
{
"name":
"Reject-Disabled-Subscriber-IP-CAN-Establishment",
"rules": [{
"precedence": 1,
"enabled": true,
"condition": "(DSC.Emergency-APNs DOES NOT CONTAIN
GX.Called-Station-ID) AND (SPR_SUBSCRIBER.Subscriber-State ==
"actions": [{
}]
}]
},
{
"name": "Auxiliary Request Type",
"rules": [
{
"name": "Accounting Stop",
"precedence": 2,
"enabled": true,
"condition": "(NASREQ_MESSAGE.NAS-Message-Type
== NASReqMessageType.ACCOUNTING_STOP)",
"actions": [{
"name": "DSC.Auxiliary-Request-Type",
"value": "AuxiliaryRequestType.DISCONNECT"
}]
},
{
"name": "Accounting Start",
"precedence": 1,
"enabled": true,
== NASReqMessageType.ACCOUNTING_START)",
"actions": [{
"value": "AuxiliaryRequestType.COA"
}]
}
]
},
{
"name": "PCC Rule default QCI",
"rules": [{
"name": "getPccRuleQCI",
"precedence": 1,
"enabled": true,
"condition":
"(SERVICE_DATA.QoS-Information.QoS-Class-Identifier IS PRESENT )",
"actions": [{
"value":
"SERVICE_DATA.QoS-Information.QoS-Class-Identifier"
}]
}]
},
{
"name": "Default Notification Variables",
"rules": [{
"name": "Values",
"precedence": 0,
"enabled": true,
"condition": "true",
"actions": [
{
"name":
"NOTIFICATION_VARS.Subscriber-User-Id",
"value": "SPR_SUBSCRIBER.Subscriber-User-Id"
},
{
"name":
"NOTIFICATION_VARS.Current-Date-Time-String",
"value": "SYSTEM.Current-Date-Time-String"
},
{
"name":
"NOTIFICATION_VARS.Subscriber-Mobile-Number",
"value":
"SPR_SUBSCRIBER.Notification-Config.Mobile-Number"
}
]
}]
},
{
"name": "Media-Type to QCI",
"rules": [
{
"name": "Video To QCI 2",
"precedence": 8,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.VIDEO)",
"actions": [{
}]
},
{
"name": "Text To QCI 6",
"precedence": 7,
"enabled": true,
"condition":
MediaType.TEXT)",
"actions": [{
}]
},
{
"name": "Other To QCI 9",
"precedence": 6,
"enabled": true,
"condition":
MediaType.OTHER)",
"actions": [{
}]
},
{
"name": "Message To QCI 9",
"precedence": 5,
"enabled": true,
"condition":
MediaType.MESSAGE)",
"actions": [{
}]
},
{
"name": "Data To QCI 8",
"precedence": 4,
"enabled": true,
"condition":
MediaType.DATA)",
"actions": [{
}]
},
{
"name": "Control To QCI 6",
"precedence": 3,
"enabled": true,
"condition":
MediaType.CONTROL)",
"actions": [{
}]
},
{
"name": "Audio To QCI 1",
"precedence": 2,
"enabled": true,
"condition":
MediaType.AUDIO)",
"actions": [{
}]
},
{
"name": "Application To QCI 2",
"precedence": 1,
"enabled": true,
"condition":
MediaType.APPLICATION)",
"actions": [{
}]
}
]
},
{
"name": "Reservation Priority to ARP Priority",
"rules": [
{
"name": "Zero",
"precedence": 8,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.DEFAULT)",
"actions": [{
"name":
"value": "15"
}]
},
{
"name": "Seven",
"precedence": 7,
"enabled": true,
"condition":
ReservationPriority.PRIORITY7)",
"actions": [{
"name":
"value": "2"
}]
},
{
"name": "Six",
"precedence": 6,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "4"
}]
},
{
"name": "Five",
"precedence": 5,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "6"
}]
},
{
"name": "Four",
"precedence": 4,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "8"
}]
},
{
"name": "Three",
"precedence": 3,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "10"
}]
},
{
"name": "Two",
"precedence": 2,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "12"
}]
},
{
"name": "One",
"precedence": 1,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "14"
}]
}
]
}
]
}</exportData>
</exportRuleSystemVersionResponse>
</env:Body>
</env:Envelope>
4.7 getActiveRuleSystemVersionName
Gets the active rule system version by the name specified.
Parameter
• versionedObjectId
Identifies a custom data profile by name and rule system version name.
Request code
Code 4-11 shows a request code example for the getActiveRuleSystemVersionName
command.
Code 4-11: getActiveRuleSystemVersionName request code example

<soapenv:Envelope
ystem">
<soapenv:Header/>
<soapenv:Body>
<rul:getActiveRuleSystemVersionName/>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-8 lists the fields required for the getActiveRuleSystemVersionName
command.
Table 4-8 getActiveRuleSystemVersionName field descriptions
versionedObjectId The ID of the custom data profile. — —

The name of a custom data profile Type: string
object. Default: n/a

defined.
result in an error.
Response code
Code 4-12 shows the response code for the getActiveRuleSystemVersionName
command.
Code 4-12: getActiveRuleSystemVersionName response code example

<env:Header/>
<env:Body>
<getActiveRuleSystemVersionNameResponse
m"
n"
<activeRuleSystemVersion>Default</activeRuleSystemVersion>
</getActiveRuleSystemVersionNameResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-9 lists the fields for the getActiveRuleSystemVersionName command.
Table 4-9 getActiveRuleSystemVersionName response field descriptions
activeRuleSystemVersion name Values: 1 to 80 characters

The name of the metering limit to be activated. Type: string
4.8 getCustomDataProfile
Gets a fully populated custom data profile object identified by the name specified.
Parameter
Request code
Code 4-13 shows a request code example for the getCustomDataProfile command.
Code 4-13: getCustomDataProfile request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getCustomDataProfile>

<ns:ruleSystemVersionName>ns</ns:ruleSystemVersionName>
</ns:getCustomDataProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-10 lists the fields required for the getCustomDataProfile command.
Table 4-10 getCustomDataProfile field descriptions

The name of a custom data profile Type: string
object. Default: n/a

defined.
result in an error.
Response code
Code 4-14 shows the response code for the getCustomDataProfile command.
Code 4-14: getCustomDataProfile response code example

<env:Header/>
<env:Body>
<getCustomDataProfileResponse
m"
">
<customDataProfile>
<versionedObjectId>
<name>gold_usage</name>
<ruleSystemVersionName>ns</ruleSystemVersionName>
<description>c2</description>
<customData>
<item>
<name>RSV1</name>
<value>
<value>999.999</value>
</value>
</item>
</customData>
</customDataProfile>
</getCustomDataProfileResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-11 lists the fields for the getCustomDataProfile command.
Table 4-11 getCustomDataProfile response field descriptions
versionedObjectId The ID of the metering limit for which the rule —

will be updated.

The name of the metering limit to be added. Type: string
ruleSystemVersionName Values: 1 to 80 characters

The name of the rule system version in which the Type: string
metering limit is defined.
Note: A null value for the RSV name will result in
an error.
description A description to provide more information about Values: 0 to 255 characters
the metering limit. Type: string
priority A number that states the precedence of this Values:1 to 15

custom data profiles opposed to other custom Type: integer
data profiles that may be assigned to the
subscriber (1=high; 15=low)
customData Defines a list of zero or more custom data —

entries (item).
item —
Defines the custom data used for a single custom
data entry based on:
• name
• value

value —
• type
• value
type Values:
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData value Values: Dependant on the Type

(continued) Contains the data for the custom data item selected.
value. Type: string
STRING
Contains a text string of the exact value that you
require for the action.
IP_ADDRESS
Values: For a list of the supported formats, see
the chapter “Configuring and managing
subscribers in the SPR” in the 5780 DSC User
Guide.
LIST
• STRING
• IP_ADDRESS
Values: The encoded value must be under 256

000 characters.
ENUM
Enumeration types are pre-defined in the system
and are available depending on the Criteria
attribute that you chose.
NUMBER
Values: Any whole number between -(263) and
263 - 1
DECIMAL
Values: Any number that contains a decimal, for
example: 1.0456.
(2 of 2)
4.9 getCustomDataProfile_CustomData
Gets the complete set of custom data entries from the specified custom data profile
object. The custom data profile object is identified by name and rule system version
name.
Parameter
Request code
getCustomDataProfile_CustomData command.
Code 4-15: getCustomDataProfile_CustomData request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getCustomDataProfile_CustomData>

</ns:getCustomDataProfile_CustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-12 lists the fields required for the getCustomDataProfile_CustomData
command.
Table 4-12 versionedObjectId field descriptions

added. Default: n/a

defined.
result in an error.
Response code
Code 4-16 shows the response code for the getCustomDataProfile_CustomData
command.
Code 4-16: getCustomDataProfile_CustomData response code example

<env:Header/>
<env:Body>
<getCustomDataProfile_CustomDataResponse
m"
">
<customData>
<name>CDP1</name>
<value>
<value>999.999</value>
</value>
</customData>
</getCustomDataProfile_CustomDataResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-13 lists the fields for the getCustomDataProfile command.
Table 4-13 getCustomDataProfile response field descriptions
customData Defines the custom data used for a single custom —

• name
• value

value —
• type
• data
type Values:
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData value Values: Dependant on the Type

(continued) Contains the data for the custom data item selected.
value. Type: string
STRING
Contains a text string of the exact value that you
require for the action.
IP_ADDRESS
the chapter “Configuring and managing
subscribers in the SPR” in the 5780 DSC User
Guide.
LIST
• STRING
• IP_ADDRESS
Values: The encoded value must be under 256

000 characters.
ENUM
NUMBER
Values: Any whole number between -(263) and
263 - 1
DECIMAL
example: 1.0456.
(2 of 2)
4.10 getCustomDataProfilePriority
Gets the priority from the custom data profiles object identified by name and rule
system version name.
Parameter
Request code
Code 4-17 shows a request code example for the getCustomDataProfilePriority
command.
Code 4-17: getCustomDataProfilePriority request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getCustomDataProfilePriority>

</ns:getCustomDataProfilePriority>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-14 lists the fields for the getCustomDataProfilePriority command.

added. Default: n/a

defined.
result in an error.
Response code
Code 4-18 shows the response code for the getCustomDataProfilePriority command.
Code 4-18: getCustomDataProfilePriority response code example

<env:Header/>
<env:Body>
<getCustomDataProfilePriorityResponse
m"
">
</getCustomDataProfilePriorityResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-15 lists the fields for the getCustomDataProfilePriority command.
Table 4-15 getCustomDataProfilePriority field descriptions
priority A number that states the precedence of this custom Values:1 to 15

data profiles opposed to other custom data profiles Type: integer
that may be assigned to the subscriber (1=high;
15=low).
4.11 getMeteringLimit
Returns a fully populated metering limit object from the specified rule system
version.
Parameter
Identifies the metering limit to be fetched specified by name and rule system
version name.
Request code
Code 4-19 shows a request code example for the getMeteringLimit command.
Code 4-19: getMeteringLimit request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:getMeteringLimit>

<rul:versionedObjectId>
<rul:name>ml1</rul:name>
<rul:ruleSystemVersionName>clone</rul:ruleSystemVersionN
ame>
</rul:versionedObjectId>
</rul:getMeteringLimit>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-16 lists the fields required for the getMeteringLimit command.

name The name of the metering limit to be fetched. Values: 1 to 80 characters Mandatory
Type: string
Default: n/a
ruleSystemVersionName The name of the rule system version in which the Values: 1 to 80 characters Mandatory
metering limit is defined. Type: string
Note: A null value for the RSV name will result in Default: n/a
an error.
Response code
Code 4-20 shows the response code for the getMeteringLimit command.
Code 4-20: getMeteringLimit response code example

<env:Header/>
<env:Body>
<getMeteringLimitResponse
m"
n"
<meteringLimit>
<versionedObjectId>
<name>ml1</name>
<ruleSystemVersionName>clone</ruleSystemVersionName>
<quota>1000.0</quota>
<carryOverExpiration>ONE_MONTH</carryOverExpiration>
<applicabilityConditions/>
<defaultActions/>
<thresholds>
<threshold>
<name>th80</name>
<thresholdType>PERCENTAGE</thresholdType>
<thresholdValue>80</thresholdValue>
<recurringThreshold>false</recurringThreshold>
<thresholdConditions/>
<actions/>
</threshold>
</thresholds>
<ratingInfos/>
<overageInfos/>
<overageReferenceData/>
</meteringLimit>
</getMeteringLimitResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-17 lists the fields for the getMeteringLimit command.
Table 4-17 getMeteringLimit response field descriptions

versionedObjectId The ID of the metering limit to be fetched. —

The name of the metering limit to be fetched. Type: string

The name of the rule system version in which Type: string
the metering limit is defined.
Note: A null value for the RSV name will result
in an error.
sessionMonitoringKey Defines a metering limit as being for a session Values: 0 to 255 characters
and allows you to provide a name that Type: string
identifies the metering limit as a session-level
monitoring key.
(1 of 5)
meteringLimitType The type of metering limit defines the Values:

Used to meter subscriber usage with a cap • CONTROLLED_OVERAGE
of the configured Quota
Used to meter subscriber usage
• VIRTUAL
aggregated limits assigned to the
subscriber.
A limit that can be used to cap the usage
allowed after the applicable limit has
been reached.
When configuring a Controlled Overage
Limit, you cannot specify the Quota Type,
Overage Allowed, Validity Period, and
Rating Information.
Overage Information, which is the Overage
Information Name configured in the
related BASIC or UNLIMITED metering
limit.

quotaType Defines what type of usage has to be metered. Values:

Specifies the direction of the usage to be • DOWN_LINK
monitored or the type of unit to be measured • TOTAL
for the quota value.
• UP_LINK
Valid options are: • TIME
• DOWN_LINK
Usage monitored in the down link Type: enum
direction.
• TOTAL
• UP_LINK
• TIME
Usage as a function of time monitored in
both directions.
quota The maximum amount of a specified baseUnit Values: Long values of up to a

allowed to the subscriber on this metering maximum of 4503599627370495,
limit, as configured in the quota type and or 252. You cannot enter 0 or a
reported by the network. negative value.
meteringLimitType.
(2 of 5)
overageAllowed Determines if the metering limit can be used Values: true or false
to assign a quota once the limit has reached Type: boolean
100%.
true
Allows overage.
false
Disallows overage.
baseUnit Defines the smallest block of usage that can be Values: Long values of up to a
metered in the system. Any usage lesser than maximum of 4503599627370495,
this value may be rounded using rules or 252. You cannot enter 0 or a
specified in the System Preferences Metering negative value.
Limit Base Unit Rounding Type. Type: double
minimumBaseUnit The minimum number of baseUnits blocks that Values: Long values of up to a
are metered for a session. maximum of 4503599627370495,
negative value.
Type: integer
recurrence Defines the type of recurrence of the metering Valid values:

limit. • DAILY (reset daily)
Type: enum
carryOverExpiration Carry Over Expiration enables the quota Values:

leftover from one metering limit to be used • ONE_MONTH
before the quota of the next metering limit is
applied.
• TWO_MONTHS
When the carry-over quota is calculated for

• THREE_MONTHS
time-based metering, the time-based usage • SIX_MONTHS
between last usage report and the reset is • TWELVE_MONTHS
excluded. If there is existing carryover quota, • NEVER_EXPIRE
the time usage between the last usage report • ONE_WEEK
and the reset is not added to the carryover
quota that has the closest expiry date.
• TWO_WEEKS
• THREE_WEEKS
• FOUR_WEEKS
• EIGHT_WEEKS
• TWELVE_WEEKS
• FIFTY_TWO_WEEKS
Type: enum
validityPeriod For non-recurring or one time meter limits, Values: Long values of up to a
the duration for which the metering limit is maximum of 4503599627370495,
applicable. or 252. You cannot enter 0 or a
negative value.
Type: integer
applicabilityConditions List of conditions in which the metering limit Values: empty list
applies. If no conditions are listed, the Type:
metering limit always applies. tns:getMeteringLimitApplicability
applicability Conditions.
(3 of 5)
thresholds The type of threshold defined in the metering Values: Contains

limit. meteringLimitThreshold which
consists of a name,
recurringThreshold,
thresholds
threshold —
Defines threshold crossings and the actions to
be taken.

thresholdType Values:
Any number entered is treated as a percentage • RESET
threshold. • PENALTY_CLEAR
VALUE
Type: string
Any number entered is treated as a volume
threshold.
RESET
Resets the usage to zero (0). The Reset type
supports Send-Notification type actions only.
PENALTY_CLEAR
threshold actions for notifications and SPR
record updates when a penalty is cleared. The
Penalty Clear type supports Send-Notification
type actions and SPR/ account actions only.
thresholdValue Values: Long values of up to a
negative value.
Type: string
recurringThreshold Values: true or false

Indicates if the threshold is to be recurring. Type: boolean
thresholdConditions —
Actions —
List of session-level actions to be applied when
the applicable threshold is reached.
See Table 4-5 for a description of the Session
Actions.
(4 of 5)
ratingInfos Rating information to be used under the —

specified conditions. If none are specified, a
rating factor is not applied.
Multiple rating informations entries can be
provisioned within a metering limit.
ratinginfo Values: n/a

Defines the rating information for managed or Type: Object
aggregate or controlled overage rating.
rcfName Values: 1 to 80 characters

Unique name for the rating information entry. Type: string
rate Values: Double-precision 64-bit

Provides a numerical value that is multiplied IEEE 754 floating point
within the raw counter usage values from the Type: double
network in order to rate the usage data.
overageinfo Overage information that can be used in a Values: 1 to 255 characters

metering limit when this metering limit is in Type: string
effect. This only applies to BASIC and
UNLIMITED metering limits. Multiple overage
information can be provisioned within a
metering limit.
oiName Values: 1 to 80 characters


Provides a numerical value that is applied IEEE 754 floating point
against the raw counter base values from the Type: double
network. The rate used when a metering limit
selects this Overage Information to be used.
baseUnit Values: Long values of up to a
Defines the smallest block of usage that can be maximum of 4503599627370495,
metered in the system. Any usage lesser than or 252. You cannot enter 0 or a
this value may be rounded using rules negative value.
specified in the System Preferences Metering Type: double
Limit Base Unit Rounding Type.
minUnit Values: 16-bit signed int value

The minimum amount of overage baseUnits Type: integer
that are metered for a session. The minUnit
used when a metering limit selects this
overageReferenceData Set of the reference data for the metering Values: Consists of a precedence,
limit from which to retrieve rating information type, key and a set of conditions
in an overage scenario. This only applies to a Type: meteringLimitPullData
(5 of 5)
4.12 getMeteringLimitApplicabilityConditions
Returns the complete set of applicability conditions for the metering limit object.
Parameter
version name.
Request code
getMeteringLimitApplicabilityConditions command.
Code 4-21: getMeteringLimitApplicabilityConditions request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:getMeteringLimitApplicabilityConditions>

<rul:name>NeverExpired_ML2</rul:name>
<rul:ruleSystemVersionName>defaultClone</rul:ruleSystemV
ersionName>
</rul:getMeteringLimitApplicabilityConditions>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-18 lists the fields required for the getMeteringLimitApplicabilityConditions
command.
name The name of the metering limit to get. Values: 1 to 80 characters Mandatory
Type: string
ruleSystemVersionName The name of the rule system version in Values: 1 to 80 characters Mandatory
which the metering limit is defined. Type: string
result in an error.
Response code
getMeteringLimitApplicabilityConditions command.
Code 4-22: getMeteringLimitApplicabilityConditions response code example

<env:Header/>
<env:Body>
<getMeteringLimitApplicabilityConditionsResponse
m"
n"
<condition>
<criteria>
<name>Reset-Day-Of-Month</name>
</criteria>
<value>
<type>NUMBER</type>
<value>15</value>
</value>
<valueArguments/>
<adjustmentValues>
<value>
<value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
</getMeteringLimitApplicabilityConditionsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-19 lists the fields for the getMeteringLimitApplicabilityConditions
command.
Table 4-19 condition response field descriptions
criteria The criteria is made up of a source —

context and criteria attribute which
represents the attribute that the
5780 DSC evaluates in the specified
source context.
See Appendix A, Context and criteria
parameters in the 5780 DSC User
Guide for more information.
sourceContext Values: 1 to 80 characters

A unique name for the metering Type: string
limit.

A Rule System Version to associate Type: string
with the metering limit.
criteriaArguments argument Values: n/a

The values displayed depend on the Type: tns:AttributeArgument
criteria that you chose for the
Criteria parameter in a particular
context.
operator The filter operator. Values:

The operators are:
• EQUAL
• NOT_EQUAL
• GREATER_THAN
• LESS_THAN
• CONTAINS
• PRESENT
• NOT_PRESENT
• WITHIN_NETMASK
• MATCH_PATTERN
• MATCH_SUBSTRING
Type: tns:RelationalOperator
(1 of 2)
value The value available depends on the Values: The value type can be one of the
criteria that you have selected. following:
• STRING
• NUMBER
• DECIMAL
• ENUM
• IP_ADDRESS
• TIME_DURATION
• DATE_TIME
• TIME_OF_DAY
• MANAGED_OBJECT
• LIST
• ATTRIBUTE
• ARP
• CUSTOM_DATA
Type: GenericValue
valueArguments Set of arguments for the value. The Values: Consists of a name and a value
value depends on the value you chose Type: AttributeArgument
for the Value parameter.
• value
• type
adjustmentOperator This parameter only appears if the Values: The valid options are:
selected Action Attribute is a • ADD
numeric value and you selected the
Attribute option for the Data Type. • SUBTRACT
You can use this parameter to adjust • MULTIPLY
Data, for example adding or • UNION
decreasing a percentage of their • CONCATENATE
bandwidth allocation, or adding or
decreasing their time allotment. Type: string
adjustmentValues Used to specify the amount of Values: The value can one of:
adjustment to apply to the Data. • ATTRIBUTE
• DECIMAL
• NUMBER
• TIME DURATION
Type: tns:adjustmentValues
(2 of 2)
4.13 getMeteringLimitDefaultActions
Returns the complete set of default actions for the metering limit object.
Parameter
version name.
Request code
Code 4-23 shows a request code example for the getMeteringLimitDefaultActions
command.
Code 4-23: getMeteringLimitDefaultActions request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:getMeteringLimitDefaultActions>

<rul:name>ML2</rul:name>
ersionName>
</rul:getMeteringLimitDefaultActions>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-20 lists the fields required for the getMeteringDefaultActions command.
Type: string
result in an error.
Response code
Code 4-24 shows the response code for the getMeteringLimitDefaultActions
command.
Code 4-24: getMeteringLimitDefaultActions response code example

<env:Header/>
<env:Body>
<getMeteringLimitDefaultActionsResponse
m"
n"
<condition>
<actionAttribute>
<resultContext>METERING_FLOW_DEFAULT</resultContext>
<name>Allocation-Retention-Priority.Priority-Level</n
ame>
</actionAttribute>
<data>
<type>NUMBER</type>
<value>3</value>
</data>
<dataArguments/>
<adjustmentData>
<type>NUMBER</type>
<value>4</value>
</adjustmentData>
<adjustmentDataArguments/>
</condition>
</getMeteringLimitDefaultActionsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-21 lists the fields for the getMeteringLimitDefaultActions command.
Type: string
resultContext Values:
Displays the Result Context Types that are available. tns:ResultContextType
• DSC Type: string
• GX_MESSAGE
• GXX_MESSAGE
• RX_MESSAGE
• IPCAN_SESSION
• GWC_SESSION
• AF_SESSION
• NASREQ_SESSION
• SPR_SUBSCRIBER
• NAS_CLUSTER
• DEFAULTS
• METERING
• METERING_FLOW
• MPS_SESSION
• WNG
• WNG_FLOW
• WNG_SESSION
• SPR_ACCOUNT
• SPR_ACCOUNT_WNG
name Values: 1 to 255

A Rule System Version to associate with the metering limit. characters
Type: string
(1 of 3)
as follows:
• STRING
• NUMBER
• DECIMAL
• ENUM
• IP_ADDRESS
• TIME_DURATION
• DATE_TIME
• TIME_OF_DAY
• MANAGED_OBJECT
• LIST
• ATTRIBUTE
• ARP
• CUSTOM_DATA
dataArguments This parameter appears depending on the values that you chose for the Argument Name
Data Type parameter. The Argument name is displayed and you can Argument Value Type
configure the Argument value.
• ADD
• SUBTRACT
• MULTIPLY
• UNION
• CONCATENATE
Type: string
Type and Value Values: tns:GenericValue

This parameter appears when the Adjustment Operator parameter is Type: string
configured. This parameter specifies the data type that is used when
Attribute
(2 of 3)
adjustmentDataArguments This parameter appears depending on the Type value that you chose for Values:
the Adjustment Data parameter. If you chose Attribute as the tns:AttributeArgument
Adjustment Data Type, more options for adjusting the data may Type: string
arguments section may not appear.
(3 of 3)
4.14 getMeteringLimitNames
Returns the names of metering limits for a specific rule system version.
Parameter
• ruleSystemVersionName
The name of the rule system version in which the metering limit is defined.
Request code
Code 4-25 shows a request code example for the getMeteringLimitNames command.
Code 4-25: getMeteringLimitNames request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
<com:clientAppId>?</com:clientAppId>
<com:requestId>?</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:getMeteringLimitNames>

<rul:ruleSystemVersionName>clone</rul:ruleSystemVersionName
>
</rul:getMeteringLimitNames>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-22 lists the fields required for the getMeteringLimitNames command.
an error.
Response code
Code 4-26 shows the response code for the getMeteringLimitNames command.
Code 4-26: getMeteringLimitNames response code example

<env:Header/>
<env:Body>
<getMeteringLimitNamesResponse
m"
n"
<meteringLimitName>ml2</meteringLimitName>
<meteringLimitName>ml</meteringLimitName>
</getMeteringLimitNamesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-23 lists the fields for the getMeteringLimitNames command.
Table 4-23 getMeteringLimits response field descriptions
meteringLimitName name Values: 1 to 80 characters

4.15 getMeteringLimitPriority
Returns the priority of the metering limit.
Parameter
version name.
Request code
Code 4-27 shows a request code example for the getMeteringLimitPriority
command.
Code 4-27: getMeteringLimitPriority request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getMeteringLimitPriority>

<ns:name>ML1</ns:name>
</ns:getMeteringLimitPriority>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-24 lists the fields required for the getMeteringLimitPriority command.
Type: string
Default: n/a
Note: A null value for the RSV name Default: n/a
will result in an error.
Response code
Code 4-28 shows the response code for the getMeteringLimitPriority command.
Code 4-28: getMeteringLimitPriority response code example

<env:Header/>
<env:Body>
<getMeteringLimitPriorityResponse
m"
">

</getMeteringLimitPriorityResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-25 lists the fields for the getMeteringLimitPriority command.
Table 4-25 getMeteringLimitPriority response field descriptions

priority A number that states the precedence of this custom data profiles Values:1 to 15
opposed to other custom data profiles that may be assigned to the Type: integer
subscriber (1=high; 15=low).
4.16 getMeteringLimitQuota
Returns the quota for the metering limit object.
Parameter
version name.
Request code
Code 4-29 shows a request code example for the getMeteringLimitQuota command.
Code 4-29: getMeteringLimitQuota request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getMeteringLimitQuota>

</ns:getMeteringLimitQuota>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-26 lists the fields required for the getMeteringLimitQuota command.
Type: string
Default: n/a
Note: A null value for the RSV name will Default: n/a
result in an error.
Response code
Code 4-30 shows the response code for the getMeteringLimitQuota command.
Code 4-30: getMeteringLimitQuota response code example

<env:Header/>
<env:Body>
<getMeteringLimitQuotaResponse
m"
">

<quota>4.0</quota>
</getMeteringLimitQuotaResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-27 lists the fields for the getMeteringLimitQuota command.
Table 4-27 getMeteringLimitQuota response field descriptions
quota The maximum amount of a specified baseUnit Values: Double data type is
allowed to the subscriber on this metering limit, as a double-precision 64-bit
configured in the quota type and reported by the IEEE 754 floating point.
network. Type: double
This only applies to the BASIC meteringLimitType.
4.17 getMeteringLimits
Returns all the metering limits for the active rule system version.
Parameter
version name.
Request code
Code 4-31 shows a request code example for the getMeteringLimits command.
Code 4-31: getMeteringLimits request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:getMeteringLimits>

<rul:ruleSystemVersionName>clone1</rul:ruleSystemVersionNam
e>
</rul:getMeteringLimits>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-28 lists the fields required for the getMeteringLimits command.
an error.
Response code
Code 4-32 shows the response code for the getMeteringLimits command.
Code 4-32: getMeteringLimits response code example

<env:Header/>
<env:Body>
<getMeteringLimitsResponse
m"
n"
<meteringLimit>
<versionedObjectId>
<name>ml1</name>
<quota>1000.0</quota>
<carryOverExpiration>ONE_MONTH</carryOverExpiration>
<applicabilityConditions/>
<defaultActions/>
<thresholds>
<threshold>
<name>th80</name>
<thresholdType>PERCENTAGE</thresholdType>
<thresholdValue>80</thresholdValue>
<recurringThreshold>false</recurringThreshold>
<thresholdConditions/>
<actions/>
</threshold>
</thresholds>
<ratingInfos/>
<overageInfos/>
</meteringLimit>
<meteringLimit>
<versionedObjectId>
<name>mlnew</name>
<description>Roaming_7_6_N</description>
<flowLevelArming>VFBIL_flowKey</flowLevelArming>
<carryOverExpiration>TWO_MONTHS</carryOverExpiration>
<condition>
<criteria>
<sourceContext>WNG_ALERT</sourceContext>
<name>Congestion-Intensity</name>
</criteria>
<value>
<type>NUMBER</type>
<value>9999</value>
</value>
<valueArguments/>
<adjustmentValues>
<value>
<value>
<value>99</value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
<condition>
<criteria>
<sourceContext>WNG_EVENTS</sourceContext>
<name>WNG-Event.Severity</name>
</criteria>
<criteriaArguments>
<argument>
<name>Event-Type</name>
<value>
<type>ENUM</type>
<value>WNGEventType.BATTERYATTACK_DISTRIB
UTED</value>
</value>
</argument>
</criteriaArguments>
<operator>EQUAL</operator>
<value>
<type>ENUM</type>
<value>WNGEventSeverity.CRITICAL_CLEARED</value
>
</value>
<valueArguments/>
<adjustmentValues/>
</condition>
<defaultActions>
<action>
<actionAttribute>
<resultContext>METERING_FLOW_DEFAULT</resultCon
text>
<name>Penalty-Period</name>
</actionAttribute>
<data>
<type>NUMBER</type>
<value>12</value>
</data>
<dataArguments/>
<actionAdjustmentValues/>
</action>
</defaultActions>
<thresholds/>
<ratingInfos/>
<overageInfos/>
</meteringLimit>
<meteringLimit>
<versionedObjectId>
<name>NeverExpired_ML2</name>
<description>Never_Expired_ML2</description>
<flowLevelArming>ML_flowKey</flowLevelArming>
<quotaType>TIME</quotaType>
<overageAllowed>true</overageAllowed>
<recurrence>WEEKLY</recurrence>
<carryOverExpiration>NEVER_EXPIRE</carryOverExpiration>
<condition>
<criteria>
<name>Account-Billing-Day</name>
</criteria>
<value>
<type>NUMBER</type>
<value>15</value>
</value>
<valueArguments/>
<adjustmentValues>
<value>
<value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
<defaultActions>
<action>
<actionAttribute>
<resultContext>NOTIFICATION_VARS</resultContext
>
<name>Is-In-Penalty-State</name>
</actionAttribute>
<data>
<type>STRING</type>
<value>TimeUp</value>
</data>
<dataArguments/>
<actionAdjustmentValues/>
</action>
</defaultActions>
<thresholds/>
<ratingInfos/>
<overageInfos/>
</meteringLimit>
</getMeteringLimitsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-29 lists the fields for the getMeteringLimits command.
Table 4-29 getMeteringLimits response field descriptions
versionedObjectId The ID of the metering limit to be fetched. —


metering limit is defined.
Note: A null value for the RSV name will result in
an error.
sessionMonitoringKey Defines a metering limit as being for a session Values: 0 to 255 characters
and allows you to provide a name that identifies Type: string
the metering limit as a session-level monitoring
key.
meteringLimitType The type of metering limit defines the metering Values:

limit classification. • BASIC
Used to meter subscriber usage with a cap of • CONTROLLED_OVERAGE
the configured Quota
Used to meter subscriber usage
• VIRTUAL
aggregated limits assigned to the subscriber.
A limit that can be used to cap the usage
allowed after the applicable limit has been
reached.
When configuring a Controlled Overage
Limit, you cannot specify the Quota Type,
Overage Allowed, Validity Period, and Rating
Information.
Overage Information, which is the Overage
Information Name configured in the related
BASIC or UNLIMITED metering limit.

(1 of 5)
quotaType Defines what type of usage has to be metered. Values:

Specifies the direction of the usage to be • DOWN_LINK
monitored or the type of unit to be measured for • TOTAL
the quota value.
• UP_LINK
Valid options are: • TIME
• DOWN_LINK
Usage monitored in the down link direction. Type: enum
• TOTAL
• UP_LINK
• TIME
Usage as a function of time monitored in
both directions.
quota The maximum amount of a specified baseUnit Values: Long values of up to a
allowed to the subscriber on this metering limit, maximum of 4503599627370495,
as configured in the quota type and reported by or 252. You cannot enter 0 or a
the network. negative value.
meteringLimitType.
overageAllowed Determines if the metering limit can be used to Values: true or false
assign a quota once the limit has reached 100%. Type: boolean
true
Allows overage
false
Disallows overage
baseUnit Defines the smallest block of usage that can be Values: Long values of up to a
metered in the system. Any usage lesser than maximum of 4503599627370495,
this value may be rounded using rules specified or 252. You cannot enter 0 or a
in the System Preferences Metering Limit Base negative value.
Unit Rounding Type. Type: double
minimumBaseUnit The minimum number of baseUnits blocks that Values: Long values of up to a
are metered for a session. maximum of 4503599627370495,
negative value.
Type: integer
recurrence Defines the type of recurrence of the metering Valid values:

limit. • DAILY (reset daily)
Type: enum
(2 of 5)
carryOverExpiration Carry Over Expiration enables the quota leftover Values:

from one metering limit to be used before the • ONE_MONTH
quota of the next metering limit is applied.
• TWO_MONTHS
When the carry-over quota is calculated for
time-based metering, the time-based usage
• THREE_MONTHS
between last usage report and the reset is • SIX_MONTHS
excluded. If there is existing carryover quota, • TWELVE_MONTHS
the time usage between the last usage report • NEVER_EXPIRE
and the reset is not added to the carryover quota • ONE_WEEK
that has the closest expiry date.
• TWO_WEEKS
• THREE_WEEKS
• FOUR_WEEKS
• EIGHT_WEEKS
• TWELVE_WEEKS
• FIFTY_TWO_WEEKS
Type: enum
validityPeriod For non-recurring or one time meter limits, the Values: Long values of up to a
duration for which the metering limit is maximum of 4503599627370495,
applicable. or 252. You cannot enter 0 or a
negative value.
Type: integer
applicabilityConditions List of conditions in which the metering limit Values: empty list
applies. If no conditions are listed, the metering Type:
limit always applies. tns:getMeteringLimitApplicability
applicability Conditions.
defaultActions Defines actions that are applied by default when Values:
the metering limit is invoked. Type:
See Table 4-5 for a description of the default
actions.
(3 of 5)
thresholds The type of threshold defined in the metering Values: Contains

limit. meteringLimitThreshold which
consists of a name,
recurringThreshold,
thresholds
threshold —
The type of threshold defined in the metering
limit.

thresholdType Values:
Any number entered is treated as a percentage • RESET
threshold. • PENALTY_CLEAR
VALUE
Type: string
Any number entered is treated as a volume
threshold.
RESET
Resets the usage to zero (0). The Reset type
supports Send-Notification type actions only.
PENALTY_CLEAR
threshold actions for notifications and SPR
record updates when a penalty is cleared. The
Penalty Clear type supports Send-Notification
type actions and SPR/ account actions only.
thresholdValue Values: Long values of up to a
negative value.
Type: string
recurringThreshold Values: true or false

Indicates if the threshold is to be recurring. Type: boolean
thresholdConditions —
List of conditions under which threshold actions
are applied.
See Table 4-4 for a description of the Threshold
Conditions.
(4 of 5)
ratingInfo Rating information to be used under the —

specified conditions. If none are specified, a
rating factor is not applied.
Multiple rating informations entries can be
ratinginfo Values: n/a

Defines the rating information for managed or Type: Object
aggregate or controlled overage rating.
rcfName Values: 1 to 80 characters

Unique name for the rating information entry. Type: string

Provides a numerical value that is multiplied IEEE 754 floating point
within the raw counter usage values from the Type: double
network in order to rate the usage data.
Overageinfo Overage information that can be used in a Values: 1 to 255 characters

metering limit when this metering limit is in Type: string
effect. This only applies to BASIC and UNLIMITED
metering limits. Multiple overage information
can be provisioned within a metering limit.
oiName Values: 1 to 80 characters


Provides a numerical value that is applied IEEE 754 floating point
against the raw counter base values from the Type: double
network. The rate used when a metering limit
selects this Overage Information to be used.
baseUnit Values: Long values of up to a
Defines the smallest block of usage that can be maximum of 4503599627370495,
metered in the system. Any usage lesser than or 252. You cannot enter 0 or a
this value may be rounded using rules specified negative value.
in the System Preferences Metering Limit Base Type: double
Unit Rounding Type.
minUnit Values: 16-bit signed int value

The minimum amount of overage baseUnits that Type: integer
are metered for a session. The minUnit used
when a metering limit selects this Overage
Information to be used.
overageReferenceData Set of the reference data for the metering limit Values: Consists of a precedence,
from which to retrieve rating information in an type, key and a set of conditions
overage scenario. This only applies to a Type: meteringLimitPullData
(5 of 5)
4.18 getRuleSystemVersion
Gets the rule system version object.
Parameter
• name
Name of the rule system version to be fetched.
Request code
Code 4-33 shows a request code example for the getRuleSystemVersion command.
Code 4-33: getRuleSystemVersion request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getRuleSystemVersion>

<ns:name>rsns</ns:name>
</ns:getRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-30 lists the fields required for the getRuleSystemVersion command.
name The name of the rule system version. Values: 1 to 80 characters Mandatory
Type: string
Response code
Code 4-34 shows the response code for the getRuleSystemVersion command.
Code 4-34: getRuleSystemVersion response code example

<env:Header/>
<env:Body>
<getRuleSystemVersionResponse
m"
">
<ruleSystemVersion>
<name>RSV1</name>

<description>c1</description>
<state>DRAFT</state>
</ruleSystemVersion>
</getRuleSystemVersionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-31 lists the fields for the getRuleSystemVersion command.
Table 4-31 ruleSystemVersion response field descriptions
name Unique name that is used by the system to Values: 1 to 80 characters

identify the version Type: string
description Description of the rule system version. Values: 0 to 255 characters

Type: string
state Indicates the state of the rule system Values:

version. • DRAFT
The options are: • RELEASE
• DRAFT • ACTIVE
A version of the rule system version that
can be modified Type: string
• RELEASE
A version that is configured but can
have the description modified without
creating a new version; the release
version is available to become the
Active version on the 5780 DSC
When sending a rule provisioning API
request to a rule system version in a
RELEASE state, the rule system version
is updated to DRAFT and the rule
request is performed.
• ACTIVE
A read-only system configuration that is
the active version of the rules and is
currently running on the 5780 DSC.
4.19 getRuleSystemVersionDescription
Gets the description of the rule system version.
Parameter
• name
Request code
Code 4-35 shows a request code example for the getRuleSystemVersionDescription
command.
Code 4-35: getRuleSystemVersionDescription request code example

<soapenv:Envelope
"
m">
<soapenv:Header><cm:header><cm:clientAppId>?</cm:clientAppId><cm:
requestId>?</cm:requestId></cm:header></soapenv:Header>
<soapenv:Body>
<getRuleSystemVersionDescription>
<name>Default_Clone</name>
</getRuleSystemVersionDescription>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-32 lists the fields required for the getRuleSystemVersionDescription
command.
Table 4-32 name field description

name Name of the rule system version to be Values: 1 to 80 characters Mandatory
fetched. Type: string
Response code
Code 4-36 shows the response code for the getRuleSystemVersionDescription
command.
Code 4-36: getRuleSystemVersionDescription response code example

<?xml version="1.0" encoding="UTF-8"?>
<env:Header/>
<env:Body>
<getRuleSystemVersionResponse
m"
n"
<ruleSystemVersion>
<name>myRsv1</name>
<state>ACTIVE</state>
</ruleSystemVersion>
</getRuleSystemVersionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-33 lists the fields for the getRuleSystemVersionDescription command.
Table 4-33 description response field description
description Information about the rule system Values: 0 to 255 characters

version. Type: string
4.20 getRuleSystemVersionNames
Gets the name of the rule system version.
Parameter
• name
Request code
Code 4-37 shows a request code example for the getRuleSystemVersionNames
command.
Code 4-37: getRuleSystemVersionNames request code example

<soapenv:Envelope
ystem">
<soapenv:Header/>
<soapenv:Body>
<rul:getRuleSystemVersionNames/>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-34 lists the fields required for the getRuleSystemVersionNames command.

fetched. Type: string
Response code
Code 4-38 shows the response code for the getRuleSystemVersionNames command.
Code 4-38: getRuleSystemVersionNames response code example

<env:Header/>
<env:Body>
<getRuleSystemVersionNamesResponse
m"
n"
<ruleSystemVersions>Default</ruleSystemVersions>
</getRuleSystemVersionNamesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-35 lists the fields for the getRuleSystemVersionNames command.
Table 4-35 description response field description
ruleSystemVersions Name for the rule system version. Values: 0 to 255 characters
Note: A null value for the RSV name will result in Type: string
an error.
4.21 importRuleSystemVersion
Imports an XML formatted rule system configuration to the 5780 DSC.
Parameters
• name
Name of the rule system version to be imported to the 5780 DSC.
• description
Information about the rule system version to be imported to the 5780 DSC.
• content
Content of the rule system version to be imported to the 5780 DSC.
Request code
Code 4-39 shows a request code example for the importRuleSystemVersion
command.
Code 4-39: importRuleSystemVersion request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:importRuleSystemVersion>

<rul:name>testImport</rul:name>

<rul:description>description</rul:description>

<rul:content>{
"RuleSets": [
{
"name": "NASREQ_SESSION_START",
Variables"]
},
{
"name": "IPCAN_SESSION_ESTABLISHMENT",
"action": [
{
},
{
"name": "DSC.Charging-Information",
"value": "null"
},
{
"value": "null"
},
{
"name": "DSC.Offline",
"value": "null"
},
{
},
{
"name": "DSC.Online",
"value": "null"
},
{
},
{
},
{
"name": "DSC.Charging\/QoS-Rule-Definition",
"value": "null"
},
{
"name":
"DSC.Charging\/QoS-Rule-Definition-Name",
"value": "null"
},
{
"value": "EventTrigger.IP_CAN_CHANGE"
}
],
"Reject-Disabled-Subscriber-IP-CAN-Establishment"
]
},
{
"name": "USAGE_RESET",
Variables"]
},
{
"name": "PENALTY_CLEAR",
Variables"]
},
{
"name": "QOS_MANAGEMENT",
"action": [
{
"name": "DSC.QoS-Negotiation-GBR-Result",
"value":
},
{
"name":
"DSC.Allocation-Retention-Priority.Pre-emption-Capability",
"value": "null"
},
{
"name": "DSC.QoS-Upgrade-MBR-Result",
"value":
},
{
"name": "DSC.Default-Bearer-QCI",
"value": "null"
},
{
"name":
"value": "null"
},
{
"name": "DSC.Default-Bandwidth-UL",
"value": "0"
},
{
"name": "DSC.QoS-Negotiation-MBR-Result",
"value":
},
{
"name":
"DSC.Allocation-Retention-Priority.Pre-emption-Vulnerability",
"value": "null"
},
{
"name": "DSC.QoS-Upgrade-GBR-Result",
"value":
},
{
"name": "DSC.Default-Bandwidth-DL",
"value": "0"
}
],
Variables"]
},
{"name": "GATEWAY_SESSION_MODIFICATION"},
{
"name": "NASREQ_AUX_DYNAMIC_AUTHORIZATION",
"RuleTablePrecedence": ["Auxiliary Request Type"]
},
{
"name": "AF_SESSION_TERMINATION",
Variables"]
},
{
"name": "NASREQ_SESSION_CREATION",
"Reject-Disabled-Subscriber-NAS-Creation"
]
},
{
"name": "NASREQ_SESSION_STOP",
Variables"]
},
{
"name": "NASREQ_DYNAMIC_AUTHORIZATION",
Variables"]
},
{"name": "AUXGX_SESSION_TERMINATION"},
{
"name": "AF_SESSION_MODIFICATION",
Variables"]
},
{
"name": "DYNAMIC_RULE_CREATION",
"action": [
{
"name": "DSC.Metering-Method",
"value": "MeteringMethod.DURATION_VOLUME"
},
{
"name": "DSC.Service-Identifier",
"value": "1"
},
{
},
{
"name": "DSC.Rating-Group",
"value": "5"
},
{
"name": "DSC.Reporting-Level",
"value": "ReportingLevel.RATING_GROUP_LEVEL"
}
],
"Media-Type to QCI",
"PCC Rule default QCI",
"Reservation Priority to ARP Priority"
]
},
{
"name": "AUXGX_SESSION_ESTABLISHMENT",
"action": [
{
},
{
},
{
}
]
},
{
"name": "IPCAN_SESSION_MODIFICATION",
"action": [{
"name": "DSC.IPCanSessionModificationResult",
"value": "IPCanSessionModificationResult.REMOVE"
}],
Variables"]
},
{
"name": "IPCAN_SESSION_TERMINATION",
Variables"]
},
{
"name": "SPR_NOTIFICATION_UPDATE",
"Reject-Disabled-Subscriber-SPR-Modification"
]
},
{"name": "SPR_NOTIFICATION_DELETE"},
{"name": "AUXGX_SESSION_MODIFICATION"},
{
"name": "AF_SESSION_ESTABLISHMENT",
Variables"]
},
{"name": "GATEWAY_SESSION_TERMINATION"},
{
"name": "GATEWAY_SESSION_ESTABLISHMENT",
"action": [
{
"value": "null"
},
{
},
{
},
{
},
{
"value":
"EventTrigger.DEFAULT_EPS_BEARER_QOS_CHANGE"
},
{
"value": "EventTrigger.RECOVERY_OF_BEARER"
},
{
"value": "EventTrigger.LOSS_OF_BEARER"
}
]
}
],
"RuleTables": [
{
"name": "PCC Rule default QCI",
"rules": [{
"name": "getPccRuleQCI",
"precedence": 1,
"enabled": true,
"condition":
"(SERVICE_DATA.QoS-Information.QoS-Class-Identifier IS PRESENT )",
"actions": [{
"value":
"SERVICE_DATA.QoS-Information.QoS-Class-Identifier"
}]
}]
},
{
"name": "Reject-Disabled-Subscriber-SPR-Modification",
"rules": [{
"precedence": 1,
"enabled": true,
SubscriberState.DISABLED) AND (DSC.Emergency-APNs DOES NOT CONTAIN
IPCAN_SESSION.Called-Station-ID)",
"actions": [{
}]
}]
},
{
"name": "Reservation Priority to ARP Priority",
"rules": [
{
"name": "Zero",
"precedence": 8,
"enabled": true,
"condition":
ReservationPriority.DEFAULT)",
"actions": [{
"name":
"value": "8"
}]
},
{
"name": "Seven",
"precedence": 7,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "2"
}]
},
{
"name": "Six",
"precedence": 6,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "4"
}]
},
{
"name": "Five",
"precedence": 5,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "6"
}]
},
{
"name": "Four",
"precedence": 4,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "8"
}]
},
{
"name": "Three",
"precedence": 3,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "10"
}]
},
{
"name": "Two",
"precedence": 2,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "12"
}]
},
{
"name": "One",
"precedence": 1,
"enabled": true,
"condition":
"actions": [{
"name":
"value": "14"
}]
}
]
},
{
"name": "Reject-Disabled-Subscriber-NAS-Creation",
"rules": [{
"precedence": 1,
"enabled": true,
"actions": [{
}]
}]
},
{
"name": "Auxiliary Request Type",
"rules": [
{
"name": "Accounting Stop",
"precedence": 2,
"enabled": true,
== NASReqMessageType.ACCOUNTING_STOP)",
"actions": [
{
"value":
"AuxiliaryRequestType.DISCONNECT"
},
{
"name":
"NASREQ_MESSAGE.ALUTIMETRA.ALC-AA-Transit-IP",
"value": "1"
}
]
},
{
"name": "Default",
"precedence": 1,
"enabled": true,
"actions": [
{
"value": "AuxiliaryRequestType.COA"
},
{
"name":
"NASREQ_MESSAGE.ALUTIMETRA.ALC-AA-Transit-IP",
"value": "1"
}
]
}
]
},
{
"name":
"Reject-Disabled-Subscriber-IP-CAN-Establishment",
"rules": [{
"precedence": 1,
"enabled": true,
"condition": "(DSC.Emergency-APNs DOES NOT CONTAIN
GX.Called-Station-ID) AND (SPR_SUBSCRIBER.Subscriber-State ==
"actions": [{
}]
}]
},
{
"name": "Media-Type to QCI",
"rules": [
{
"name": "Video To QCI 2",
"precedence": 8,
"enabled": true,
"condition":
MediaType.VIDEO)",
"actions": [{
}]
},
{
"name": "Text To QCI 6",
"precedence": 7,
"enabled": true,
"condition":
MediaType.TEXT)",
"actions": [{
}]
},
{
"name": "Other To QCI 9",
"precedence": 6,
"enabled": true,
"condition":
MediaType.OTHER)",
"actions": [{
}]
},
{
"name": "Message To QCI 9",
"precedence": 5,
"enabled": true,
"condition":
MediaType.MESSAGE)",
"actions": [{
}]
},
{
"name": "Data To QCI 8",
"precedence": 4,
"enabled": true,
"condition":
MediaType.DATA)",
"actions": [{
}]
},
{
"name": "Control To QCI 6",

"precedence": 3,
"enabled": true,
"condition":
MediaType.CONTROL)",
"actions": [{
}]
},
{
"name": "Audio To QCI 1",
"precedence": 2,
"enabled": true,
"condition":
MediaType.AUDIO)",
"actions": [{
}]
},
{
"name": "Application To QCI 2",
"precedence": 1,
"enabled": true,
"condition":
MediaType.APPLICATION)",
"actions": [{
}]
}
]
},
{
"name": "Default Notification Variables",
"rules": [{
"name": "Values",
"precedence": 0,
"enabled": true,
"actions": [
{
"name":
"NOTIFICATION_VARS.Subscriber-User-Id",
"value": "SPR_SUBSCRIBER.Subscriber-User-Id"
},
{
"name":
"NOTIFICATION_VARS.Current-Date-Time-String",
"value": "SYSTEM.Current-Date-Time-String"
},
{
"name":
"NOTIFICATION_VARS.Subscriber-Mobile-Number",
"value":
"SPR_SUBSCRIBER.Notification-Config.Mobile-Number"
}
]
}]
}
]
}</rul:content>
</rul:importRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-36 lists the fields required for the importRuleSystemVersion command.

imported to the 5780 DSC. Type: string
description Information about the rule system Values: 0 to 255 characters Optional
version to be imported to the Type: string
5780 DSC.
content Content of the rule system version to Values: entire rule system Mandatory
be imported to the 5780 DSC. version objects in JSON format
Type: String
Response code
Code 4-40 shows the response code for the importRuleSystemVersion command.
Code 4-40: importRuleSystemVersion response code example

<env:Header/>
<env:Body>
<importRuleSystemVersionResponse
m"
n"
>
</env:Body>
</env:Envelope>
4.22 removeCustomDataProfile
Removes the specified custom data profile from the given rule system version.
Parameter
Identifies the custom data profile name and rule system version.
Request code
Code 4-41 shows a request code example for the removeCustomDataProfile
command.
Code 4-41: removeCustomDataProfile request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:removeCustomDataProfile>

</ns:removeCustomDataProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-37 lists the fields required for the removeCustomDataProfile command.

removed. Default: n/a

defined.
result in an error.
Response code
Code 4-42 shows the response code for the removeCustomDataProfile command.
Code 4-42: removeCustomDataProfile response code example

<env:Header/>
<env:Body>
<removeCustomDataProfileResponse
m"
"/>
</env:Body>
</env:Envelope>
4.23 removeMeteringLimit
Removes the specified metering limit from the specified subscriber object.
Parameter
Identifies the metering limit to be removed.
Request code
Code 4-43 shows a request code example for the removeMeteringLimit command.
Code 4-43: removeMeteringLimit request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:removeMeteringLimit>

</ns:removeMeteringLimit>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-38 lists the fields required for the removeMeteringLimit command.
name The name of the metering limit to be Values: 1 to 80 characters Mandatory

removed. Type: string
Default: n/a
ruleSystemVersionName The name of the rule system version in which Values: 1 to 80 characters Mandatory
the metering limit is defined. Type: string
Note: A null value for the RSV name will Default: n/a
result in an error.
Response code
Code 4-44 shows the response code for the removeMeteringLimit command.
Code 4-44: removeMeteringLimit command example

<env:Header/>
<env:Body>
<removeMeteringLimitResponse
m"
"/>
</env:Body>
</env:Envelope>
4.24 removeRuleSystemVersion
Removes the specified rule system version.
Parameter
• name
Name of the rule system version to be removed.
Request code
Code 4-45 shows a request code example for the removeRuleSystemVersion
command.
Code 4-45: removeRuleSystemVersion request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:removeRuleSystemVersion>

<ns:name>RSV1</ns:name>
</ns:removeRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-39 lists the fields required for the removeRuleSystemVersion command.
name The name of the rule system version to Values: 1 to 80 characters Optional
be removed. Type: string
Default: n/a
Response code
Code 4-46 shows the response code for the removeRuleSystemVersion command.
Code 4-46: removeRuleSystemVersion response code example

<env:Header/>
<env:Body>
<removeRuleSystemVersionResponse
m"
"/>
</env:Body>
</env:Envelope>
4.25 updateCustomDataProfile
Updates a custom data profile object, replacing all existing attributes with those
specified, applying defaults as required.
Parameter
The custom data profile to be updated.
Request code
Code 4-47 shows a request code example for the updateCustomDataProfile
command.
Code 4-47: updateCustomDataProfile request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataProfile>

<ns:customDataProfile>
<ns:ruleSystemVersionName>ns</ns:ruleSystemVersionNam
e>

<ns:description>c1</ns:description>

<ns:customData>
<ns:item>
<ns:value>
</ns:value>
</ns:item>
</ns:customData>
</ns:customDataProfile>
</ns:updateCustomDataProfile>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-40 lists the fields required for the updateCustomDataProfile command.
Table 4-40 updateCustomDataProfile field descriptions

updated. Default: n/a

defined.
result in an error.

information about the Type: string
Default: n/a

15=low)
customData Defines a list of one or more custom data — —

entries (item).
item — —
• name
• value

Default: n/a
value — —
• type
• data

• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)

STRING Default: n/a
IP_ADDRESS
LIST
following:
• STRING
• IP_ADDRESS

under 256, 000 characters.
ENUM
NUMBER
-(263) and 263 - 1
DECIMAL
(2 of 2)
Response code
Code 4-48 shows the response code for the updateCustomDataProfile command.
Code 4-48: updateCustomDataProfile response code example

<env:Header/>
<env:Body>
<updateCustomDataProfileResponse
m"
"/>
</env:Body>
</env:Envelope>
4.26 updateCustomDataProfile_CustomData
Updates the complete set of custom data entries for the specified custom data profile
object.
Parameters
Identifies the custom data profile to be updated identified by name or rule system
version.
• customData
Set of custom data to replace existing custom data set within the custom data
profile.
Request code
updateCustomDataProfile_CustomData command.
Code 4-49: updateCustomDataProfile_CustomData request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataProfile_CustomData>

</ns:customData>
<ns:value>
</ns:value>
</ns:customData>
</ns:updateCustomDataProfile_CustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-41 and 4-42 lists the fields required for the
updateCustomDataProfile_CustomData command.


defined.
result in an error.
Table 4-42 custom data field descriptions
customData Defines a list of one or more custom data — —

entries.
item — —
• name
• value
Default: n/a
value — —
• type
• data

• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)

Values: Up to 256,000 characters
IP_ADDRESS
LIST
following:
• STRING
• IP_ADDRESS

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL
(2 of 2)
Response code
Code 4-50 shows the response code for the updateCustomDataProfile_CustomData
command.
Code 4-50: updateCustomDataProfile_CustomData response code example

<env:Header/>
<env:Body>
<updateCustomDataProfile_CustomDataResponse
m"
"/>
</env:Body>
</env:Envelope>
4.27 updateCustomDataProfile_CustomDataEntry
Updates a single custom data entry for the custom data profile object.
Parameters
Identifies the custom data profile to be updated identified by the custom data
profile name and rule system version. name.
• customData
Identifies the custom data entry to be updated.
Request code
updateCustomDataProfile_CustomDataEntry command.
Code 4-51: updateCustomDataProfile_CustomDataEntry request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataProfile_CustomDataEntry>


<ns:customData>
<ns:value>
</ns:value>
</ns:customData>
</ns:updateCustomDataProfile_CustomDataEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields


defined.
result in an error.
customData Specifies the custom data entry (item) — —

to be updated.
Default: n/a
value — —
• type
• data
type Values: Mandatory

Type of data held in the custom data • STRING
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
(1 of 2)
customData (continued) data Values: Dependant on the Type —

IP_ADDRESS
LIST
following:
• STRING
• IP_ADDRESS

ENUM
NUMBER
-(263) and 263 - 1
DECIMAL
(2 of 2)
Response code
Code 4-52: updateCustomDataProfile_CustomDataEntry response code example

<env:Header/>
<env:Body>
<updateCustomDataProfile_CustomDataEntryResponse
m"
"/>
</env:Body>
</env:Envelope>
4.28 updateCustomDataProfilePriority
Updates the priority from the custom data profiles object.
Parameters
Identifies the custom data profile to be updated identified by the custom data
profile name and rule system version name.
• priority
The new priority value for the custom data profile.
Request code
Code 4-53 shows a request code example for the updateCustomDataProfilePriority
command.
Code 4-53: updateCustomDataProfilePriority request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataProfilePriority>


</ns:updateCustomDataProfilePriority>
</soapenv:Body>
</soapenv:Envelope>
Request fields
updateCustomDataProfilePriority command.
Table 4-45 updateCustomDataProfilePriority field descriptions


defined.
result in an error.
Table 4-46 updateCustomDataProfilePriority field descriptions
priority A number that states the precedence of this Values:1 to 15 Mandatory

subscriber (1=high; 15=low) Default: 0
Response code
Code 4-54 shows the response code for the updateCustomDataProfilePriority
command.
Code 4-54: updateCustomDataProfilePriority response code example

<env:Header/>
<env:Body>
<updateCustomDataProfilePriorityResponse
m"
"/>
</env:Body>
</env:Envelope>
4.29 updateMeteringLimit
Updates the specified metering limit object by replacing the existing version with the
one provided.
default values.
Parameter
• meteringLimit
Metering limit to be assigned to the subscriber.
Request code
Code 4-55 shows a request code example for the updateMeteringLimit command.
Code 4-55: updateMeteringLimit request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:updateMeteringLimit>

<rul:meteringLimit>
<rul:name>mlnew</rul:name>
<rul:ruleSystemVersionName>clone1</rul:ruleSystemVers
ionName>

<rul:description>Roaming_7_6_N</rul:description>

<rul:flowLevelArming>VFBIL_flowKey</rul:flowLevelArming>
<rul:meteringLimitType>BASIC</rul:meteringLimitType>
<rul:priority>2114900</rul:priority>

<rul:quotaType>TOTAL</rul:quotaType>
<rul:quota>2.0992E7</rul:quota>
<rul:overageAllowed>false</rul:overageAllowed>

<rul:baseUnit>102400.0</rul:baseUnit>

<rul:minimumBaseUnit>4</rul:minimumBaseUnit>
<rul:recurrence>MONTHLY</rul:recurrence>

<rul:applicabilityConditions>

<rul:condition>
<rul:criteria>
<rul:sourceContext>WNG_EVENTS</rul:sourceContex
t>
<rul:name>WNG-Event.Severity</rul:name>
</rul:criteria>

<rul:criteriaArguments>
<rul:argument>
<rul:name>Event-Type</rul:name>
<rul:value>
<rul:type>ENUM</rul:type>
<rul:value>WNGEventType.BATTERYATTACK_DIS
TRIBUTED</rul:value>
</rul:value>
</rul:argument>
</rul:criteriaArguments>
<rul:operator>EQUAL</rul:operator>
<rul:value>
<rul:type>ENUM</rul:type>
<rul:value>WNGEventSeverity.CRITICAL_CLEARED</r
ul:value>
</rul:value>

</rul:condition>
</rul:applicabilityConditions>

<rul:defaultActions>
<rul:action>
<rul:actionAttribute>
<rul:resultContext>METERING_FLOW_DEFAULT</rul:r
esultContext>
<rul:name>Penalty-Period</rul:name>
</rul:actionAttribute>
<rul:data>
<rul:type>NUMBER</rul:type>
<rul:value>12</rul:value>
</rul:data>
</rul:action>
</rul:defaultActions>

<rul:thresholds>
<rul:threshold>
<rul:name>th80</rul:name>

<rul:thresholdType>PERCENTAGE</rul:thresholdType>

<rul:thresholdValue>80</rul:thresholdValue>
<rul:recurringThreshold>false</rul:recurringThresh
old>
</rul:threshold>
</rul:thresholds>
</rul:meteringLimit>
</rul:updateMeteringLimit>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-47 lists the fields required for the updateMeteringLimit command.
Table 4-47 meteringLimit field descriptions
versionedObjectId The ID of the metering limit for which — Mandatory

the rule will be updated.

result in an error.

information about the metering limit. Type: string
Default: n/a
meteringLimitType The type of metering limit defines the Values: Mandatory

Used to meter subscriber usage with • CONTROLLED_OVERAGE
a cap of the configured Quota.
Used to meter subscriber usage. Default: n/a
• VIRTUAL
Used to generate notifications to
the subscriber produced from
crossing configured thresholds
based on the aggregated limits
assigned to the subscriber.
A limit that can be used to cap the
usage allowed after the applicable
limit has been reached.
When configuring a Controlled
Overage Limit, you cannot specify
the Quota Type, Overage Allowed,
Validity Period, and Rating
Information.
Overage Information, which is the
Overage Information Name
configured in the related BASIC or
UNLIMITED metering limit.

15=low)
(1 of 5)
quotaType Defines what type of usage has to be Values: Mandatory

metered. • DOWN_LINK
Specifies the direction of the usage to • TOTAL
be monitored or the type of unit to be
measured for the quota value.
• UP_LINK
• TIME
Valid options are:
• DOWN_LINK Type: enum
Usage monitored in the down link Default: n/a
direction.
• TOTAL
Value usage monitored in both
directions.
• UP_LINK
Usage monitored in the up link
direction.
• TIME
Usage as a function of time
monitored in both directions.
quota The maximum amount of a specified Values: Long values of up to a Mandatory

baseUnit allowed to the subscriber on maximum of 4503599627370495,
this metering limit, as configured in the or 252. You cannot enter 0 or a
quota type and reported by the negative value.
network. Type: double
This only applies to the BASIC Default: n/a
meteringLimitType.
overageAllowed Determines if the metering limit can be Values: true or false Optional
used to assign a quota once the limit has Type: boolean
reached 100%.
Default: true
true
Allows overage
false
Disallows overage
baseUnit Defines the smallest block of usage that Values: Long values of up to a Optional
can be metered in the system. Any usage maximum of 4503599627370495,
lesser than this value may be rounded or 252. You cannot enter 0 or a
using rules specified in the System negative value.
Preferences Metering Limit Base Unit Type: double
Rounding Type .
Default: 1.0
minimumBaseUnit The minimum number of baseUnits Values: Long values of up to a Optional

blocks that are metered for a session. maximum of 4503599627370495,
negative value.
Type: integer
Default: 1
recurrence Defines the period in which the metering Values: Mandatory
limit is valid before the metering limit is • DAILY (reset daily)
actually reset.
Type: enum
Default: n/a
(2 of 5)
validityPeriod The number of days for which the Values: Long values of up to a Optional
metering limit is valid. This is only valid maximum of 4503599627370495,
if the recurrence is set to NONE. or 252. You cannot enter 0 or a
negative value.
Type: integer
Default: 1
applicabilityConditions List of conditions in which the metering Values: empty list Optional
limit applies. If no conditions are listed, Type:
the metering limit always applies. tns:getMeteringLimitApplicability
applicability Conditions. Default: n/a
(3 of 5)
thresholds The type of threshold defined in the Values: Contains Optional

metering limit. meteringLimitThreshold which
consists of a name,
recurringThreshold,
thresholds
threshold — —
Defines threshold crossings and the
actions to be taken.

Default: n/a
thresholdType Values: Mandatory

Any number entered is treated as a • RESET
percentage threshold. • PENALTY_CLEAR
VALUE
Type: string
Any number entered is treated as a
Default: n/a
volume threshold.
RESET
Resets the usage to zero (0). The Reset
type supports Send-Notification type
actions only.
PENALTY_CLEAR
Configures a metering limit that
provides threshold actions for
notifications and SPR record updates
when a penalty is cleared. The Penalty
Clear type supports Send-Notification
type actions and SPR/ account actions
only.
thresholdValue Values: Long values of up to a Mandatory
negative value.
Type: string
Default: n/a
recurringThreshold Values: true or false Optional

Indicates if the threshold is to be Type: boolean
recurring. Default: false
thresholdConditions Default: empty list Optional

(4 of 5)
ratingInfo Rating information to be used under the Values: n/a Optional

specified conditions. If none are Type: Object
specified, a rating factor is not applied.
Default: none
Multiple rating informations entries can
be provisioned within a metering limit.
rcfName Values: 1 to 80 characters Mandatory

Unique name for the rating information Type: string
entry. Default: n/a

multiplied within the raw counter usage Type: double
values from the network in order to rate Default: none
the usage data.
rateConditions — Optional
List of conditions under which the rating
factor is applied. If none are specified,
this rating factor is always used.
Overageinfo Overage information that can be used in Values: 1 to 255 characters Optional
a metering limit when this metering Type: string
limit is in effect. This only applies to
BASIC and UNLIMITED metering limits. Default: n/a
Multiple overage information can be
oiName Values: 1 to 80 characters Optional

Default: none

applied against the raw counter base Type: double
values from the network. The rate used Default: none
when a metering limit selects this
baseUnit Values: Long values of up to a Optional

Defines the smallest block of usage that maximum of 4503599627370495,
can be metered in the system. Any usage or 252. You cannot enter 0 or a
lesser than this value may be rounded negative value.
using rules specified in the System Type: double
Preferences Metering Limit Base Unit Default: 1.0
Rounding Type .
minUnit Values: 16-bit signed int value Optional

The minimum amount of overage Type: integer
baseUnits that are metered for a Default: none
session. The minUnit used when a
metering limit selects this Overage
Information to be used.
overageReferenceData Set of the reference data for the Values: Consists of a precedence, Optional
metering limit from which to retrieve type, key and a set of conditions
rating information in an overage Type: meteringLimitPullData
scenario. This only applies to a
(5 of 5)
Response code
Code 4-56 shows the response code for the updateMeteringLimit command.
Code 4-56: updateMeteringLimit response code example

<env:Header/>
<env:Body>
<updateMeteringLimitResponse
m"
n"
>
</env:Body>
</env:Envelope>
4.30 updateMeteringLimitApplicabilityConditions
Updates the complete set of applicability conditions for the metering limit.
Parameters
The ID of the metering limit to be fetched.
• condition
Condition in which the metering limit applies. You can specify zero or more
conditions.
Request code
updateMeteringLimitApplicabilityConditions command.
Code 4-57: updateMeteringLimitApplicabilityConditions request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:updateMeteringLimitApplicabilityConditions>

<rul:ruleSystemVersionName>clonedRSV2</rul:ruleSystemVer
sionName>
<rul:condition>
<rul:criteria>
<rul:sourceContext>GX_MESSAGE</rul:sourceContex
t>
<rul:name>Called-Station-ID</rul:name>
</rul:criteria>
<rul:criteriaArguments/>
<rul:operator>EQUAL</rul:operator>
<rul:value>
<rul:type>STRING</rul:type>
</rul:value>
</rul:condition>
</rul:updateMeteringLimitApplicabilityConditions>
</soapenv:Body>
</soapenv:Envelope>
Request fields


result in an error.
Table 4-49 condition field descriptions
criteria The criteria is made up of a source context —

and criteria attribute which represents the
attribute that the 5780 DSC evaluates in the
specified source context.
See Appendix A, Context and criteria
parameters in the 5780 DSC User Guide for
more information.
sourceContext Values: 1 to 80 characters

A unique name for the metering limit. Type: string

A Rule System Version to associate with the Type: string
metering limit.
criteriaArguments argument Values: n/a

The values displayed depend on the criteria Type: tns:AttributeArgument
that you chose for the Criteria parameter in a
particular context.
operator The filter operator. The operators are:

• EQUAL
• NOT_EQUAL
• GREATER_THAN
• LESS_THAN
• CONTAINS
• PRESENT
• NOT_PRESENT
• WITHIN_NETMASK
• MATCH_PATTERN
• MATCH_SUBSTRING
Type: tns:RelationalOperator
(1 of 2)
value The value available depends on the criteria Values: Value available depends on the
that you have selected. criteria that you have selected. The
value type can be one of the following:
• STRING
• NUMBER
• DECIMAL
• ENUM
• IP_ADDRESS
• TIME_DURATION
• DATE_TIME
• TIME_OF_DAY
• MANAGED_OBJECT
• LIST
• ATTRIBUTE
• ARP
Type: GenericValue
valueArguments Set of arguments for the value. The value Values: Consists of a name and a value.
depends on the value you chose for the Value Type: AttributeArgument
parameter.
• value
• type
adjustmentOperator This parameter only appears if the selected Values: The valid options are:
Action Attribute is a numeric value and you • ADD
selected the Attribute option for the Data
Type. You can use this parameter to adjust
• MULTIPLY
Data, for example adding or decreasing a • SUBRACT
percentage of their bandwidth allocation, or • UNION
adding or decreasing their time allotment.
Type: string
adjustmentValues Used to specify the amount of adjustment to Values: The value can one of:
apply to the Data. • ATTRIBUTE
• DECIMAL
• NUMBER
• TIME DURATION
Type: tns:adjustmentValues
(2 of 2)
Response code
Code 4-58: updateMeteringLimitApplicabilityConditions response code example

<env:Header/>
<env:Body>
<updateMeteringLimitApplicabilityConditionsResponse
m"
"/>
</env:Body>
</env:Envelope>
4.31 updateMeteringLimitDefaultActions
Updates the complete set of default actions for the metering limit.
Parameters
• condition
Condition in which the metering limit applies. You can specify zero or more
conditions.
Request code
updateMeteringLimitDefaultActions command.
Code 4-59: updateMeteringLimitDefaultActions request code example

<soapenv:Envelope
n"
ystem">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<rul:updateMeteringLimitDefaultActions>

ersionName>
<rul:action>
<rul:actionAttribute>
<rul:resultContext>METERING_FLOW_DEFAULT</rul:resultC
ontext>
<rul:name>Allocation-Retention-Priority.Priority-Leve
l</rul:name>
</rul:actionAttribute>
<rul:data>
</rul:data>

<rul:adjustmentOperator>ADD</rul:adjustmentOperator>

<rul:adjustmentData>
</rul:adjustmentData>

</rul:action>
</rul:updateMeteringLimitDefaultActions>
</soapenv:Body>
</soapenv:Envelope>
Request fields
updateMeteringLimitDefaultActions command.



result in an error.
Type: string
Displays the Result Context Types that are available. Values:

• DSC tns:ResultContextType
• GX_MESSAGE Type: string
• GXX_MESSAGE
• RX_MESSAGE
• IPCAN_SESSION
• GWC_SESSION
• AF_SESSION
• NASREQ_SESSION
• SPR_SUBSCRIBER
• NAS_CLUSTER
• DEFAULTS
• METERING
• METERING_FLOW
• MPS_SESSION
• WNG
• WNG_FLOW
• WNG_SESSION
• SPR_ACCOUNT
• SPR_ACCOUNT_WNG
name Values: 1 to 255

A Rule System Version to associate with the metering limit. characters
Type: string
(1 of 2)
as follows:
• STRING
• NUMBER
• DECIMAL
• ENUM
• IP_ADDRESS
• TIME_DURATION
• DATE_TIME
• TIME_OF_DAY
• MANAGED_OBJECT
• LIST
• ATTRIBUTE
• ARP
• CUSTOM_DATA
• ADD
• SUBTRACT
• MULTIPLY
• UNION
• CONCATENATE
Type: string
Type and Value Values: tns:GenericValue

This parameter appears when the Adjustment Operator parameter is Type: string
configured. This parameter specifies the data type that is used when
Attribute
(2 of 2)
Response code
Code 4-60 shows the response code for the updateMeteringLimitDefaultActions
command.
Code 4-60: updateMeteringLimitDefaultActions response code example

<env:Header/>
<env:Body>
<updateMeteringLimitDefaultActionsResponse
m"
n"
>
</env:Body>
</env:Envelope>
4.32 updateMeteringLimitPriority
Updates the priority for the metering limit.
Parameters
• priority
A number that states the precedence of this metering limit opposed to other
metering limits that may be assigned to the subscriber.
The priority order is based on the system preference Metering Limit Priority
Ordering - Low to High setting.
Request code
Code 4-61 shows a request code example for the updateMeteringLimitPriority
command.
Code 4-61: updateMeteringLimitPriority request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateMeteringLimitPriority>


</ns:updateMeteringLimitPriority>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-52 and 4-53 list the fields required for the updateMeteringLimitPriority
command.
name The name of the metering limit to Values: 1 to 80 characters Mandatory

be updated. Type: string
Default: n/a
ruleSystemVersionName The name of the rule system Values: 1 to 80 characters Mandatory

version in which the metering Type: string
limit is defined.
Default: n/a
Note: A null value for the RSV
name will result in an error.
Table 4-53 priority field descriptions

this custom data profiles opposed to other Type: Integer
custom data profiles that may be assigned
to the subscriber (1=high; 15=low)
Response code
Code 4-62 shows the response code for the updateMeteringLimitPriority command.
Code 4-62: updateMeteringLimitPriority response code example

<env:Header/>
<env:Body>
<updateMeteringLimitPriorityResponse
m"
"/>
</env:Body>
</env:Envelope>
4.33 updateMeteringLimitQuota
Updates the quota for the metering limit.
Parameters
• quota
The maximum amount of a specified baseUnit allowed to the subscriber on this
metering limit, as configured in the quota type and reported by the network.
This only applies to the BASIC meteringLimitType.
Request code
Code 4-63 shows a request code example for the updateMeteringLimitQuota
command.
Code 4-63: updateMeteringLimitQuota request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateMeteringLimitQuota>


<ns:quota>4.0</ns:quota>
</ns:updateMeteringLimitQuota>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-54 and 4-55 lists the fields required for the updateMeteringLimitQuota
command.
name The name of the metering limit to be Values: 1 to 80 characters Mandatory

updated. Type: string
Default: n/a
ruleSystemVersionName The name of the rule system version in which Values: 1 to 80 characters Mandatory
the metering limit is defined. Type: string
Note: A null value for the RSV name will result Default: n/a
in an error.
Table 4-55 quota field descriptions
quota The maximum amount of a specified base Values: Long values of up to a Mandatory
unit allowed to the subscriber on this maximum of 4503599627370495, or
metering limit, as configured in the quota 252. You cannot enter 0 or a negative
type and reported by the network. value.
Type: double
Default: n/a
Response code
Code 4-64 shows the response code for the updateMeteringLimitQuota command.
Code 4-64: updateMeteringLimitQuota response code example

<env:Header/>
<env:Body>
<updateMeteringLimitQuotaResponse
m"
"/>
</env:Body>
</env:Envelope>
4.34 updateMeteringLimitRateLimitRate
Updates the rate within a specified rating limit for the metering limit.
Parameters
• rcfName
Unique name for the rating information entry.
• rate
Provides a numerical value that is multiplied within the raw counter usage values
from the network in order to rate the usage data.
Request code
updateMeteringLimitRateLimitRate command.
Code 4-65: updateMeteringLimitRateLimitRate request code example

<soapenv:Envelope
n"
stem">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateMeteringLimitRateLimitRate>


<ns:rcfName>rcf1</ns:rcfName>

<ns:rate>6.0</ns:rate>
</ns:updateMeteringLimitRateLimitRate>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-56 , 4-57, and 4-58 list the fields required for the
updateMeteringLimitRateLimitRate command.
Table 4-56 versionedObjectId field description
versionedObjectId The ID of the metering limit for which the rule will be — Mandatory
updated.

The name of the metering limit to be updated. Type: string
Default: n/a

metering limit is defined. Default: n/a
Note: A null value for the RSV name will result in an
error.
Table 4-57 rcfName field description
rcfName Unique name for the rating information entry. Values: 1 to 80 characters Mandatory
Type:string
Table 4-58 rate field description

rate Provides a numerical value that is multiplied Values: Double-precision Mandatory
within the raw counter usage values from the 64-bit IEEE 754 floating point
network in order to rate the usage data. Type: double
Response code
Code 4-66 shows the response code for the updateMeteringLimitRateLimitRate
command.
Code 4-66: updateMeteringLimitRateLimitRate response code example

<env:Header/>
<env:Body>
<updateMeteringLimitRateLimitRateResponse
m"
"/>
</env:Body>
</env:Envelope>
4.35 updateRuleSystemVersionDescription
Updates the description of the rule system version.
Parameters
• name
Name of the rule system version to be updated.
• description
Information about the rule system version.
Request code
updateRuleSystemVersionDescription command.
Code 4-67: updateRuleSystemVersionDescription request code example

<soapenv:Envelope
"
m">
<soapenv:Header><cm:header><cm:clientAppId>?</cm:clientAppId><cm:
requestId>?</cm:requestId></cm:header></soapenv:Header>
<soapenv:Body>
<updateRuleSystemVersionDescription>
<name>Default_Clone</name>
<description>Default Clone - Version 1.2</description>
</updateRuleSystemVersionDescription>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-59 list the fields required for the updateRuleSystemVersionDescription
command.
Table 4-59 updateRuleSystemVersionDescription field descriptions
name The name of the rule system version. This should Values: 1 to 255 characters Mandatory
be unique name across all rule system versions. Type: string
description The description of the rule system version. Values: 0 to 255 characters Optional
Type: string
Response code
Code 4-68 shows the response code for the updateRuleSystemVersionDescription
command.
Code 4-68: updateRuleSystemVersionDescription response code example

<env:Header/>
<env:Body>
<updateRuleSystemVersionDescriptionResponse
m"
n"
>
</env:Body>
</env:Envelope>
5— NASREQ session API
5.1 Using the NASREQ session API 5-2
5.2 bindSubscriber 5-2
5.3 disconnectSession 5-6
5.4 getSession 5-8
5.5 getSessionSummary 5-17
5 — NASREQ session API
5.1 Using the NASREQ session API
The NASREQ session API is used to query information related to NAS sessions.
Session modification is not possible using this API.
5.2 bindSubscriber
Binds a subscriber to a NASREQ session by associating a subscription id of a know

subscriber to a NASREQ session identified by IP address. This will also invoke the
SPR Notification Update ruleset.
Parameters
• sessionIdentifier
Identifies the NASREQ session by IP Address and IPv6 Prefix.
• subscriptionId
Identifies the subscriber to bind to the session by subscription Id.
Request code
Code 5-1 shows a request code example for the bindSubscriber command.
Code 5-1: bindSubscriber request code example

<soapenv:Envelope
n"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/sessio
n">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:bindSubscriber>

<ns:sessionIdentifier>


<ns:subscriptionId>

<ns:ipAddress>127.32.67.15</ns:ipAddress>

<ns:ipv6Prefix>::127.32.67.15</ns:ipv6Prefix>
</ns:sessionIdentifier>
<ns:subscriptionId>
</ns:bindSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 5-1 and 5-2 lists the fields required for the bindSubscriber command.
Table 5-1 sessionIdentifier field descriptions
subscriberId.

subscriptionId type. Note: You must enter
Multiple subscriptionIds can be specified; however, the either userId or
5780 DSC uses the first subscriptionId that matches a subscriberId.
subscriber.
• value
• type

Type: string
Default: n/a

Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(1 of 2)
ipAddress Contains the UE IP address that is requesting authentication or Values: A valid IP address Optional
reauthentication of the user. consists of four integers
separated by a dot; for
example, 10.10.10.1.
Type: string
Default: user-defined
ipv6Prefix Contains the IPv6 prefix (length can be included preceded by Values: A valid IPv6 Address Optional
/) to be configured for the user. consists of eight four-digit
hexadecimal numbers separated
by colons and uses the following
format:
<ipv6Prefix>/<PrefixLength>
For example:
0011:2233:4455:6677:8899
:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
Table 5-2 subscriptionId field descriptions

subscriber.
• type
• value

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Type: string
Default: n/a
Response code
Code 5-2 shows the response code for the bindSubscriber command.
Code 5-2: bindSubscriber response code example

<env:Header/>
<env:Body>
<bindSubscriberResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/session"
"/>
</env:Body>
</env:Envelope>
5.3 disconnectSession
Disconnects a NASREQ session.
Parameter
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 5-3 shows a request code example for the disconnectSession command.
Code 5-3: disconnectSession request code example

<soapenv:Envelope
n"
xmlns:ns1="http://www.alcatellucent.com/dsc/provisioningapi/51/sessi
on">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns1:disconnectSession>

<ns1:sessionIdentifier>

<ns1:userId>451131AB</ns1:userId>


<ns1:ipAddress>127.32.67.15</ns1:ipAddress>

<ns1:ipv6Prefix>::127.32.67.15</ns1:ipv6Prefix>
</ns1:sessionIdentifier>
</ns1:disconnectSession>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 5-3 and lists the fields required for the disconnectSession command.
subscriberId.

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
example, 10.10.10.1.
Type: string
(1 of 2)
ipv6Prefix Contains the IPv6 prefix (length can be preceded by /) to be Values: A valid IPv6 Address Optional
configured for the user consists of eight four-digit
format:
For example:
0011:2233:4455:6677:8899
:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
representations.
(2 of 2)
Response code
Code 5-4 shows the response code for the disconnectSession command.
Code 5-4: disconnectSession response code example

<env:Header/>
<env:Body>
<disconnectSessionResponse
"/>
</env:Body>
</env:Envelope>
5.4 getSession
Gets a fully populated NASREQ session.
Parameter
Request code
Code 5-5 shows a request code example for the getSession command.
Code 5-5: getSession request code example

<soapenv:Envelope
n"
n">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getSession>



<ns:subscriptionId>


</ns:getSession>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 5-4 lists the fields required for the command.
subscriberId.
(1 of 2)

subscriber.
• value
• type

Type: string
Default: n/a

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
example, 10.10.10.1.
Type: string
ipv6Prefix Contains the IPv6 prefix (length can be included preceded by Values: A valid IPv6 Address Optional
/) to be configured for the user. consists of eight four-digit
format:
For example:
0011:2233:4455:6677:8899
:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
representations.
(2 of 2)
Response code
Code 5-6 shows the response code for the getSession command.
Code 5-6: getSession response code example

<env:Header/>
<env:Body>
<getSessionResponse
">
<nasreqSession>
<sessionId>45113AB</sessionId>

<lastUpdatedTime>2011-12-10 22:57:06</lastUpdatedTime>
<userId>451131AB</userId>
<sessionBindingIdentifier>

<ipAddress>127.32.67.15</ipAddress>

<ipv6Prefix>::127.32.67.15</ipv6Prefix>

<calledStationId>cs3334</calledStationId>

<subscriptionIds>
<subscriptionId>
<value>31007012345678</value>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>

<diameterHost>john.18001.clientRealm.18001</diameterHost
>

<vendorSpecificAttributes>
<vendorSpecificAttribute>
<name>ALUTIMETRA.ALC-Subscriber-Profile-String</na
me>
<value>
<type>STRING</type>
<value>HSI_Gold_Sub</value>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
<userName>user@domain.com</userName>

<domain>domain.com</domain>

<sessionState>STARTED</sessionState>

<acctSessionId>acct-session-id</acctSessionId>

<acctMultiSessionId>acct-session-id-2</acctMultiSessionI
d>

<nasInfo>
<nas>

<type>STANDALONE</type>

<identifier>nas1</identifier>


<ipv6Address>::127.32.67.15</ipv6Address>
</nas>
</nasInfo>

<nasPort>1813</nasPort>

<nasPortId>nas1_port</nasPortId>

<nasPortType>SYNC</nasPortType>

<nasStatus>CoA sent to host address:(127.32.67.15) of
Primary NAS=Success</nasStatus>
</nasreqSession>
</getSessionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 5-5 lists the fields for the command.
Table 5-5 NASREQSession field descriptions
sessionId A unique number that the server assigns to a user Values: valid session id
for the duration of session. Type: string
lastUpdatedTime Displays the timestamp for the last update to the Values: Long values of up to a
session. maximum of 4503599627370495, or
252. You cannot enter 0 or a negative
value.
Type: string
Type: string
(1 of 6)
sessionBindingIdentifier Identifies the parameters with which the session —

was created on the PCRF.
ipAddress Values: A valid IP address consists of

The IP address of the NAS. four integers separated by a dot; for
example, 10.10.10.1.
Type: string
IPv6Prefix Values: A valid IPv6 Address consists

Contains the IPv6 prefix (length can be preceded by of eight four-digit hexadecimal
/) to be configured for the user numbers separated by colons and
uses the following format:
For example:
0011:2233:4455:6677:8899:aa
b:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A Recommendation for
IPv6 Address Text Representation
for supported IPv6 Prefix
representations.
calledstationId Values: 1 to 255 characters

A unique identifier for the called station ID. Type: string
subscriptionIds —
Contains a list of subscription ids associated with
this subscriber.
When using subscriberId as an input parameter to
identify the session to be retrieved, only this
subscription Id is returned (not all subscription Ids
associated with this subscriber).
subscriptionId —
The subscriptionId identifies the subscription based
on a valid subscriptionId type.
Multiple subscriptionIds can be specified; however,
the 5780 DSC uses the first subscriptionId that
matches a subscriber.
The 5780 DSC uses the subscriptionId to match the
incoming network messages to the subscriber
object. The subscriptionId must exactly match the
based on:
• type
• value
(2 of 6)
sessionBindingIdentifier (continued) type Values:

The type of identifier that is carried by the • END_USER_E164
International E.164 format (for example, MSISDN), • END_USER_NAI
according to the ITU-T E.164 numbering plan • END_USER_PRIVATE
defined in [E164] and [CE164].
End User IMSI format, according to the ITU-T E.212
numbering plan as defined in [E212] and [CE212].
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
value Values: Valid values as allowed by

The identifier of the subscription. the type; for example,
Type: string
diameterHost The name of the Diameter host of the gateway. Values:1 to 255 characters
Type: string
vendorSpecificAttributes The Vendor Specific Attributes associated with the —

NASREQ session.
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a
single entry based on:
• name
• value
name Values: As defined in the vendor
A unique vendor name. dictionaries, for example:
ALUTIMETRA.ALC-Subscriber-Profile
-String.
Type: string
value —
• type
• value
(3 of 6)
vendorSpecificAttributes type Values:

(continued) Type of data held in the vendorSpecificAttributes • STRING
STRING • LIST
Contains a text string of the exact value that you • ENUM
require for the action. • NUMBER
Values: Up to 256000 characters • DECIMAL
IP_ADDRESS
Type: Enum
Contains a single IP address in any of the accepted
formats for an IP address.
Values: For a list of the supported formats, see the
chapter “Configuring and managing subscribers in
the SPR” in the 5780 DSC User Guide.
LIST
• STRING
• IP_ADDRESS
Values: The encoded value must be under 256,000

characters.
ENUM
NUMBER
DECIMAL
example: 1.0456.
value Values: up to 256,0000 characters

The data type value configured for the Vendor Type: string
Specific Attribute.
userName The name of the user. Values:1-80 characters

Type: integer
domain The user’s domain that is extracted from the value Values:1-80 characters
of the username. For example, if the username is Type: integer
user@domain.com, the domain is domain.com.
(4 of 6)
sessionState The current state of the NASREQ session. A session Values:

that is not yet started is in the CREATED state. • CREATED
When an Accounting Start request is received, the
session changes to the STARTED state. • STARTED
When an Accounting Stop request is received, the
• STOPPED
session changes to the STOPPED state. • DISCONNECTED
CREATED Type: string
Indicates that the session is in the Created state
immediately after it is created.
STARTED
Indicates that the session is in a Started state after
an accounting start.
STOPPED
Indicates that the session is in a Stopped state after
an accounting stop.
DISCONNECTED
Indicates that the session is in a Disconnected state
after an accounting disconnect.
acctSessionId Unique identifier for the current accounting Values: valid session id
session. Type: integer
acctMultiSessionId Unique identifier linking multiple accounting Values: 1 to 255 characters long
sessions. Type: string
nasInfo Provides information about the NAS. —

type Values:
The NAS Type. • STANDALONE
• PRIMARY
• SECONDARY
Type: enum
identifier Values: 1 to 255 characters long

Contains the ASCII text identifying the NAS. Type: string

The IP address of the NAS four integers separated by a dot; for
example, 10.10.10.1.
Type: string
IPv6Address Values: A valid IPv6 Address consists

For example:
0011:2233:4455:6677:8899:aa
b:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
representations.
nasPort Contains the physical port number of the NAS which Values:1-80 characters
is authenticating the user. Type: integer
(5 of 6)
nasPortId Contains the ASCII text identifying the port of the Values: 1 to 255 characters
NAS authenticating the user. Type: string
nasPortType Contains the type of the physical port of the NAS Values:
which is authenticating the user • ASYNC
• SYNC
• ISDN_SYNC
• ISDN_ASYNC_V120
• ISDN_ASYNC_V110
• VIRTUAL
• PIAFS
• HDLC_CLEAR_CHANNEL
• X25
• X75
• G3_FAX
• SDSL
• ADSL_CAP
• ADSL_DMT
• IDSL
• ETHERNET
• XDSL
• CABLE
• WIRELESS_OTHER
• WIRELESS_IEEE80211
• TOKEN_RING
• FDDI
• WIRELESS_CDMA2000
• WIRELESS_UMTS
• WIRELESS_1XEV
• IAPP
• FTTP
• WIRELESS_802_16
• WIRELESS_802_20
• WIRELESS_802_22
• PPPoA
• PPPoEoA
• PPPoEoE
• PPPoEoVLAN
• PPPoEoQinQ
• xPON
• WIRELESS_XGP
Type: integer
nasStatus Contains the CoA and disconnect status for all NASs Values: 1 to 512 characters long
attached to the session. Type: string
(6 of 6)
5.5 getSessionSummary
Gets a summary of the NASREQ session.
Parameter
Request code
Code 5-7 shows a request code example for the getSessionSummary command.
Code 5-7: getSessionSummary request code example

<soapenv:Envelope
n"
n">
<soapenv:Header>
<ns1:header>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns1:getSessionSummary>



<ns:subscriptionId>


</ns:getSessionSummary>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Type: string
Default: n/a

Multiple subscriptionIds can be specified; however, the 5780 DSC
uses the first subscriptionId that matches a subscriber.
• value
• type
type Values: Optional

International E.164 format (for example, MSISDN), according to the • END_USER_SIP_URI
ITU-T E.164 numbering plan defined in [E164] and [CE164]. • END_USER_NAI
End User IMSI format, according to the ITU-T E.212 numbering plan
Type: enum
as defined in [E212] and [CE212].
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
value Values: Valid values as allowed Optional

Type: string
Default: n/a
separated by a dot; for example,
10.10.10.1.
Type: string
(1 of 2)
format:
For example:
0011:2233:4455:6677:8899
:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
representations.
(2 of 2)
Response code
Code 5-8 shows the response code for the getSessionSummary command.
Code 5-8: getSessionSummary response code example

<env:Header/>
<env:Body>
<getSessionSummaryResponse
">
<nasreqSessionSummary>
<sessionId>NASREQSession-jun</sessionId>
<sessionState>STARTED</sessionState>

<userId>45113AB</userId>

<subscriptionIds>
<subscriptionId>
<type>END_USER_NAI</type>
<value>john.smith@abccompany.com</value>
</subscriptionId>
</subscriptionIds>


<ipv6Prefix>::127.32.67.15</ipv6Prefix>

<nasPort>1813</nasPort>

<nasPortId>1/1/2:301</nasPortId>


<name>ALUTIMETRA.ALC-Subscriber-Profile-String</na
me>
<value>
<type>STRING</type>
<value>HSI_Gold_Sub</value>
</value>
</nasreqSessionSummary>
</getSessionSummaryResponse>
</env:Body>
</env:Envelope>
Table 5-7 lists the fields required for the getSessionSummary command.
Table 5-7 nasreqSessionSummary field descriptions
sessionState Indicates the state of a session. Values:

CREATED • CREATED
Indicates that the session is in the Created state • STARTED
immediately after it is created. • STOPPED
STARTED • DISCONNECTED
Indicates that the session is in a Started state
Type: string
after an accounting start.
STOPPED
Indicates that the session is in a Stopped state
after an accounting stop.
DISCONNECTED
Indicates that the session is in a Disconnected
state after an accounting disconnect.
Type: string
(1 of 4)
subscriptionIds Contains a list of subscription ids for this —

subscriber.
subscriptionId —
The subscriptionId identifies the subscription
based on:
• type
• value
type Values:
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
value Values: Valid values as allowed by the type; for

The identifier of the subscription. example, sip:9251234567@example.com.
Type: string
ipAddress The IP address of the NAS. Values: A valid IP address consists of four integers
separated by a dot; for example, 10.10.10.1.
Type: string
ipv6Prefix Contains the IPv6 prefix (length can be preceded Values: A valid IPv6 Address consists of eight four-digit
by /) to be configured for the user hexadecimal numbers separated by colons and uses the
following format:
For example:
0011:2233:4455:6677:8899:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A Recommendation for IPv6 Address Text
Representation for supported IPv6 Prefix
representations.
(2 of 4)
nasPort Contains the physical port number of the NAS Values:

which is authenticating the user. • ASYNC
• SYNC
• ISDN_SYNC
• ISDN_ASYNC_V120
• ISDN_ASYNC_V110
• VIRTUAL
• PIAFS
• HDLC_CLEAR_CHANNEL
• X25
• X75
• G3_FAX
• SDSL
• ADSL_CAP
• ADSL_DMT
• IDSL
• ETHERNET
• XDSL
• CABLE
• WIRELESS_OTHER
• WIRELESS_IEEE80211
• TOKEN_RING
• FDDI
• WIRELESS_CDMA2000
• WIRELESS_UMTS
• WIRELESS_1XEV
• IAPP
• FTTP
• WIRELESS_802_16
• WIRELESS_802_20
• WIRELESS_802_22
• PPPoA
• PPPoEoA
• PPPoEoE
• PPPoEoVLAN
• PPPoEoQinQ
• xPON
• WIRELESS_XGP
Type: integer
nasPortId Contains the ASCII text identifying the port of the Values: 1 to 255 characters
NAS authenticating the user. Type: string
lastUpdatedTime Displays the timestamp for the last update to the Values: Long values of up to a maximum of
session. 4503599627370495, or 252. You cannot enter 0 or a
negative value.
Type: string
(3 of 4)

NASREQ session.
item —
Defines the custom data used for a single custom
• name
• value
name Values: As defined in the vendor dictionaries, for

A unique vendor name. example: ALUTIMETRA.ALC-Subscriber-Profile-String.
Type: string
value —
• type
• value
type Values:
Type of data held in the vendorSpecificAttributes • STRING
STRING • LIST
IP_ADDRESS
Type: Enum
LIST
• STRING
• IP_ADDRESS

characters.
ENUM
NUMBER
Values: Any whole number between -(263) and 263
-1
DECIMAL
example: 1.0456.
Specific Attribute.
(4 of 4)
6— IP-CAN session API
6.1 Using the IP-CAN session API 6-2
6.2 getSession 6-2
6 — IP-CAN session API
6.1 Using the IP-CAN session API
The IP-CAN session API is used to query information related to IP-CAN sessions.
Session modification is not possible using this API.
6.2 getSession
Gets a fully populated IP-CAN session.
Parameter
Request code

<soapenv:Envelope
n"
xmlns:ses="http://www.alcatellucent.com/dsc/provisioningapi/51/sessi
on">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ses:getSession>

<ses:sessionIdentifier>

<ses:userId>ML2User</ses:userId>

<ses:subscriptionId>
<ses:type>END_USER_IMSI</ses:type>
<ses:value>31012000091</ses:value>
</ses:subscriptionId>

<ses:ipAddress>101.91.38.1</ses:ipAddress>

<ses:ipv6Prefix>3ffe:305:1001:8010:0:0:0:0</ses:ipv6Pref
ix>
</ses:sessionIdentifier>
</ses:getSession>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Default: n/a userId, subscriberId,
ipAddress or ipv6Prefix
to identify the
subscriber.

subscriber.
• type
• value

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
Default: n/a
example, 10.10.10.1.
Type: string
(1 of 2)
format:
For example:
0011:2233:4455:6677:8899
:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
representations.
(2 of 2)
Response code

<env:Header/>
<env:Body>
<getSessionResponse
n"
<ipcanSession>
<sessionId>gxsess2</sessionId>
<userId>unknown_20121123135951318_5</userId>
<ipv6Prefix>3ffe:305:1001:8010:0:0:0:0/64</ipv6Prefix
>
<calledStationId>Apn1</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
<subscriptionId>
<value>nai1@3gppnetwork.com</value>
</subscriptionId>
</subscriptionIds>
<diameterHost>ihuoma.18001.clientRealm.18001</diameterHo
st>
<name>ALU.Diameter-Client-Type</name>
<value>
<type>STRING</type>
<value>Default</value>
</value>
<name>ALU.3GPP-Minor-Version</name>
<value>
<type>STRING</type>
<value>DIAMETER_PEER_DECEMBER_2009</value>
</value>
<name>ALU.Vendor-Type</name>
<value>
<type>NUMBER</type>
<value>3</value>
</value>
<sessionType>LOCAL_SESSION</sessionType>
<ipCanType>TYPE_3GPP_GPRS</ipCanType>
<ratType>UTRAN</ratType>
<ratType3Gpp>UTRAN</ratType3Gpp>
<bearerControlMode>UE_NW</bearerControlMode>
<AuthorizedApnMaximumBitrateDL>0</AuthorizedApnMaximumBi
trateDL>
<AuthorizedApnMaximumBitrateUL>0</AuthorizedApnMaximumBi
trateUL>
<AdjustedApnMaximumBitrateDL>0</AdjustedApnMaximumBitrat
eDL>
<AdjustedApnMaximumBitrateUL>0</AdjustedApnMaximumBitrat
eUL>
<userEquipmentInformation>
<type>IMEISV</type>
<value>353783001668239</value>
</userEquipmentInformation>
<accessNetworkChargingAddress>253.253.253.253</accessNet
workChargingAddress>
<userLocationInformation>
<geographicLocationType>TAI</geographicLocationType>
<UserLocationIdentities>
<UserLocationIdentity>
<identityType>TAI</identityType>
<data>0x00311612002400</data>
</UserLocationIdentity>
</UserLocationIdentities>
</userLocationInformation>
<qosUpgrade>QOS_UPGRADE_NOT_SUPPORTED</qosUpgrade>
<qosNegotiation>QOS_NEGOTIATION_SUPPORTED</qosNegotiatio
n>
<offline>ENABLE_OFFLINE</offline>
<pccRules/>
<sySessionId>tpapps.realm;1353697191;1;SySession</sySess
ionId>
<AFSessions/>
</ipcanSession>
</env:Body>
</env:Envelope>
Response fields
Table 6-2 ipcanSession field descriptions
value.
Type: string
Type: string
sessionBindingIdentifier An identifier used for binding sessions. The identity —

consists of a framed IP address for example, IPv4)
and/or a framed IPv6 prefix and an (optional) APN
or a collection of one or more SubscriptionIds and
an (optional) APN.
Values that have never been set will have a null
value.
Contains the UE IP address that is requesting four integers separated by a dot; for
authentication or reauthentication of the user. example, 10.10.10.1.
Type: string
ipv6Prefix Values: A valid IPv6 Address consists

For example:
0011:2233:4455:6677:8899:aa
b:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
representations.

(1 of 15)
sessionBindingIdentifier (continued) subscriptionIds —

this subscriber.
subscriptionId —
based on:
• type
• value
type Values:
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
Type: string

IP-CAN session.
(2 of 15)
vendorSpecificAttributes vendorSpecificAttribute —
(continued) Defines the vendorSpecificAttribute used for a
• name
• value

ALC-App-Prof-Str.
Type: string
value —
• type
• value
type Values:
STRING • LIST
IP_ADDRESS
Type: Enum
LIST
• STRING
• IP_ADDRESS

characters.
ENUM
NUMBER
DECIMAL
example: 1.0456.
value Values: up to 256, 0000 characters

Specific Attribute.
(3 of 15)
sessionType Specifies whether this session is a local IP-CAN Values:

session or a roaming IP-CAN session. • LOCAL_SESSION
LOCAL_SESSION • ROAMING_SESSION
This is for a local session.
Type: string
ROAMING_SESSION
This is for a roaming session.
ipCanType Indicates the type of CAN in which the user is Values:

connected. • TYPE_3GPP_GPRS
TYPE_3GPP_GPRS • DOCSIS
Indicates that the IP-CAN is associated with a 3GPP • XDSL
GPRS access. For more information, see the • WIMAX
RAT-Type AVP. The RAT-Type AVP includes
applicable 3GPP values, except E-UTRAN.
• TYPE_3GPP2
DOCSIS
• TYPE_3GPP_EPS
• TYPE_NON_3GPP_EPS
Indicates that the IP-CAN is associated with a
DOCSIS access Type: string
XDSL
Indicates that the IP-CAN is associated with an xDSL
access
WIMAX
Indicates that the IP-CAN is associated with a WiMAX
access (IEEE 802.16)
TYPE_3GPP2
Indicates that the IP-CAN is associated with a 3GPP2
access. For more information, see the RAT-Type
AVP
TYPE_3GPP_EPS
Indicates that the IP-CAN is associated with a 3GPP
EPS access. For more information, see the RAT-Type
AVP
TYPE_NON_3GPP_EPS
Indicates that the IP-CAN is associated with an EPC
based non-3GPP access.
(4 of 15)
ratType Identifies the RAT that is serving the UE. The Values:
following values are supported: • WLAN
WLAN • VIRTUAL
The RAT is WLAN. • UTRAN
VIRTUAL • GERAN
The RAT is VIRTUAL. For more information, see • GAN
3GPP TS 29.060 [18]. • HSPA_EVOLUTION
UTRAN • EUTRAN
The RAT is UTRANF. For more information, see 3GPP • CDMA2000_1X
TS 29.060 [18]. • HRPD
GERAN • UMB
The RAT is GERAN. For more information, see 3GPP • EHRPD
TS 29.060 [18].
Type: string
GAN
The RAT is GAN. For more information, see 3GPP TS
29.060 [18].
HSPA_EVOLUTION
The RAT is HSPA Evolution. For more information,
see 3GPP TS 29.060 [18].
EUTRAN
The RAT is E-UTRAN. For more information, see
3GPP TS 29.274 [22].
CDMA2000_1X
The RAT is CDMA2000 1x. For more information, see
3GPP2 X.S0011-D [20].
HRPD
The RAT is HRPD. For more information, see 3GPP2
X.S0011-D [20].
UMB
The RAT is UMB. For more information, see 3GPP2
X.S0011-D [20].
EHRPD
The RAT is eHRPD. For further details refer to
3GPP2 X.S0057 [24].
ratType3Gpp Indicates the RAT that is serving the UE. Values:
• RESERVED
• UTRAN
• GERAN
• WLAN
• GAN
• HSPA_EVOLUTION
Type: string
(5 of 15)
bearerControlMode Sent from the PCRF to the PCEF and indicates the Values:
PCRF selected bearer control mode. • USER_EQUIPMENT_ONLY
USER_EQUIPMENT_ONLY • RESERVED
The UE can request any resource establishment, • UE_NW
modification, or termination.
RESERVED Type: string
This option is not used in this release.
UE_NW
The UE and PCEF can request any resource
establishment, modification, or termination by
adding, modifying, or removing traffic flow
information.
AuthorizedApnMaximumBitrateDL Indicates the maximum aggregate bit rate in bps for Values: Long values of up to a
the downlink direction across all non-GBR bearers maximum of 4503599627370495, or
related with the same APN. 252. You cannot enter 0 or a negative
value.
Type: long
AuthorizedApnMaximumBitrateUL Indicates the maximum aggregate bit rate in bps for Values: Long values of up to a
the uplink direction across all non-GBR bearers maximum of 4503599627370495, or
value.
Type: long
AdjustedApnMaximumBitrateDL Indicates the maximum adjusted bit rate in bps for Values: Long values of up to a
the downlink direction across all non-GBR bearers maximum of 4503599627370495, or
value.
Type: long
AdjustedApnMaximumBitrateUL Indicates the maximum adjusted bit rate in bps for Values: Long values of up to a
the uplink direction across all non-GBR bearers maximum of 4503599627370495, or
value.
Type: long
(6 of 15)
defaultEPSBearerQoS Defines the QoS information for the EPS default —

bearer
defaultBearerQCI Values:
Contains the QCI value for the EPS default bearer. QCI_1
QCI_2
QCI_3
QCI_4
QCI_5
QCI_6
QCI_7
QCI_8
QCI_9
Type: string
Allocation-Retention-Priority —
ARP is a group AVP that consists of three AVPs as
follows:
• priorityLevel
priorityLevel Values: 1 to 15
Ensures that the request for the bearer with the Type: integer
higher priority level is preferred. In addition, the
priority level can be used by the eNodeB to decide
which bearer to drop during exceptional resource
limitations.
preEmptionCapability Values:
Defines whether a bearer with a lower ARP priority • PRE_EMPTION_CAPABILITY_
level should be dropped to free up the required ENABLED
resources. • PRE_EMPTION_CAPABILITY_
DISABLED
Type: string
preEmptionVulnerability Values:
Defines whether a bearer can be dropped by a • PRE_EMPTION_VULNERABILITY_
preemption capable bearer with a higher ARP ENABLED
priority value. • PRE_EMPTION_VULNERABILITY_
DISABLED
Type: string
(7 of 15)
userEquipmentInformation Allows the credit-control client to indicate the —

identity and capability of the terminal that the
subscriber is using for the connection to network.
The equipment type is made up of the following:
• type
• value
type Values:
IMEISV • IMEISV
The identifier contains the International Mobile • MAC
Equipment Identifier and Software Version in the • EUI64
international IMEISV format, according to 3GPP TS • MODIFIED_EUI64
23.003 [3GPPIMEI].
• MEID
MAC
The 48-bit MAC address is formatted, as described Type: string
in [RAD802.1X]. EU-164 The 64-bit identifier is used
to identify the hardware instance of the product, as
defined in [EUI64].
EUI64
The 64-bit identifier is used to identify the
hardware instance of the product, as defined in
[EUI64].
MODIFIED_EUI64
There are a number of types of terminals that have
identifiers other than IMEI, IEEE 802 MACs, or
EUI-64. The identifiers can be converted to
modified EUI-64 format, as described in [IPv6Addr],
or by using another method that is referred to in the
service-specific documentation.
MEID
The MEID contains a globally unique number that
identifies a physical part of CDMA mobile station
equipment. The number format is defined by the
3GPP2 report S.R0048
value Values: Long values of up to a
The value is the type of identifier that is used. maximum of 4503599627370495, or
value.
Type: string
anGWAddressIPV4 Contains the IPv4 address(es) of the access node Values: Long values of up to a
gateway (SGW for 3GPP and AGW for non-3GPP maximum of 4503599627370495, or
networks). 252. You cannot enter 0 or a negative
value.
Type: string
anGWAddressIPV6 Contains the IPv6 address(es) of the access node Values: Long values of up to a
gateway (SGW for 3GPP and AGW for non-3GPP maximum of 4503599627370495, or
networks). 252. You cannot enter 0 or a negative
value.
Type: string
sgsnAddress Identifies the IPv4 address of the SGSN. Values: Long values of up to a
maximum of 4503599627370495, or
value.
Type: string
(8 of 15)
sgsnIpv6Address Identifies the IPv6 address of the SGSN. Values: Long values of up to a
maximum of 4503599627370495, or
value.
Type: string
accessNetworkCharging The IP Address of the network entity within the Values: Long values of up to a
Address access network performing charging (for example, maximum of 4503599627370495, or
the GGSN IP address). 252. You cannot enter 0 or a negative
value.
Type: string
userLocationInformation Indicates the identity of the user location and —

geographic location.
geographicLocationType Values:
The Geographic Location Type conveys the location • CGI
type, for example, Cell Global Identifier (CGI). • SAI
CGI • RAI
Indicates the CGI of where the user is registered. • TAI
CGI is defined in sub-clause 4.3.1 of 3GPP TS 23.003 • ECGI
[2].
• TAI_AND_ECGI
SAI
Indicates the SAI of where the user is registered. SAI Type: string
is defined in sub-clause 9.2.3.9 of 3GPP TS 25.413
[7].
RAI
Indicates the RAI of the SGSN where the UE is
registered. Not applicable for eHRPD or E-UTRAN.
TAI
Indicates the TAI. Applicable for E-UTRAN.
ECGI
Indicates the ECGI*. Applicable for E-UTRAN.
TAI_AND_ECGI
Indicates the TAI_AND_ECGI.
userLocationIdentities —
Contains one or more user-location identities.
userLocationIdentity
The user location identity contains the identity type
and associated data.
(9 of 15)
userLocationInformation (continued) identityType Values:

The identity type contains the following options: • CGI
CGI • SAI
Indicates the CGI of where the user is registered. • RAI
CGI is defined in sub-clause 4.3.1 of 3GPP TS 23.003 • TAI
[2]. • ECGI
SAI
Type: string
Indicates the SAI of where the user is registered. SAI
is defined in sub-clause 9.2.3.9 of 3GPP TS 25.413
[7].
RAI
Indicates the RAI of the SGSN where the UE is
registered. Not applicable for eHRPD or E-UTRAN.
TAI
Indicates the TAI. Applicable for E-UTRAN.
ECGI
Indicates the ECGI*. Applicable for E-UTRAN.
data Values: Long values of up to a

The data option contains the location identity data maximum of 4503599627370495, or
associated with the identity type. 252. You cannot enter 0 or a negative
value.
Type: string
qosUpgrade Indicates whether the SGSN that supports the GGSN Values:
upgrades the QoS in a create PDP context response • QOS_UPGRADE_NOT_SUPPORTED
or an update PDP context response. Valid values
are:
• QOS_UPGRADE_SUPPORTED
QOS_UPGRADE_NOT_SUPPORTED Type: enum

The IP-CAN bearer does not support the upgrade of
the requested QoS. This is the default value if a
QoS-Upgrade AVP is not provided for an IP-CAN
bearer.
QOS_UPGRADE_SUPPORTED
The IP-CAN bearer supports the upgrade of the
requested QoS.
qosNegotiation Indicates the QoS negotiation allowed for the Values:

session. Valid values are: • NO_QOS_NEGOTIATION
NO_QOS_NEGOTIATION • QOS_NEGOTIATION_SUPPORTED
A QoS negotiation is not allowed for the
corresponding PCC rule request. Type: enum
QOS_NEGOTIATION_SUPPORTED
A QoS negotiation is allowed for the corresponding
PCC rule request. This is the default value
applicable if the AVP is not provided.
online Indicates that the online charging interface for the Values:
associated PCC rule is Enabled or Disabled. • DISABLE_ONLINE
• ENABLE_ONLINE
Type: string
offline Indicates that the offline charging interface for the Values:
associated PCC rule is Enabled or Disabled. • DISABLE_OFFLINE
• ENABLE_OFFLINE
Type: string
(10 of 15)
usage Used to collect, format, transfer, and evaluate —

information related to a chargeable event. Usage
data for a subscriber is updated in real-time
automatically and is available after each network
usage report. Usage data is listed per metering
limit.
monitoringKey Values: 1 to 80 characters

Indicates the name of the monitoring key. Type: string
appliedThreshold Values: Long values of up to a

Identifies the last metering limit threshold that was maximum of 4503599627370495, or
exceeded and processed. 252. You cannot enter 0 or a negative
value.
Type: double
pccRules Contains zero or more PCC rules. —
pccRule Values: 1 to 80 characters

Defines the IP flow by filter definitions, the QoS, Type: string
and the charging treatment.
ruleName Values: 1 to 80 characters

The name for the rule. Type: string
AfChargingID Values: 1 to 255 characters

Contains the AF Charging Identifier that is sent by Type: string
the AF. This information may be used for charging
correlation with bearer layer
ratingGroup Values: integer

All of the services that are subject to the same
rating type are part of the same rating group.
(11 of 15)
pccRules (continued) pccRuleType Values:

Indicates the type of rule. • GENERATED
GENERATED • PROVISIONED
Dynamic 5780 DSC system-generated PCC rule. • PREDEFINED
PROVISIONED • PREDEFINED_BASE
User-configured provisioned Charging/QoS rule. • PROVISIONED_TEMPLATE
PREDEFINED
• PREDEFINED_TEMPLATE
• PREDEFINED_BASE_TEMPLATE
User-specified Predefined PCC Rule.
PREDEFINED_BASE Type: string
User-specified Predefined Base Rule Template for
the charging rule base name.
PROVISIONED_TEMPLATE
Allows you to configure the provisioned
Charging/QoS rule. You must configure the QCI and
Priority Level parameters for a provisioned rule of
Type: Provisioned Template.
PREDEFINED_TEMPLATE
Allows you to configure the Predefined Pcc Rule.
For the Predefined template, only Rule Activation
Date and Time and Rule Deactivation Date and Time
are applicable.
PREDEFINED_BASE
User-specified Predefined Base Rule Template for
the charging rule base name.
PREDEFINED_BASE_TEMPLATE
Allows you to configure the Predefined Base Rule
Template for the charging rule base name. For the
Predefined template, only Rule Activation Date and
Time and Rule Deactivation Date and Time are
applicable.
flowStatus Values:
Flow status specifies whether the IP flows are • ENABLED_UPLINK
enabled. • ENABLED_DOWNLINK
ENABLED_UPLINK • ENABLED
Enables associated uplink IP flows and disables • DISABLED
associated downlink IP flows • REMOVED
ENABLED_DOWNLINK
Type: string
Enables associated downlink IP flows and disables
associated uplink IP flows
ENABLED
Enables all associated IP flows in both directions
DISABLED
Disables all associated IP flows in both directions
REMOVED
Removes all associated IP flows and the IP filters for
the associated IP flows. The associated IP
(12 of 15)
pccRules (continued) FinalUnitAction Values:

Flow status specifies whether the IP flows are • TERMINATE
enabled. • REDIRECT
TERMINATE • RESTRICT_ACCESS
The credit-control client must terminate the
service session. Type: string
This is the default handling that applies if the
credit-control client receives a Final-Unit-Action
value that is not supported and must be supported
by all of the Diameter credit-control client
implementations that conform to this specification.
REDIRECT
The service element must redirect the user to the
address specified in the Redirect-Server-Address
AVP.
RESTRICT_ACCESS
Indicates that the access device must restrict the
user access according to the IP packet filters
defined in the Restriction-Filter-Rule AVP or
according to the IP packet filters identified by the
Filter-Id AVP. Packets that do not match the filters
must be dropped.
reportingLevel Values:
Defines on what level the 5780 DSC reports the • SERVICE_IDENTIFIER_LEVEL
usage for the related PCC rule. • RATING_GROUP_LEVEL
RATING_GROUP_LEVEL
Type: string
Indicates that the usage is reported on rating group
level.
SERVICE_IDENTIFIER_LEVEL
Indicates that the usage is reported on service id
and rating group combination level.
online Values:
A subscriber account is queried before permission to • DISABLE_ONLINE
use the requested network resources is granted. • ENABLE_ONLINE
DISABLE_ONLINE
Type: string
Indicates that the online charging interface for the
associated PCC rule is Disabled.
ENABLE_ONLINE
Indicates that the online charging interface for the
associated PCC rule is Enabled.
offline Values:
The resource usage is reported from the network to • DISABLE_OFFLINE
the billing domain after the resource usage • ENABLE_OFFLINE
occurred.
DISABLE_OFFLINE Type: string
Indicates that the offline charging interface for the
associated PCC rule is Disabled.
ENABLE_OFFLINE
Indicates that the offline charging interface for the
associated PCC rule is Enabled.
(13 of 15)
pccRules (continued) meteringMethod Values:

Defines the parameters that are metered for offline • DURATION
charging. • VOLUME
The duration of the service flow is metered.
Type: string
VOLUME
DURATION_VOLUME
The duration and the volume of the service flow
traffic are metered.
serviceId Values: Unsigned32

The service identifier is used to identify the service Type: integer
or the service component to which the service data
flow relates.
serviceFlows Values: A collection of service flow

Select the traffic for which the rule applies. identities (afsessionId,
mediaComponentNumber,
flowNumber and finalUnitAction)
Type: string
monitoringKey Values: 1 to 80 characters.

activationTime Values: Long values of up to a

Indicates the NTP time at which the PCC rule has to maximum of 4503599627370495, or
be enforced. The activation time must be later than 252. You cannot enter 0 or a negative
the current system time. value.
Type: long
deactivationTime Values: Long values of up to a

Indicates the NTP time at which the PCEF has to maximum of 4503599627370495, or
stop enforcing the PCC rule. The deactivation time 252. You cannot enter 0 or a negative
must be later than the current system time. value.
Type: long
lastAppliedThreshold Values: Any percentage value

Identifies the last metering threshold (for a PCC indicating the thresholds specified
Rule-level Monitoring key) that was exceeded and in the provisioned metering limits
processed by the DYNAMIC_RULE_CREATION rules. Type: integer
bearerUsage Values:
The bearer usage indicates how the bearer is used. • GENERAL
If bearer usage has not been previously provided, its • IMS_SIGNALLING
absence indicates that specific information is not
available. Type: string
If bearer usage is provided, the value is valid until
the next time a value is provided. The AVP is used
for GPRS and EPS access types.
GENERAL
Specific bearer usage information is not available.
IMS_SIGNALLING
The bearer is used for IMS signaling only.
(14 of 15)
afSessions afSessionId Values: 1 to 255 characters

A unique string identifier used to define the AF Type: string
session.
sySessionId Values: 1 to 255 characters

A unique string identifier used to define the Sy Type: string
session.
(15 of 15)
Gets a shortened summary of the IP-CAN session.
Parameter
Request code

<soapenv:Envelope
n"
on">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ses:getSessionSummary>


<ses:userId>ML2User</ses:userId>



<ses:ipv6Prefix>3ffe:305:1001:8010:0:0:0:0</ses:ipv6Pref
ix>
</ses:getSessionSummary>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Type: string
Default: n/a
subscriptionId The subscriptionId identifies the subscription based on a valid Default: n/a Optional
• type
• value

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
Default: n/a
example, 10.10.10.1.
Type: string
(1 of 2)
hexadecimal numbers
separated by colons and uses
the following format:
For example:
0011:2233:4455:6677:889
9:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
Address Text Representation
representations.
(2 of 2)
Response code

<env:Header/>
<env:Body>
n"
<ipcanSessionSummary>
<userId>ML2User</userId>
<ipv6Prefix>3ffe:305:1001:8010:0:0:0:0/64</ipv6Prefix
>
<calledStationId>Apn1</calledStationId>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
</subscriptionIds>
<AuthorizedApnMaximumBitrateDL>0</AuthorizedApnMaximumBi
trateDL>
<AuthorizedApnMaximumBitrateUL>0</AuthorizedApnMaximumBi
trateUL>
<AdjustedApnMaximumBitrateDL>0</AdjustedApnMaximumBitrat
eDL>
<AdjustedApnMaximumBitrateUL>0</AdjustedApnMaximumBitrat
eUL>
<pccRuleNames>
<ruleName>ggsn_gold</ruleName>
</pccRuleNames>
<name>ALU.Diameter-Client-Type</name>
<value>
<type>STRING</type>
<value>Default</value>
</value>
<name>ALU.Vendor-Type</name>
<value>
<type>NUMBER</type>
<value>3</value>
</value>
<name>ALU.3GPP-Minor-Version</name>
<value>
<type>STRING</type>
<value>DIAMETER_PEER_DECEMBER_2009</value>
</value>
</ipcanSessionSummary>
</env:Body>
</env:Envelope>
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of session. Type: string
Type: string
(1 of 5)
sessionBindingIdentifier An identifier used for binding sessions. The identity consists of —

a framed IP address for example, IPv4) and/or a framed IPv6
prefix and an (optional) APN or a collection of one or more
SubscriptionIds and an (optional) APN.
Values that have never been set will have a null value.
ipAddress Values: A valid IP address consists

Contains the UE IP address that is requesting authentication or of four integers separated by a
reauthentication of the user. dot; for example, 10.10.10.1.
Type: string
ipv6Prefix Values: A valid IPv6 Address

Contains the IPv6 prefix (length can be preceded by /) to be consists of eight four-digit
configured for the user hexadecimal numbers separated
format:
For example:
0011:2233:4455:6677:8899:
aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A Recommendation
for IPv6 Address Text
Representation for supported IPv6
Prefix representations.
calledStationId Values: 1 to 255 characters
subscriptionId —
subscriber.
• type
• value
type Values:
Type: enum
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 5)
sessionBindingIdentifier (continued) value Values: Valid values as allowed by

Type: string
AuthorizedApnMaximumBitrateDL Indicates the maximum aggregate bit rate in bps for the Values: Long values of up to a
downlink direction across all non-GBR bearers related with the maximum of 4503599627370495,
same APN. or 252. You cannot enter 0 or a
negative value.
Type: long
AuthorizedApnMaximumBitrateUL Indicates the maximum aggregate bit rate in bps for the uplink Values: Long values of up to a
direction across all non-GBR bearers related with the same maximum of 4503599627370495,
APN. or 252. You cannot enter 0 or a
negative value.
Type: long
AdjustedApnMaximumBitrateDL Indicates the maximum adjusted bit rate in bps for the Values: Long values of up to a
downlink direction across all non-GBR bearers related with the maximum of 4503599627370495,
same APN. or 252. You cannot enter 0 or a
negative value.
Type: long
AdjustedApnMaximumBitrateUL Indicates the maximum adjusted bit rate in bps for the uplink Values: Long values of up to a
direction across all non-GBR bearers related with the same maximum of 4503599627370495,
APN. or 252. You cannot enter 0 or a
negative value.
Type: long
defaultEPSBearerQoS Defines the QoS information for the EPS default bearer —
QCI_2
QCI_3
QCI_4
QCI_5
QCI_6
QCI_7
QCI_8
QCI_9
Type: string
ARP is a group AVP that consists of three AVPs as follows:
• priorityLevel
Ensures that the request for the bearer with the higher priority Type: integer
level is preferred. In addition, the priority level can be used by
the eNodeB to decide which bearer to drop during exceptional
(3 of 5)
defaultEPSBearerQoS (continued) preEmptionCapability Values:

Defines whether a bearer with a lower ARP priority level should • PRE_EMPTION_CAPABILITY_
be dropped to free up the required resources. ENABLED
• PRE_EMPTION_CAPABILITY_
DISABLED
Type: string
Defines whether a bearer can be dropped by a preemption • PRE_EMPTION_VULNERABILITY_
capable bearer with a higher ARP priority value. ENABLED
• PRE_EMPTION_VULNERABILITY_
DISABLED
Type: string
lastUpdatedTime Displays the timestamp for the last update to the session. Values: Long values of up to a
maximum of 4503599627370495,
negative value.
Type: string
pccRuleNames Contains a list of zero or more PCC rules. —
pccRuleName Values: 1 to 80 characters

Contains the name of the PCC rule. Type: string
vendorSpecificAttributes The Vendor Specific Attributes associated with the IP-CAN —
session.
Defines the vendorSpecificAttribute used for a single entry
based on:
• name
• value

ALC-App-Prof-Str.
Type: string
value —
• type
• value
(4 of 5)

(continued) Type of data held in the vendorSpecificAttributes item. • STRING
STRING • IP_ADDRESS
Contains a text string of the exact value that you require for • LIST
the action. • ENUM
Values: Up to 256000 characters • NUMBER
IP_ADDRESS • DECIMAL
Contains a single IP address in any of the accepted formats for Type: Enum
an IP address.
LIST
• STRING
• IP_ADDRESS
Values: The encoded value must be under 256,000 characters.

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
value Values: up to 256, 0000 characters

The data type value configured for the Vendor Specific Type: string
Attribute.
(5 of 5)
7— AF session API
7.1 Using the AF session API 7-2
7.2 getSession 7-2
7 — AF session API
7.1 Using the AF session API
The AF session API is used to query information related to AF sessions. Session

modification is not possible using this API.
7.2 getSession
Gets a fully populated AF session.
Parameter
Request code

<soapenv:Envelope
n"
on">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ses:getSession>


<ses:userId>subscriberId</ses:userId>

<ses:type>END_USER_NAI</ses:type>
<ses:value>a@a.com</ses:value>


<ses:ipv6Prefix>1:2:3:4:5:6:7:8</ses:ipv6Prefix>
</ses:getSession>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Default: n/a userId, subscriberId,
ipAddress or ipv6Prefix
to identify the
subscriber.

subscriber.
• type
• value

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
Default: n/a
example, 10.10.10.1.
Type: string
(1 of 2)
configured for the user. consists of eight four-digit
format:
For example:
0011:2233:4455:6677:8899
:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
representations.
(2 of 2)
Response code

<env:Header/>
<env:Body>
<getSessionResponse
n"
<afSession>
<sessionId>afsess1</sessionId>
<userId>testSub1</userId>
<ipv6Prefix>2001:db8:85a3:0:0:8a2e:373:7331/128</ipv6
Prefix>
<subscriptionIds>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
</subscriptionIds>
<diameterHost>dsc67.18002.clientRealm.18002</diameterHos
t>
<vendorSpecificAttributes/>
<afApplicationId>application_1</afApplicationId>
<afChargingId>13823</afChargingId>
<serviceInfoStatus>FINAL_SERVICE_INFORMATION</serviceInf
oStatus>
<reservationPriority>0</reservationPriority>
<serviceURN>sos.fire</serviceURN>
<sipForkingIndication>SINGLE_DIALOGUE</sipForkingIndicat
ion>
<specificActions>
<specificAction>CHARGING_CORRELATION_EXCHANGE</specif
icAction>
</specificActions>
<ipCanSessionId>gxsess1</ipCanSessionId>
<serviceFlows>
<serviceFlow>
<mediaType>VIDEO</mediaType>
<mediaComponentNumber>1</mediaComponentNumber>
<flowStatus>ENABLED</flowStatus>
<codecData1>uplink\/noffer\/nm=audio 99999 RTP/AVP
0</codecData1>
<codecData2>downlink\/nanswer\/nm=audio 9999
RTP/AVP 0</codecData2>
<maxRequestedBandwidthDL>1000</maxRequestedBandwid
thDL>
<maxRequestedBandwidthUL>1000</maxRequestedBandwid
thUL>
<subComponentFlowDescriptions>
<subComponentFlowDescription>
<flowNumber>2</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit out ip from 8.8.8.12
to 2001:db8:85a3:0:0:8a2e:373:7331</flowDescription1>
<flowDescription2>permit in ip from
2001:db8:85a3:0:0:8a2e:373:7331 to 8.8.8.12</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afSign
allingProtocol>
</subComponentFlowDescription>
allingProtocol>
</subComponentFlowDescriptions>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
<anChargingIds>
<chargingId>
<anChargingIdValue>ANCIValue</anChargingIdValue>
<serviceFlows>
<serviceFlow>
<afSessionId>afsess1</afSessionId>
<mediaComponentNumber>1</mediaComponentNumbe
r>
</serviceFlow>
<serviceFlow>
<afSessionId>afsess1</afSessionId>
<mediaComponentNumber>1</mediaComponentNumbe
r>
</serviceFlow>
</serviceFlows>
</chargingId>
</anChargingIds>
</afSession>
<afSession>
<subscriptionIds>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
</subscriptionIds>
<diameterHost>dsc67.18002.clientRealm.18002</diameterHos
t>
<afChargingId>21586</afChargingId>
<serviceInfoStatus>FINAL_SERVICE_INFORMATION</serviceInf
oStatus>
<serviceURN>sos.fire</serviceURN>
<sipForkingIndication>SEVERAL_DIALOGUES</sipForkingIndic
ation>
<specificActions>
<specificAction>INDICATION_OF_LOSS_OF_BEARER</specifi
cAction>
<specificAction>INDICATION_OF_RELEASE_OF_BEARER</spec
ificAction>
<specificAction>CHARGING_CORRELATION_EXCHANGE</specif
icAction>
</specificActions>
<serviceFlows>
<serviceFlow>
<codecData1>uplink\/noffer\/nm=audio 99999 RTP/AVP
0</codecData1>
thDL>
thUL>
to 111.111.11.1</flowDescription1>
111.111.11.1 to 8.8.8.11</flowDescription2>
allingProtocol>
</serviceFlow>
</serviceFlows>
<anChargingIds/>
</afSession>
</env:Body>
</env:Envelope>
Response fields
Table 7-2 afSession field descriptions

lastUpdatedTime Displays the timestamp for the last update to the Values: Long values of up to a maximum of
session. 4503599627370495, or 252. You cannot enter 0 or a negative
value.
Type: string
Type: string

an (optional) APN.
value.
(1 of 10)
sessionBindingIdentifier ipAddress Values: A valid IP address consists of four integers separated

(continued) Contains the UE IP address that is requesting by a dot; for example, 10.10.10.1.
authentication or reauthentication of the user. Type: string
ipv6Prefix Values: A valid IPv6 Address consists of eight four-digit

Contains the IPv6 prefix (length can be preceded by hexadecimal numbers separated by colons and uses the
/) to be configured for the user following format:
For example:
0011:2233:4455:6677:8899:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A Recommendation for IPv6 Address Text
Representation for supported IPv6 Prefix representations.
subscriptionIds —
this subscriber.
subscriptionId —
based on:
• type
• value
(2 of 10)
sessionBindingIdentifier type Values:

(continued) The type of identifier that is carried by the • END_USER_E164
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
value Values: Valid values as allowed by the type; for example,

The identifier of the subscription. sip:9251234567@example.com.
Type: string
Type: string
vendorSpecificAttributes The Vendor Specific Attributes associated with the Values: Attribute value pairs as defined by the vendor.
AF session. Type: string
• name
• value
name Values: As defined in the vendor dictionaries, for example:
A unique vendor name. ALC-App-Prof-Str.
Type: string
value —
• type
• value
(3 of 10)

(continued) Type of data held in the vendorSpecificAttributes • STRING
STRING • LIST
IP_ADDRESS
Type: Enum
LIST
• STRING
• IP_ADDRESS

characters.
ENUM
NUMBER
DECIMAL
example: 1.0456.

Specific Attribute.
afApplicationId Indicates the interfaces that the PCRF supports for Values:
the authentication and authorization portion of the • 1 and 255 characters (ASCII)
application.
The value must be the same as the value in the
AF-Application-Identifier AVP that is received Type: string
during the AF creation of a PCC rule.
afChargingId Contains the AF Charging Identifier that is sent by Values: 1 to 255 characters
the AF. This information may be used for charging Type: string
correlation with bearer layer
serviceInfoStatus Indicates the status of the service information that Values:

the AF provides to the PCRF. • FINAL_SERVICE_INFORMATION
• PRELIMINARY_SERVICE_INFORMATION
Type: tns:ServiceInfoStatus
reservationPriority Provides the relative priority for a session. Values: 1 to 15

Type: integer
(4 of 10)
serviceURN Indicates that an AF Session is used for emergency Values: 1 to 255 characters long
traffic; for example, sos.fire. Type: string
sipForkingIndication Describes if several SIP dialogues are related to one Values:

Diameter session. • SINGLE_DIALOGUE
• SEVERAL_DIALOGUES
Type: tns:SIPForkingIndication
specificActions The type of action to perform. —
specificAction Values:
Determines the type of the action to be performed • SERVICE_INFORMATION_REQUEST
in a PCRF-initiated Reauthorization Request. • CHARGING_CORRELATION_EXCHANGE
In an initial AA request, the AF may request the • INDICATION_OF_LOSS_OF_BEARER
specific actions from the server at the bearer • INDICATION_OF_RECOVERY_OF_BEARER
events and limit the contact to the bearer events
that require the specific action. If the
• INDICATION_OF_RELEASE_OF_BEARER
Specific-Action AVP is omitted in the initial AA • INDICATION_OF_ESTABLISHMENT_OF_BEARER
request, notification of any of the events is not • IP_CAN_CHANGE
requested. • INDICATION_OF_OUT_OF_CREDIT
• INDICATION_OF_SUCCESSFUL_RESOURCES_ALLOCATION
• INDICATION_OF_FAILED_RESOURCES_ALLOCATION
• INDICATION_OF_LIMITED_PCC_DEPLOYMENT
• USAGE_REPORT
Type: string
ipCanSessionId The type of connectivity access network to which Values: valid session id
the user is connected. Type: string
serviceflows Select the traffic for which the rule applies. —

serviceFlow Values: A collection of service flow identities (afsessionId,
Select the traffic for which the rule applies. mediaComponentNumber, flowNumber and finalUnitAction)
Type: string
mediaType Values:
Determines the media type of a session component. • AUDIO
• VIDEO
• DATA
• APPLICATION
• CONTROL
• TEXT
• MESSAGE
• OTHER
Type: enum
mediaComponentNumber Values: any unsigned 32 bit number

Contains the ordinal number of the media Type: integer
component.
(5 of 10)
serviceflows (continued) flowStatus Values:

ENABLED_DOWNLINK
Type: string
ENABLED
DISABLED
REMOVED
FinalUnitAction Values:
Flow status specifies whether the IP flows are • TERMINATE
enabled. • REDIRECT
TERMINATE • RESTRICT_ACCESS
The credit-control client must terminate the
service session. Type: string
This is the default handling that applies if the
credit-control client receives a Final-Unit-Action
value that is not supported and must be supported
by all of the Diameter credit-control client
implementations that conform to this specification.
REDIRECT
The service element must redirect the user to the
address specified in the Redirect-Server-Address
AVP.
RESTRICT_ACCESS
Indicates that the access device must restrict the
user access according to the IP packet filters
defined in the Restriction-Filter-Rule AVP or
according to the IP packet filters identified by the
Filter-Id AVP. Packets that do not match the filters
must be dropped.
afApplicationId Values:
Indicates the interfaces that the PCRF supports for • 1 and 255 characters (ASCII)
the authentication and authorization portion of the • 1 and 510 characters (Hexadecimal)
application.
The value must be the same as the value in the Type: string
AF-Application-Identifier AVP that is received
codecData1 Values: any string of length 1 – 1024 (inclusive)

Used to look at media types to determine the QCI to Type: string
assign for the PCC rule.
codecData2 Values: any string of length 1 – 1024 (inclusive)

Used to look at media types to determine the QCI to Type: string
assign for the PCC rule.
(6 of 10)
serviceflows (continued) maxRequestedBandwidthDL Values: Long values of up to a maximum of

Indicates the maximum bandwidth, in bits per 4503599627370495, or 252. You cannot enter 0 or a negative
second, for a downlink service data flow. value.
Type: long
maxRequestedBandwidthDlSource Values:
The source of the requested maximum bit rate • REQUEST
downlink bandwidth. • PDF
Type: string
maxRequestedBandwidthUL Values: Long values of up to a maximum of
Indicates the maximum bit rate, in bits per second, 4503599627370495, or 252. You cannot enter 0 or a negative
for an uplink service data flow. value.
Type: long
maxRequestedBandwidthUlSource Values:
The source of the requested maximum bit rate • REQUEST
uplink bandwidth. • PDF
Type: string
subComponentFlowDescriptions —
SubComponentFlowDescriptions consists of:
• flowNumber
• flowUsage
• flowStatus
• flowDescription1
• afSignallingProtocol
flowNumber Values: Long values of up to a maximum of

Contains the ordinal number of the IP flows at the 4503599627370495, or 252. You cannot enter 0 or a negative
Media-Sub-Component-Flow-Description level. value.
Type: double
flowUsage Values:
Provides information about the usage of IP Flows • NO_INFORMATION
• RTCP
• AF_SIGNALLING
Type: enum
(7 of 10)
serviceflows (continued) flowStatus Values:

ENABLED_DOWNLINK
Type: string
ENABLED
DISABLED
REMOVED
flowDescription1 Values: 0 to 255 characters

The Flow Description contains the actual filter Type: string
information used by the PCEF to identify the service
data flow.

The Flow Description contains the actual filter Type: string
information used by the PCEF to identify the service
data flow.
afSignallingProtocol Values:
Indicates the protocol used for signalling between • NO_INFORMATION
the UE and the AF. If the AF-Signalling-Protocol AVP • SIP
is not provided in the AA-Request, the value
NO_INFORMATION is assumed. Type: string
reservationPriority Values: 1 to 15
Provides the relative priority for a session. Type: integer
rrBandwidth Values: Long values of up to a maximum of

Indicates the maximum required bandwidth in bits 4503599627370495, or 252. You cannot enter 0 or a negative
per second for RTCP receiver reports in the session value.
component at the Media-Component-Description Type: long
level.
rsBandwidth Values: Long values of up to a maximum of

indicates the maximum required bandwidth in bits 4503599627370495, or 252. You cannot enter 0 or a negative
per second for RTCP sender reports in the session value.
component at the Media-Component-Description Type: long
level
(8 of 10)
anChargingIds The IP address of the network entity within the —

access network that performs the charging
function.
ChargingId Values: A set of access network charging id which consist of

The IP address of the network entity within the a anChargingIdValue and a set of serviceFlows
access network that performs the charging Type: accessNetworkChargingId
function.
anChargingIdValue Values: 1 to 255 characters

The value of the access network charging identifier Type: string
(for example,GCID).
serviceflows —
Select the traffic for which the rule applies.
serviceFlow Values: A collection of service flow identities (afsessionId,

Select the traffic for which the rule applies. mediaComponentNumber, flowNumber and finalUnitAction)
Type: string
afSessionId Values: valid session id

Indicates the unique number that the server assigns Type: string
to a user for the duration of the AF session.

component.
flowNumber Values: Long values of up to a maximum of
Contains the ordinal number of the IP flows at the 4503599627370495, or 252. You cannot enter 0 or a negative
Media-Sub-Component-Flow-Description level. value.
Type: double
mediaType Values:
• VIDEO
• DATA
• APPLICATION
• CONTROL
• TEXT
• MESSAGE
• OTHER
Type: enum
component.
(9 of 10)
anChargingIds (continued) flowStatus Values:

ENABLED_DOWNLINK
Type: string
ENABLED
DISABLED
REMOVED
Indicates the interfaces that the PCRF supports for • 1 and 255 characters (ASCII)
the authentication and authorization portion of the • 1 and 510 characters (Hexadecimal)
application.
The value must be the same as the value in the Type: string
AF-Application-Identifier AVP that is received
(10 of 10)
Gets a shortened summary of the AF session.
Parameter
Request code

<soapenv:Envelope
n"
on">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ses:getSessionSummary>



<ses:type>END_USER_NAI</ses:type>
<ses:value>a@a.com</ses:value>


<ses:ipv6Prefix>1:2:3:4:5:6:7:8</ses:ipv6Prefix>
</ses:getSessionSummary>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Type: string
Default: n/a
(1 of 2)
subscriptionId The subscriptionId identifies the subscription based on a valid Default: n/a Optional
• value
• type

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
Type: string
Default: n/a
example, 10.10.10.1.
Type: string
hexadecimal numbers
separated by colons and uses
the following format:
For example:
0011:2233:4455:6677:889
9:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A
Address Text Representation
representations.
(2 of 2)
Response code

<env:Header/>
<env:Body>
n"
<afSessionSummary>
<ipv6Prefix>2001:db8:85a3:0:0:8a2e:373:7331/128</ipv6
Prefix>
<calledStationId>test_apn</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
<serviceFlows>
<serviceFlow>
<codecData1>uplink r nnoffer r nm=audio 15000 RTP
AVP 0</codecData1>
<codecData2>downlink r nanswer r nm=audio 5000 RTP
AVP 0</codecData2>
thDL>
thUL>
allingProtocol>
allingProtocol>
</serviceFlow>
</serviceFlows>
<name>DSLForum.Agent-Remote-Id</name>
<value>
<type>STRING</type>
<value>TEST_AGENT_REMOTE_ID</value>
</value>
<name>ALU.SAP-Id</name>
<value>
<type>STRING</type>
<value>TEST_SAP_ID</value>
</value>
</afSessionSummary>
<afSessionSummary>
<ipv6Prefix>2001:db8:32c5:0:0:0:0:52b3/128</ipv6Prefi
x>
<subscriptionIds>
<subscriptionId>
<type>END_USER_E164</type>
</subscriptionId>
</subscriptionIds>
<serviceFlows>
<serviceFlow>
<flowStatus>ENABLED_DOWNLINK</flowStatus>
<codecData1>uplink r nnoffer r nm=audio 18000 RTP

AVP 0 r n</codecData1>
<codecData2>downlink r nanswer r nm=audio 8000 RTP
AVP 0 r n</codecData2>
<maxRequestedBandwidthDL>130</maxRequestedBandwidt
hDL>
<maxRequestedBandwidthUL>128</maxRequestedBandwidt
hUL>
<flowUsage>RTCP</flowUsage>
<flowStatus>REMOVED</flowStatus>
<flowDescription2>permit out ip from
allingProtocol>
allingProtocol>
</serviceFlow>
<serviceFlow>
<mediaType>APPLICATION</mediaType>
<codecData1>uplink noffer nm=audio 19000 RTP AVP
0</codecData1>
<codecData2>downlink nanswer nm=audio 9000 RTP AVP
0</codecData2>
<maxRequestedBandwidthDL>230</maxRequestedBandwidt
hDL>
<maxRequestedBandwidthUL>228</maxRequestedBandwidt
hUL>
allingProtocol>
allingProtocol>
</serviceFlow>
</serviceFlows>
<name>DSLForum.Agent-Remote-Id</name>
<value>
<type>STRING</type>
<value>TEST_AGENT_REMOTE_ID</value>
</value>
<name>ALU.SAP-Id</name>
<value>
<type>STRING</type>
<value>TEST_SAP_ID</value>
</value>
</afSessionSummary>
</env:Body>
</env:Envelope>
Type: string
(1 of 8)
sessionBindingIdentifier An identifier used for binding sessions. The identity consists —

of a framed IP address for example, IPv4) and/or a framed
IPv6 prefix and an (optional) APN or a collection of one or
more SubscriptionIds and an (optional) APN.
Values that have never been set will have a null value.
ipAddress Values: A valid IP address consists

Contains the UE IP address that is requesting authentication of four integers separated by a
or reauthentication of the user. dot; for example, 10.10.10.1.
Type: string
ipv6Prefix Values: A valid IPv6 Address

Contains the IPv6 prefix (length can be preceded by /) to be consists of eight four-digit
configured for the user hexadecimal numbers separated
format:
For example:
0011:2233:4455:6677:8899:
aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
See RFC 5952 A Recommendation
for IPv6 Address Text
Representation for supported IPv6
Prefix representations.
subscriptionIds
Contains a list of subscription ids associated with this
subscriber.
When using subscriberId as an input parameter to identify
the session to be retrieved, only this subscription Id is
returned (not all subscription Ids associated with this
subscriber).
subscriptionId —
The subscriptionId identifies the subscription based on a
valid subscriptionId type.
subscriber.
network messages to the subscriber object. The
subscriptionId must exactly match the E164 or IMSI expected
in the message.
• value
• type
(2 of 8)
sessionBindingIdentifier type Values:

(continued) The type of identifier that is carried by the associated value. • END_USER_E164
International E.164 format (for example, MSISDN), according • END_USER_SIP_URI
to the ITU-T E.164 numbering plan defined in [E164] and • END_USER_NAI
[CE164]. • END_USER_PRIVATE
END_USER_IMSI
Type: enum
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
defaultEPSBearerQoS Defines the QoS information for the EPS default bearer —
QCI_2
QCI_3
QCI_4
QCI_5
QCI_6
QCI_7
QCI_8
QCI_9
Type: string
• priorityLevel
Ensures that the request for the bearer with the higher Type: integer
priority level is preferred. In addition, the priority level can
be used by the eNodeB to decide which bearer to drop during
exceptional resource limitations.
Defines whether a bearer with a lower ARP priority level • PRE_EMPTION_CAPABILITY_
should be dropped to free up the required resources. ENABLED
DISABLED
Type: string
(3 of 8)
defaultEPSBearerQoS preEmptionVulnerability Values:

(continued) Defines whether a bearer can be dropped by a preemption • PRE_EMPTION_VULNERABILITY_
DISABLED
Type: string
lastUpdatedTime Displays the timestamp for the last update to the session. Values: Long values of up to a
maximum of 4503599627370495,
negative value.
Type: string
serviceFlow Values: A collection of service flow

mediaComponentNumber,
flowNumber and finalUnitAction)
Type: string
mediaType Values:
• VIDEO
• DATA
• APPLICATION
• CONTROL
• TEXT
• MESSAGE
• OTHER
Type: enum
mediaComponentNumber Values: any unsigned 32 bit
Contains the ordinal number of the media component. number
Type: integer
flowStatus Values:
Flow status specifies whether the IP flows are enabled. • ENABLED_UPLINK
ENABLED_UPLINK • ENABLED_DOWNLINK
Enables associated uplink IP flows and disables associated • ENABLED
downlink IP flows • DISABLED
ENABLED_DOWNLINK • REMOVED
Enables associated downlink IP flows and disables associated
Type: string
uplink IP flows
ENABLED
DISABLED
REMOVED
Removes all associated IP flows and the IP filters for the
associated IP flows. The associated IP
(4 of 8)
serviceflows (continued) FinalUnitAction Values:

Flow status specifies whether the IP flows are enabled. • TERMINATE
TERMINATE • REDIRECT
The credit-control client must terminate the service session. • RESTRICT_ACCESS
This is the default handling that applies if the credit-control Type: string
client receives a Final-Unit-Action value that is not
supported and must be supported by all of the Diameter
credit-control client implementations that conform to this
specification.
REDIRECT
The service element must redirect the user to the address
specified in the Redirect-Server-Address AVP.
RESTRICT_ACCESS
Indicates that the access device must restrict the user access
according to the IP packet filters defined in the
Restriction-Filter-Rule AVP or according to the IP packet
filters identified by the Filter-Id AVP. Packets that do not
match the filters must be dropped.
Indicates the interfaces that the PCRF supports for the • 1 and 255 characters (ASCII)
authentication and authorization portion of the application. • 1 and 510 characters
The value must be the same as the value in the (Hexadecimal)
AF-Application-Identifier AVP that is received during the AF
creation of a PCC rule. Type: string
codecData1 Values: any string of length 1 –

Used to look at media types to determine the QCI to assign 1024 (inclusive)
for the PCC rule. Type: string
codecData2 Values: any string of length 1 –

Used to look at media types to determine the QCI to assign 1024 (inclusive)
for the PCC rule. Type: string
maxRequestedBandwidthDL Values: Long values of up to a

Indicates the maximum bandwidth, in bits per second, for a maximum of 4503599627370495,
downlink service data flow. or 252. You cannot enter 0 or a
negative value.
Type: long
maxRequestedBandwidthDlSource Values:
The source of the requested maximum bit rate downlink • REQUEST
bandwidth. • PDF
Type: string
maxRequestedBandwidthUL Values: Long values of up to a

Indicates the maximum bit rate, in bits per second, for an maximum of 4503599627370495,
uplink service data flow. or 252. You cannot enter 0 or a
negative value.
Type: long
The source of the requested maximum bit rate uplink • REQUEST
bandwidth. • PDF
Type: string
(5 of 8)
serviceflows (continued) subComponentFlowDescriptions —

• flowNumber
• flowUsage
• flowStatus
flowNumber Values: Long values of up to a

Contains the ordinal number of the IP flows at the maximum of 4503599627370495,
Media-Sub-Component-Flow-Description level. or 252. You cannot enter 0 or a
negative value.
Type: double
flowUsage Values:
• RTCP
• AF_SIGNALLING
Type: enum
flowStatus Values:
Type: string
uplink IP flows
ENABLED
DISABLED
REMOVED

The Flow Description contains the actual filter information Type: string
used by the PCEF to identify the service data flow.

Indicates the protocol used for signalling between the UE and • NO_INFORMATION
the AF. If the AF-Signalling-Protocol AVP is not provided in • SIP
the AA-Request, the value NO_INFORMATION is assumed.
Type: string
(6 of 8)
serviceflows (continued) rrBandwidth Values: Long values of up to a

Indicates the maximum required bandwidth in bits per maximum of 4503599627370495,
second for RTCP receiver reports in the session component at or 252. You cannot enter 0 or a
the Media-Component-Description level. negative value.
Type: long
rsBandwidth Values: Long values of up to a

indicates the maximum required bandwidth in bits per maximum of 4503599627370495,
second for RTCP sender reports in the session component at or 252. You cannot enter 0 or a
the Media-Component-Description level negative value.
Type: long
vendorSpecificAttributes The Vendor Specific Attributes associated with the AF Values: Attribute value pairs as
session. defined by the vendor.
Type: string
based on:
• name
• value

ALC-App-Prof-Str.
Type: string
value —
• type
• value
(7 of 8)
vendorSpecificAttributes type
(continued) Type of data held in the vendorSpecificAttributes item.
STRING
the action.
IP_ADDRESS
Contains a single IP address in any of the accepted formats
for an IP address.
LIST
• STRING
• IP_ADDRESS

characters.
ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
value Values: upto 256,0000 characters

Attribute.
(8 of 8)
8— Sy session API
8.1 Using the Sy session API 8-2
8.2 getSession 8-2
8 — Sy session API
8.1 Using the Sy session API
The Sy session API is used to query information related to Sy sessions. Session

modification is not possible using this API.
8.2 getSession
Gets a fully populated Sy session.
Parameter
Session Identifier must contain one of the following: User Id, Subscription Id.
Note — The session binding identifier for Sy session is based only on

the first set of Subscription-Ids bound to it. Any other set of
Subscription-Ids for that subscriber are not included in the session.
Request code

<soapenv:Envelope
n"
on">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ses:getSession>


</ses:getSession>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Default: n/a userId or subscriberId,
to identify the
subscriber.

subscriber.
• type
• value

Type: enum
Default: none
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
Default: n/a
Response code

<env:Header/>
<env:Body>
<getSessionResponse
n"
<sySession>
<sessionId>tpapps.realm;1360148293;7;SySession</sessionI
d>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
</subscriptionIds>
<diameterHost>host8005.realm8005</diameterHost>
<policyCounters>
<policyCounter>
<id>goldService</id>
<status>
<status>green0</status>
<serviceParameters>
<serviceParameter>
<name>servicename</name>
<value>servicevalue</value>
</serviceParameter>
</serviceParameters>
</status>
</policyCounter>
<policyCounter>
<id>bronzeService</id>
<status>
<status>red</status>
<serviceParameters>
<serviceParameter>
<name>servicename0</name>
<value>servicevalue0</value>
</serviceParameter>
</status>
</policyCounter>
</policyCounters>
<ip-canSessions>
</ip-canSessions>
</sySession>
<sySession>
<sessionId>tpapps.realm;1360148293;8;SySession</sessionI
d>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
<diameterHost>host8005.realm8005</diameterHost>
<policyCounters>
<policyCounter>
<status>
<status>green</status>
<serviceParameters>
<serviceParameter>
</serviceParameter>
</status>
</policyCounter>
<policyCounter>
<id>extraService</id>
<status>
<id>extraService</id>
<status>grey</status>
<serviceParameters>
<serviceParameter>
</serviceParameter>
</status>
</policyCounter>
</policyCounters>
<ip-canSessions>
</ip-canSessions>
</sySession>
</env:Body>
</env:Envelope>
Response fields
Table 8-2 SySession field descriptions
value.
Type: string
Type: string
an (optional) APN.
value.
subscriptionIds —
this subscriber.
subscriptionId —
based on:
• type
• value
(1 of 4)
sessionBindingIdentifier (continued) type Values:

END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

Type: string
Type: string
(2 of 4)
vendorSpecificAttributes The Vendor Specific Attributes associated with the Values: Attribute value pairs as
IP-CAN session. defined by the vendor.
Type: string
• name
• value

ALC-App-Prof-Str.
Type: string
value —
• type
• value
type Values:
STRING • LIST
IP_ADDRESS
Type: Enum
LIST
• STRING
• IP_ADDRESS

characters.
ENUM
NUMBER
DECIMAL
example: 1.0456.
Specific Attribute.
(3 of 4)
policyCounters Uniquely identifies a set of policy counters that is —

maintained per subscriber within the OCS.
policyCounter Values: Consists of an id, status and

The counter information that is transmitted a set of serviceParameters
provides the policy counter ID and policy counter Type: PolicyCounter
status for each counter.
id Values: 1-255 characters long

The policy counter ID identifies a counter. (inclusive
Type: string
status Values: 1-255 characters long

The policy counter status identifies the state of that (inclusive)
counter using: Type: string
• id
• status
• serviceParameters
id Values: 1-255 characters long

The policy counter ID identifies a counter. (inclusive)
Type: string
Identifies the policy counter status applicable for a (inclusive)
specific policy counter and subscriber. Type: string
serviceParameters —
Defines the value of the service parameter using:
• name
• value
name Values: 1-255 characters long
A unique service parameter name. (inclusive)
Type: string
value Values: 1-255 characters long

Defines the value of the service parameter. (inclusive)
Type: string
ip-canSessions Identifies the IP-CAN session. —

sessionId Values: 1 to 255 characters
A unique string identifier used to define the IP-CAN Type: string
session.
(4 of 4)
9— Streaming reporting API
9.1 Using the streaming reporting API 9-2
9.2 ListAccountsWithFilter 9-3
9.3 ListAFSessionSummary 9-12
9.4 ListIPCANSessionSummary 9-24
9.5 ListNASREQSessionSummary 9-35
9.6 ListSubscribersCrossedThreshold 9-40
9.7 ListSYSessionSummary 9-43
9 — Streaming reporting API
9.1 Using the streaming reporting API
The streaming reporting service API is used to query the 5780 DSC for subscriber or
session information. Since these requests can potentially return large volumes of
data, care must be taken not to run these queries during peak traffic.
Note 1 — The PCRFs are queried one after another.
Note 2 — The schema is available at

/opt/tpa/schemas/dsc51/ReportingAPISchema.xsd.
The API can be disabled by setting the concurrency to 0. The request id (app id +
request id) should be unique at a given point in time. If one of the PCRFs in the
cluster is not available, the request is not served.
Requests
The streaming reporting API is a web-based service that uses SOAP over HTTP
POST. SOAP 1.1 is currently supported. An HTTP GET operation on the service
URL would return the service version.
A streaming reporting API SOAP request must contain two parts: the SOAP header
containing the request information and request body contain the request payload. A
request payload can be created using the streaming reporting API schema available
with the 5780 DSC (typically in
/opt/tpa/schemas/<apiversion>/ReportingAPISchema.xsd). Requests should be
validated against the schema, by the client, before posting them to the 5780 DSC.
The 5780 DSC checks the request id of the request to ensure the duplicate or
retransmitted requests are not served concurrently. The request id (app id + request
id in the SOAP header) should be unique at a given point in time. Responses are not
cached in the streaming reporting API. However, for the duration of the time a
request is being served, no other request with the same identity is served.
A request payload contains request information such as operation name, operation
version, and operation parameters. Requests should always be addressed to the
correct service version (http://<DSCHost>/reporting/streaming/<apiversion>). The
5780 DSC returns an error if the requested version does not match the requested
service.
In a distributed setup, a request is served by querying the PCRFs in sequence. If one
or more of the PCRFs is not available, the request is not served. If one of the PCRFs
returns an error, the remaining PCRFs are not queried.
The System Preferences can be used to control the load of the reporting API on the
5780 DSC. The API can be disabled by setting the concurrency to 0. The
recommended settings are 1 request at a time. See “Managing System Preferences”
in the 5780 DSC User Guide for more information.
Responses
The streaming reporting API sends the responses to the request, if all the validations
on the server-side are passed. The schema of a response is also defined in the
streaming reporting API schema available in 5780 DSC (typically
/opt/tpa/schemas/<apiversion>/ReportingAPISchema.xsd). The SOAP body of the
response contains response payload. A response payload contains two parts: results
and summary. The 5780 DSC sends a response summary for every request indicating
the status of the query (that is, SUCCESS or FAILURE).
If an error is encountered while processing the database results for the query (either
due to processing errors or time-outs), the query processing stops and the status of
the failure is indicated through the result summary section of the response. In these
cases, a SOAP fault will not be returned. Error detection, while integrating with
external systems, should be based on both SOAP faults and response summary.
The request id (app id + request id) should be unique at a given point in time. If one
of the PCRFs is not available, the request is not served. In addition, a request is not
complete until a summary section is seen. The status on the request indicates the
status of the operation (that is, SUCCESS or FAILURE).
9.2 ListAccountsWithFilter
Returns a list of accounts information based on the given filter.
Note — Filtering on re-occurring thresholds is currently not

supported.
Parameters
• version
Indicates the values that are allowed in the schema.
• parameters
Indicates the parameters that are allowed in the schema.
Request code
Code 9-1 shows a request code example for the ListAccountsWithFilter command.
Code 9-1: ListAccountsWithFilter request code example

<soapenv:Envelope
n"
xmlns:ns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51"
>
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:ListAccountsWithFilterRequest>
<ns:version> dsc51 </ns:version>
<ns:parameters>
<ns:filterCriteria fieldName="SUBSCRIBER_CATEGORY" operation="EQUAL"
value="auto" valueType="STRING"/>
<ns:filterCriteria fieldName="METERINGLIMIT_LIMITNAME"
operation="EQUAL" value="m2" valueType="STRING"/>
<ns:filterCriteria fieldName="USAGEDATA_LASTTHRESHOLDCROSSED"
operation="EQUAL" value="73" valueType="INTEGER"/>
<ns:additionalResponseFields>
<ns:additionalResponseField>SUBSCRIBER_MOBILENUMBER</ns:additionalRe
sponseField>
<ns:additionalResponseField>METERINGLIMIT_LIMITNAME</ns:additionalRe
sponseField>
<ns:additionalResponseField>SUBSCRIBER_CATEGORY</ns:additionalRespon
seField>
</ns:additionalResponseFields>
</ns:parameters>
</ns:ListAccountsWithFilterRequest>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 9-1 and 9-2 list the fields required for the ListAccountsWithFilter command.
Table 9-1 parameters field descriptions
filterCriteria The criteria for the filter operation. — Optional

• Any combination of filter criteria can be
specified. If no filter criteria is specified, data is
returned for all subscribers
• You can only specify one instance of each filter
criteria.
• If multiple filter criteria are specified, the filter
conditions are always joined using "AND";
however, an error message is not returned.
fieldName Values: Optional

The filter criteria can be one of the following: • METERINGLIMIT_LIMITNAME
• METERINGLIMIT_LIMITNAME • USAGEDATA_LASTTHRESHOLD
Returns subscriber having this metering limit CROSSED
assigned to them. • SUBSCRIBER_CATEGORY
• USAGEDATA_LASTTHRESHOLDCROSSED • NASSESSION_NASCOAFAILED
Returns subscribers matching the last threshold STATUS
crossed on any assigned metering limit that the
Type: enum
subscriber crossed.
• SUBSCRIBER_CATEGORY Default: n/a
Returns subscriber matching the category with
this matching category value.
• NASSESSION_NASCOAFAILEDSTATUS
Returns subscriber matching the sessions that
have CoA failed (or success) status.
operation Values: Optional

Contains the value of the operator used in the • EQUAL
filtering operation. • NOT_PRESENT
Note: The NOT_PRESENT operator can only be used
when filtering on METERINGLIMIT_LIMITNAME. Type: enum
Default: n/a
value Values: Depends on the filter

The value on which to filter. criteria and value type.
Type: Depends on the value type
Default: n/a
valueType Values: Optional

Contains the type for the specified value. • STRING
Note: The type is STRING for • INTEGER
METERINGLIMIT_LIMITNAME and • BOOLEAN
SUBSCRIBER_CATEGORY and INTEGER for
USAGEDATA_LASTTHRESHOLDCROSSED. Type: enum
Default: n/a
(1 of 2)
additional You can specify zero or more optional attributes that — —

Response you want retrieved in the response associated with
the subscriber.
You can specify the following values in the response Values: Optional
field: • METERINGLIMIT_LIMITNAME
• METERINGLIMIT_LIMITNAME • SUBSCRIBER_MOBILENUMBER
Contains a list of one or more metering limit • SUBSCRIBER_CATEGORY
names that are assigned to the subscriber, unless
the filtering is done using
• NASSESSION_NASCOASTATUS
USAGEDATA_LASTTHRESHOLDCROSSED. If this is • DEFAULT
the case, it returns only those metering limit • ALL
names for which the specified last threshold has
been crossed. Type: enum
If filtering on METERINGLIMIT_LIMITNAME, only Default: DEFAULT
the metering limit name on which you are
filtering is returned.
• SUBSCRIBER_MOBILENUMBER
Returns the mobile number used for notification
configured against the subscriber.
• SUBSCRIBER_CATEGORY
Contains the category of the subscriber.
• NASSESSION_NASCOASTATUS
Returns subscriber matching the sessions that
have CoA FAILED or SUCCESS status.
• DEFAULT
Returns minimum information, including:
account Id, account description, billing day,
userid, subscriptionid.
• ALL
Returns all of the information of accounts and
subscribers with meteringlimits and usage data.
(2 of 2)
Response code
Code 9-2 shows the response code for the ListAccountsWithFilter command.
Code 9-2: ListAccountsWithFilter response code example

<env:Header/>
<env:Body>
<response:ListAccountsWithFilterResponse
xmlns:response="http://www.alcatellucent.com/dsc/reporting/readOnly/
dsc51">
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>peter</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<userId>peter</userId>
<accountId>peter</accountId>
<subscriptionIds>
<subscriptionId>
<value>404059638527413@wlan.mnc404.mcc05.
3gppnetwork.org</value>
</subscriptionId>
<subscriptionId>
<value>404059638527413</value>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
">
<ns2:account>
<accountId>ML4User</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<accountId>ML4User</accountId>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
">
<ns2:account>
<accountId>MLUser</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<userId>MLUser</userId>
<accountId>MLUser</accountId>
<subscriptionIds>
<subscriptionId>
<value>nai@2gppnetwork.com</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>sip:24124sip@3gppnetwork.com</valu
e>
<type>END_USER_SIP_URI</type>
</subscriptionId>
<subscriptionId>
<value>2223@3gppnetwork.com</value>
<type>END_USER_PRIVATE</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
">
<ns2:account>
<accountId>unknown_20121123135951318_5</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<accountId>unknown_20121123135951318_5</account
Id>
<subscriptionIds>
<subscriptionId>
<value>31012000091</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
">
<ns2:account>
<accountId>unknown_20121123140707575_7</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<accountId>unknown_20121123140707575_7</account
Id>
<subscriptionIds>
<subscriptionId>
<value>31012000019042</value>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
">
<ns2:account>
<accountId>testSub</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<userId>testSub</userId>
<accountId>testSub</accountId>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>9785082345@wlan.mnc012.mcc310.3gpp
network.org</value>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
">
<ns2:account>
<accountId>silverUsers</accountId>
<meteredServices/>
<subscribers>
<subscriber>
<userId>subEvPro</userId>
<accountId>silverUsers</accountId>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>1234567890@3gppnetwork.org</value>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
<ResponseSummary
xmlns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51">
<resultSize>7</resultSize>
<operationStatus>SUCCESS</operationStatus>
</ResponseSummary>
</response:ListAccountsWithFilterResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-2 lists the fields required for the ListAccountsWithFilter command.
Note — NotificationConfig and category are only returned if they are

requested in the additionalResponse field.
Table 9-2 accountId response field descriptions
accountid The unique identifier or name for the account. Values: 1 to 32 characters
Type: string
resetDayOfMonth Represents the billing day of the month for the account and Values: 1 to 31
(1 of 3)
resetDayOfWeek Used for weekly resets, which can occur on any day of the week Values:
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
resetHourOfDay ResetHourOfDay must be configured for any reset, whether a Values: 0-24
follows:
day (default)
time during the day
day
meteredServices Defines a list of one or more metered service entries. A —

meteringLimitName Values: 1 to 80 characters
Metering limit name to be assigned to the account. Type: string80Type
Default: n/a
subscribers Defines the subscriber associated with this account.

• accountid
• userId
• category
• password
• description
• state
• subscriptionIds
• allowOverage
• syOCSEnabled
• customData
(2 of 3)
usageData Used to collect, format, transfer, and evaluate information —

related to a chargeable event. Usage data for a subscriber is
updated in real-time automatically and is available after each
network usage report. Usage data is listed per metering limit.
meteringLimit Values: 1 to 80 characters

direction Values:
Specifies the direction of the usage as monitored or the type • UP_LINK
Type: tns:QuotaType
• TOTAL
• UP_LINK
• TIME
accumulatedUsage Values: Long values of up to a

reset. 4503599627370495, or 252. You
value.
Type: double
quota Values: Long values of up to a

Usage quota set against the subscriber. maximum of
4503599627370495, or 252. You
value.
Type: double
nextScheduledReset Values: date and time value;

ResponseSummary resultSize Values: 1 to maximum

The total number of results the operation produced. supported results
Type: integer
operationalStatus Values:
The status of the operation. • SUCCESS
• FAILURE
Type: string
(3 of 3)
9.3 ListAFSessionSummary
Returns a list of AF session summaries for all AF sessions.
Parameter
• version
Request code
Code 9-3 shows a request code example for the ListAFSessionSummary command.
Code 9-3: ListAFSessionSummary request code example

<soapenv:Envelope
n"
>
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:ListAFSessionSummaryRequest>
<ns:parameters></ns:parameters>
</ns:ListAFSessionSummaryRequest>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 9-3 lists the fields required for the ListAFSessionSummary command.
Table 9-3 version request field descriptions
version Indicates the values that are allowed in the schema. Values: dsc51 Optional
Type: string
Default: empty
parameters Indicates the parameters that are allowed in the schema. Values: Optional
Type: string
Default: empty
Response code
Code 9-4 shows the response code for the ListAFSession command.
Code 9-4: ListAFSessionSummary response code example

<env:Header/>
<env:Body>
<response:ListAFSessionSummaryResponse
dsc51">
<ns2:ListAFSessionSummaryResult
">
<ns2:session>
<sessionId>af1</sessionId>
<lastUpdatedTime>2013-02-06
05:58:46</lastUpdatedTime>
<userId>ML3User1</userId>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>33012000091</value>
</subscriptionId>
</subscriptionIds>
<serviceFlows>
<serviceFlow>
<codecData1>uplink\/noffer\/nm=audio 99999
<maxRequestedBandwidthDL>1000</maxRequestedBand
widthDL>
<maxRequestedBandwidthUL>1000</maxRequestedBand
widthUL>
<afSignallingProtocol>NO_INFORMATION</afS
ignallingProtocol>
</serviceFlow>
</serviceFlows>
</ns2:session>
</ns2:ListAFSessionSummaryResult>
">
<ns2:session>
<subscriptionIds>
<subscriptionId>
<value>32012000091</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
<serviceFlows>
<serviceFlow>
widthDL>
widthUL>
ignallingProtocol>
</serviceFlow>
</serviceFlows>
</ns2:session>
">
<ns2:session>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>31012000191</value>
</subscriptionId>
</subscriptionIds>
<serviceFlows>
<serviceFlow>
widthDL>
widthUL>
ignallingProtocol>
</serviceFlow>
</serviceFlows>
</ns2:session>
">
<ns2:session>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>31012000491</value>
</subscriptionId>
</subscriptionIds>
<serviceFlows>
<serviceFlow>
widthDL>
widthUL>
ignallingProtocol>
</serviceFlow>
</serviceFlows>
</ns2:session>
<ResponseSummary
</ResponseSummary>
</response:ListAFSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-4 lists the fields required for the ListAFSessionSummary command.
Table 9-4 session field descriptions
IPCanSessionId A unique number that the server assigns to a user for the Values: valid session id
duration of the IP-CAN session. Type: string
lastUpdatedTime Displays the timestamp for the last update to the session. Values: Long values of up to a maximum
of 4503599627370495, or 252. You
cannot enter 0 or a negative value.
Type: string
Type: string
(1 of 7)
sessionBinding Identifies the parameters with which the session was created —
identifier on the PCRF.

example, 10.10.10.1.
Type: string
subscriptionIds —
Contains a list of subscription ids for this subscriber.
subscriptionId —
subscriber.
• value
• type
value Values: Valid values as allowed by the
The identifier of the subscription. type; for example,
Type: string
type Values:
Type: enum
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 7)
vendorSpecificAttributes The Vendor Specific Attributes associated with the NASREQ —

session.
based on:
• name
• value

ALC-App-Prof-Str.
Type: string
value
• type
• value
type Values:
Type of data held in the vendorSpecificAttributes item. • STRING
Values: Up to 256, 000 characters. • NUMBER
an IP address.
LIST
• STRING
• IP_ADDRESS

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.

Attribute.
(3 of 7)
serviceFlow Values: A collection of service flow

mediaComponentNumber, flowNumber
and finalUnitAction)
Type: string
(4 of 7)
serviceflows (continued) mediaType Values:

• VIDEO
• DATA
• APPLICATION
• CONTROL
• TEXT
• MESSAGE
• OTHER
Type: enum
Contains the ordinal number of the media component. Type: integer
flowStatus Values:
Type: string
uplink IP flows
ENABLED
DISABLED
REMOVED
Indicates the interfaces that the PCRF supports for the • 1 and 255 characters (ASCII)
authentication and authorization portion of the application. • 1 and 510 characters
The value must be the same as the value in the (Hexadecimal)
AF-Application-Identifier AVP that is received during the AF
creation of a PCC rule. Type: string
codecData1 Values: any string of length 1 – 1024

Used to look at media types to determine the QCI to assign for (inclusive)
the PCC rule. Type: string
codecData2 Values: any string of length 1 – 1024

Used to look at media types to determine the QCI to assign for (inclusive)
the PCC rule. Type: string
maxRequestedBandwidthDL Values: Long values of up to a maximum

Indicates the maximum bandwidth, in bits per second, for a of 4503599627370495, or 252. You
downlink service data flow. cannot enter 0 or a negative value.
Type: long
(5 of 7)
serviceflows (continued) maxRequestedBandwidthDlSource Values:

The source of the requested maximum bit rate downlink • REQUEST
bandwidth. • PDF
Type: string
maxRequestedBandwidthUL Values: Long values of up to a maximum
Indicates the maximum bit rate, in bits per second, for an of 4503599627370495, or 252. You
uplink service data flow. cannot enter 0 or a negative value.
Type: long
The source of the requested maximum bit rate uplink • REQUEST
bandwidth. • PDF
Type: string
subComponentFlowDescriptions —
• flowNumber
• flowUsage
flowNumber Values: Long values of up to a maximum

Contains the ordinal number of the IP flows at the of 4503599627370495, or 252. You
Media-Sub-Component-Flow-Description level. cannot enter 0 or a negative value.
Type: double
flowUsage Values:
• RTCP
• AF_SIGNALLING
Type: enum


Indicates the protocol used for signalling between the UE and • NO_INFORMATION
the AF. If the AF-Signalling-Protocol AVP is not provided in the • SIP
AA-Request, the value NO_INFORMATION is assumed.
Type: string
(6 of 7)
serviceflows (continued) rrBandwidth Values: Long values of up to a maximum

Indicates the maximum required bandwidth in bits per second of 4503599627370495, or 252. You
for RTCP receiver reports in the session component at the cannot enter 0 or a negative value.
Media-Component-Description level. Type: long
rsBandwidth Values: Long values of up to a maximum

indicates the maximum required bandwidth in bits per second of 4503599627370495, or 252. You
for RTCP sender reports in the session component at the cannot enter 0 or a negative value.
Media-Component-Description level Type: long
ResponseSummary resultSize Values: 1 to maximum supported

The total number of results the operation produced. results
Type: integer
• FAILURE
Type: string
(7 of 7)
9.4 ListIPCANSessionSummary
Returns a list of IP-CAN session summaries for all IP-CAN sessions.
Parameter
• version
Request code
Code 9-5 shows a request code example for the ListIPCANSessionSummary
command.
Code 9-5: ListIPCANSessionSummary request code example

<soapenv:Envelope
n"
>
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:ListIPCANSessionSummaryRequest>

</ns:ListIPCANSessionSummaryRequest>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 9-5 lists the fields required for the ListIPCANSessionSummary command.
Type: string
Default: empty
parameters Indicates the parameters that are allowed in the schema. Values: Optional
Type: string
Default: empty
Response code
Code 9-6 shows the response code for the ListIPCANSessionSummary command.
Code 9-6: ListIPCANSessionSummary response code example

<env:Header/>
<env:Body>
<response:ListIPCANSessionSummaryResponse
dsc51">
<ns2:ListIPCANSessionSummaryResult
">
<ns2:session>
<sessionId>pgsess1</sessionId>
<subscriptionIds>
<subscriptionId>
<value>9785082345@wlan.mnc012.mcc310.3gppnet
work.org</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
<AuthorizedApnMaximumBitrateDL>8000000</AuthorizedApn
MaximumBitrateDL>
<AuthorizedApnMaximumBitrateUL>8000005</AuthorizedApn
MaximumBitrateUL>
<AdjustedApnMaximumBitrateDL>8000000</AdjustedApnMaxi
mumBitrateDL>
<AdjustedApnMaximumBitrateUL>8000005</AdjustedApnMaxi
mumBitrateUL>
<defaultEPSBearerQoS>
<defaultBearerQCI>QCI_7</defaultBearerQCI>
<allocationRetentionPriority>
<preEmptionCapability>PRE_EMPTION_CAPABILITY_EN
ABLED</preEmptionCapability>
<preEmptionVulnerability>PRE_EMPTION_VULNERABIL
ITY_ENABLED</preEmptionVulnerability>
</allocationRetentionPriority>
</defaultEPSBearerQoS>
<pccRuleNames>
<ruleName>Test_Charge_Rule_1</ruleName>
<ruleName>MT:VIDEO MCN:1 FN:1 Rule#:1</ruleName>
</pccRuleNames>
<afSessions>
</afSessions>
</ns2:session>
</ns2:ListIPCANSessionSummaryResult>
<ns2:ListIPCANSessionSummaryResult
">
<ns2:session>
<sessionId>pgsess2</sessionId>
<ipv6Prefix>2001:db8:85a3:0:0:0:0:0/64</ipv6Prefix
>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>9785082345@wlan.mnc012.mcc310.3gppnet
work.org</value>
</subscriptionId>
</subscriptionIds>
<AuthorizedApnMaximumBitrateDL>8000000</AuthorizedApn
MaximumBitrateDL>
<AuthorizedApnMaximumBitrateUL>8000005</AuthorizedApn
MaximumBitrateUL>
<AdjustedApnMaximumBitrateDL>8000000</AdjustedApnMaxi
mumBitrateDL>
<AdjustedApnMaximumBitrateUL>8000005</AdjustedApnMaxi
mumBitrateUL>
<defaultEPSBearerQoS>
<defaultBearerQCI>QCI_7</defaultBearerQCI>
<allocationRetentionPriority>
<preEmptionCapability>PRE_EMPTION_CAPABILITY_EN
ABLED</preEmptionCapability>
<preEmptionVulnerability>PRE_EMPTION_VULNERABIL
ITY_ENABLED</preEmptionVulnerability>
</allocationRetentionPriority>
</defaultEPSBearerQoS>
<pccRuleNames>
<ruleName>Test_Charge_Rule_1</ruleName>
</pccRuleNames>
<afSessions/>
</ns2:session>
</ns2:ListIPCANSessionSummaryResult>
<ResponseSummary
</ResponseSummary>
</response:ListIPCANSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-6 lists the fields required for the ListIPCANSessionSummary command.
IPCanSessionId A unique number that the server assigns to a user for the Values: valid session id
duration of the IP-CAN session. Type: string
SYSessionId A unique number that the server assigns to a user for the Values: valid session id
duration of the SYSession session. Type: string
of 4503599627370495, or 252. You
Type: string
(1 of 9)
Type: string
example, 10.10.10.1.
Type: string
ipv6Address Values: A valid IPv6 Address consists of

Contains the IPv6 prefix (length can be preceded by /) to be eight four-digit hexadecimal numbers
configured for the user separated by colons and uses the
following format:
For example:
0011:2233:4455:6677:8899:aab:
ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
IPv6 Address Text Representation for
supported IPv6 Prefix representations.

Default: empty
subscriptionIds —
subscriptionId —
subscriber.
• value
• type

Type: string
(2 of 9)
sessionBinding type Values:

identifier (continued) The type of identifier that is carried by the associated value. • END_USER_E164
Type: enum
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE

session.
based on:
• name
• value

ALC-App-Prof-Str.
Type: string
value —
• type
• data
(3 of 9)

(continued) Type of data held in the vendorSpecificAttributes item. • STRING
Values: Up to 256,000 characters. • NUMBER
an IP address.
LIST
• STRING
• IP_ADDRESS

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.
data Values: up to 256,0000 characters

Attribute.
AuthorizedapnMaximumBitrateDL Values: Long values of up to a maximum
Indicates the maximum aggregate bit rate in bps for the of 4503599627370495, or 252. You
downlink direction across all non-GBR bearers related with the cannot enter 0 or a negative value.
same APN. Type: long
AuthorizedapnMaximumBitrateUL Values: Long values of up to a maximum

Indicates the maximum aggregate bit rate in bps for the uplink of 4503599627370495, or 252. You
direction across all non-GBR bearers related with the same cannot enter 0 or a negative value.
APN. Type: long
AdjustedApnMaximumBitrateDL Values: Long values of up to a maximum

Indicates the maximum adjusted bit rate in bps for the of 4503599627370495, or 252. You
AdjustedApnMaximumBitrateUL Values: Long values of up to a maximum

Indicates the maximum adjusted bit rate in bps for the uplink of 4503599627370495, or 252. You
APN. Type: long
(4 of 9)
vendorSpecificAttributes AuthorizedapnMaximumBitrateDL Values: Long values of up to a maximum

(continued) Indicates the maximum aggregate bit rate in bps for the of 4503599627370495, or 252. You
AuthorizedapnMaximumBitrateUL Values: Long values of up to a maximum

Indicates the maximum aggregate bit rate in bps for the uplink of 4503599627370495, or 252. You
APN. Type: long
defaultEPSBearerQoS —
Defines the QoS information for the EPS default bearer
QCI_2
QCI_3
QCI_4
QCI_5
QCI_6
QCI_7
QCI_8
QCI_9
Type: string
• priorityLevel
Ensures that the request for the bearer with the higher priority Type: integer
level is preferred. In addition, the priority level can be used by
the eNodeB to decide which bearer to drop during exceptional
Defines whether a bearer with a lower ARP priority level should • PRE_EMPTION_CAPABILITY_
be dropped to free up the required resources. ENABLED
DISABLED
Type: string
Defines whether a bearer can be dropped by a preemption • PRE_EMPTION_VULNERABILITY_
DISABLED
Type: string
pccRuleNames Contains a list of zero or more PCC rules. —
pccRuleName Values: 1 to 80 characters

Contains the name of the PCC rule. Type: string
(5 of 9)
pccRules Contains zero or more PCC rules. —
pccRule Values: 1 to 80 characters

Defines the IP flow by filter definitions, the QoS, and the Type: string
charging treatment.
rulename Values: 1 to 80 characters
The name for the rule. Type: string
AfChargingID Values: 1 to 255 characters

Contains the AF Charging Identifier that is sent by the AF. This Type: string
information may be used for charging correlation with bearer
layer
ratingGroup Values: integer

The usage is reported on at the rating group level. All of the Type: string
services that are subject to the same rating type are part of
the same rating group.
pccRuleType Values:
Indicates the type of rule. • GENERATED
GENERATED • PROVISIONED
Dynamic 5780 DSC system-generated PCC rule. • PREDEFINED
PROVISIONED • PROVISIONED_TEMPLATE
User-configured provisioned Charging/QoS rule.
• PREDEFINED_TEMPLATE
PREDEFINED
• PREDEFINED_BASE
• PREDEFINED_BASE_TEMPLATE
User-specified Predefined PCC Rule.
PROVISIONED_TEMPLATE Type: string
Allows you to configure the provisioned Charging/QoS rule. You
must configure the QCI and Priority Level parameters for a
provisioned rule of Type: Provisioned Template.
PREDEFINED_TEMPLATE
Allows you to configure the Predefined Pcc Rule. For the
Predefined template, only Rule Activation Date and Time and
Rule Deactivation Date and Time are applicable.
PREDEFINED_BASE
User-specified Predefined Base Rule Template for the charging
rule base name.
PREDEFINED_BASE_TEMPLATE
Allows you to configure the Predefined Base Rule Template for
the charging rule base name. For the Predefined template,
only Rule Activation Date and Time and Rule Deactivation Date
and Time are applicable.
(6 of 9)
pccRules (continued) flowStatus Values:

Type: string
uplink IP flows
ENABLED
DISABLED
REMOVED
reportingLevel Values:
Defines on what level the 5780 DSC reports the usage for the • SERVICE_IDENTIFIER_LEVEL
related PCC rule. • RATING_GROUP_LEVEL
RATING_GROUP_LEVEL
Type: string
Indicates that the usage is reported on rating group level.
SERVICE_IDENTIFIER_LEVEL
Indicates that the usage is reported on service id and rating
group combination level.
online Values:
DISABLE_ONLINE
Type: string
Indicates that the online charging interface for the associated
PCC rule is Disabled.
ENABLE_ONLINE
Indicates that the online charging interface for the associated
PCC rule is Enabled.
offline Values:
The resource usage is reported from the network to the billing • DISABLE_OFFLINE
DISABLE_OFFLINE
Type: string
Indicates that the offline charging interface for the associated
PCC rule is Disabled.
ENABLE_OFFLINE
Indicates that the offline charging interface for the associated
PCC rule is Enabled.
meteringMethod Values:
DURATION • VOLUME
VOLUME Type: string
DURATION_VOLUME
metered.
(7 of 9)
pccRules (continued) serviceId Values: Unsigned32

The service identifier is used to identify the service or the Type: integer
service component to which the service data flow relates.
serviceFlows Values: A collection of service flow

mediaComponentNumber, flowNumber
and finalUnitAction)
Type: string
monitoringKey Values: 1 to 80 characters.

activationTime Values: Long values of up to a maximum

Indicates the NTP time at which the PCC rule has to be of 4503599627370495, or 252. You
enforced. The activation time must be later than the current cannot enter 0 or a negative value.
system time. Type: long
deactivationTime Values: Long values of up to a maximum

Indicates the NTP time at which the PCEF has to stop enforcing of 4503599627370495, or 252. You
the PCC rule. The deactivation time must be later than the cannot enter 0 or a negative value.
current system time. Type: long
lastAppliedThreshold Values: Any percentage value

Identifies the last metering threshold (for a PCC Rule-level indicating the thresholds specified in
Monitoring key) that was exceeded and processed by the the provisioned metering limits
DYNAMIC_RULE_CREATION rules. Type: integer
bearerUsage Values:
The bearer usage indicates how the bearer is used. If bearer • GENERAL
usage has not been previously provided, its absence indicates • IMS_SIGNALLING
that specific information is not available.
If bearer usage is provided, the value is valid until the next Type: string
time a value is provided. The AVP is used for GPRS and EPS
access types.
GENERAL
Specific bearer usage information is not available.
IMS_SIGNALLING
The bearer is used for IMS signaling only.

CREATED • CREATED
Indicates that the session is in the Created state immediately • STARTED
after it is created. • STOPPED
Indicates that the session is in a Started state after an
Type: string
accounting start.
STOPPED
Indicates that the session is in a Stopped state after an
accounting stop.
DISCONNECTED
Indicates that the session is in a Disconnected state after an
accounting disconnect.
(8 of 9)

Type: integer
• FAILURE
Type: string
(9 of 9)
9.5 ListNASREQSessionSummary
Returns a list of NASREQ session summaries for all NASREQ sessions.
Parameter
• version
Request code
Code 9-7 shows a request code example for the listNASREQSessions command.
Code 9-7: ListNASREQSessionSummary request code example

soapenv:Envelope
n"
>
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:ListNASREQSessionSummaryRequest>
<ns:version>dsc51</ns:version>
<ns:parameters>
<ns:filterCriteria
fieldName="NASSESSION_NASCOAFAILEDSTATUS" operation="EQUAL"
value="TRUE" valueType="BOOLEAN"/>
<ns:additionalResponseFields>
<ns:additionalResponseField>NASSESSION_NASCOASTATUS</ns:additionalRe
sponseField>
</ns:additionalResponseFields>
</ns:parameters>
</ns:ListNASREQSessionSummaryRequest>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 9-7 and 9-8 lists the fields required for the ListNASREQSessionSummary
command.
Type: string
Default: empty
Response code
Code 9-8 shows the response code for the ListNASREQSessionSummary command.
Code 9-8: ListNASREQSessionSummary response code example

<env:Header/>
<env:Body>
<response:ListNASREQSessionSummaryResponse
dsc51">
<ns2:ListNASREQSessionSummaryResult
">
<ns2:session>
<sessionId>NASREQSession-11:0d:72:bf:00:70</sessionId
>
<userId>user70</userId>
<subscriptionIds>
<subscriptionId>
<value>user70</value>
</subscriptionId>
</subscriptionIds>
<name>ALUTIMETRA.ALC-Client-Hardware-Addr</name
>
<value>
<type>STRING</type>
<data>11:0d:72:bf:00:70</data>
</value>
<sessionState>CREATED</sessionState>
</ns2:session>
</ns2:ListNASREQSessionSummaryResult>
<ns2:ListNASREQSessionSummaryResult
">
<ns2:session>
<sessionId>NASREQSession-22:0d:72:bf:00:70</sessionId
>
<userId>user70</userId>
<subscriptionIds>
<subscriptionId>
<value>user70</value>
</subscriptionId>
</subscriptionIds>
<name>ALUTIMETRA.ALC-Client-Hardware-Addr</name
>
<value>
<type>STRING</type>
<data>22:0d:72:bf:00:70</data>
</value>
<sessionState>CREATED</sessionState>
</ns2:session>
</ns2:ListNASREQSessionSummaryResult>
<ResponseSummary
</ResponseSummary>
</response:ListNASREQSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-8 lists the fields required for the ListNASREQSessionSummary command.
(1 of 4)
of 4503599627370495, or 252. You
Type: string
Type: string

The IP address of the NAS. four integers separated by a dot; for
example, 10.10.10.1.
Type: string
subscriptionIds —
subscriptionId —
subscriber.
• value
• type

Type: string
type Values:
Type: enum
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
(2 of 4)

session.
based on:
• name
• value

ALC-App-Prof-Str.
Type: string
value —
• type
• value
type Values:
Type of data held in the vendorSpecificAttributes item. • STRING
Values: Up to 256,000 characters. • NUMBER
an IP address.
LIST
• STRING
• IP_ADDRESS

ENUM
User Guide.
NUMBER
DECIMAL
1.0456.

Attribute.
(3 of 4)

CREATED • CREATED
Type: string
accounting start.
STOPPED
accounting stop.
DISCONNECTED

Type: integer
• FAILURE
Type: string
(4 of 4)
9.6 ListSubscribersCrossedThreshold
Returns a list of subscriber IDs for all subscribers on the 5780 DSC that have crossed
a threshold.
Parameter
• version
Request code
Code 9-9 shows a request code example for the ListSubscribersCrossedThreshold
command.
Code 9-9: ListSubscribersCrossedThreshold request code example

<soapenv:Envelope
n"
>
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:ListSubscribersCrossedThresholdRequest>
<ns:version> dsc51</ns:version>
</ns:ListSubscribersCrossedThresholdRequest>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 9-9 and 9-10 list the fields required for the ListSubscribersCrossedThreshold
command.

Type: string
Default: empty
Response code
Code 9-10 shows the response code for the ListSubscribersCrossedThreshold
command.
Code 9-10: ListSubscribersCrossedThreshold response code example

<env:Header/>
<env:Body>
<response:ListSubscribersCrossedThresholdResponse
dsc51">
<ns2:ListSubscribersCrossedThresholdResult
">
<ns2:subscriber>
<subscriptionIds>
<subscriptionId>
<value>31012000491</value>
</subscriptionId>
<subscriptionId>
<value>sip:441234sip@3gppnetwork.com</value>
<type>END_USER_SIP_URI</type>
</subscriptionId>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>22124@3gppnetwork.com</value>
<type>END_USER_PRIVATE</type>
</subscriptionId>
</subscriptionIds>
</ns2:subscriber>
</ns2:ListSubscribersCrossedThresholdResult>
">
<ns2:subscriber>
<userId>ML2_3User</userId>
<subscriptionIds>
<subscriptionId>
<value>32012000091</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
</ns2:subscriber>
">
<ns2:subscriber>
<subscriptionIds>
<subscriptionId>
</subscriptionId>
<subscriptionId>
<value>33012000091</value>
</subscriptionId>
<subscriptionId>
</subscriptionId>
</subscriptionIds>
</ns2:subscriber>
<ResponseSummary
</ResponseSummary>
</response:ListSubscribersCrossedThresholdResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-10 lists the fields required for the ListSubscribersCrossedThreshold
command.
Table 9-10 subscriber response field descriptions
Type: string
subscriptionIds Contains a list of subscription ids for this subscriber. —
subscriptionId —
subscriber.
• value
• type
Type: string
type Values:
Type: enum
END_USER_SIP_URI
END_USER_NAI
END_USER_PRIVATE
ResponseSummary resultSize Values: 1 to maximum

The total number of results the operation produced. supported results
Type: integer
• FAILURE
Type: string
9.7 ListSYSessionSummary
Returns a list of Sy session summaries for all Sy sessions.
Parameter
• version
Request code
Code 9-11 shows a request code example for the ListSYSessionSummary command.
Code 9-11: ListSYSessionSummary request code example

<soapenv:Envelope
n"
>
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:ListSYSessionSummaryRequest>
</ns:ListSYSessionSummaryRequest>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 9-11lists the fields required for the ListSYSessionSummary command.
Type: string
Default: empty
Response code
Code 9-12 shows the response code for the ListSYSessionSummary command.
Code 9-12: ListSYSessionSummary response code example

<env:Header/>
<env:Body>
<response:ListSYSessionSummaryResponse
dsc51">
<ns2:ListSYSessionSummaryResult
">
<ns2:session>
<sessionId>tpapps.realm;1360148337;1;SySession</sessi
onId>
<userId>peter</userId>
<subscriptionIds>
<subscriptionId>
<value>404059638527413</value>
</subscriptionId>
</subscriptionIds>
<policyCounters>
<policyCounter>
<status>red</status>
<serviceParameters>
<serviceParameter>
</serviceParameter>
</policyCounter>
<policyCounter>
<status>green0</status>
<serviceParameters>
<serviceParameter>
</serviceParameter>
</policyCounter>
</policyCounters>
<ipcanSessions>
</ipcanSessions>
</ns2:session>
</ns2:ListSYSessionSummaryResult>
<ResponseSummary
</ResponseSummary>
</response:ListSYSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-12 lists the fields required for the ListSYSessionSummary command.
of 4503599627370495, or 252. You
Type: string
Type: string
policyCounter Values:Consists of an id, status and a

Uniquely identifies a set of policy counter that is maintained set of serviceParameters
per subscriber within the OCS. Type: PolicyCounter
id Values: 1-255 characters long (inclusive
The policy counter ID identifies a counter. Type: string

The policy counter status identifies the state of that counter. (inclusive)
Type: string
ipcanSessions The type of connectivity access network to which the user is —

connected.
sessionId Values: valid session id
A unique number that the server assigns to a user for the Type: string
duration of session.

CREATED • CREATED
Type: string
accounting start.
STOPPED
accounting stop.
DISCONNECTED
(1 of 2)

Type: integer
• FAILURE
Type: string
(2 of 2)
10 — System API
10.1 Using the system API 10-2
10.2 exportPcrfSystemConfiguration 10-2
10.3 exportSystemConfiguration 10-11
10.4 importSystemConfiguration 10-20
10 — System API
10.1 Using the system API
The 5780 DSC system API is used to perform operations related to system functions
such as configuration management.
Note 1 — There is a difference between the format of the GUI export
feature and the API export functionality in that the data returned is
escaped (because notifications or other data may contain characters
that would otherwise be interpreted directly).
If you need to use the GUI to import a file exported using API, then it
would first have to be unescaped (and vise versa).
Note 2 — The system API uses Basic Authentication to secure the
import and export operations. Each request requires a username and
password in the http header (which is typically the same 5780 DSC
GUI users).
10.2 exportPcrfSystemConfiguration
Returns the reference PCRF default system configuration if the request is addressed
to the CSB, or returns the local PCRF default system configuration if the request is
Parameters
• systemConfiguration
Contains a set of configuration categories, including:
• DEFAULT
• NAS
• NOTIFICATION
• SYSTEMPREFS
• USERS
• ROAMING
• DIAMETERCLIENTS
• DIAMETEROVERLOAD
• DIAMETERPEERS
• DIAMETERROUTES
• EXTERNALSYSTEMS
• SUBSCRIBERPROFILES
• OVERLOADPROTECTION
• PERFORMANCEMETRICSJOB
Request code
Code 10-1 shows a request code example for the exportPcrfSystemConfiguration
command.
Code 10-1: exportPcrfSystemConfiguration request code example

10 — System API
<soapenv:Envelope
n"
xmlns:sys="http://www.alcatellucent.com/dsc/provisioningapi/system/5
1/systemConfiguration">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sys:exportPcrfSystemConfiguration>
<sys:systemConfiguration>DEFAULT</sys:systemConfiguration>
</sys:exportPcrfSystemConfiguration>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 10-1 lists the fields required for the exportPcrfSystemConfiguration
command.
Table 10-1 systemConfiguration request field descriptions

systemConfiguration Contains a set of configuration categories. Values: Optional
• DEFAULT
• NAS
• NOTIFICATION
• SYSTEMPREFS
• USERS
• SNMPTARGET
• ROAMING
• DIAMETERCLIENTS
• DIAMETEROVERLOAD
• DIAMETERPEERS
• DIAMETERROUTES
• EXTERNALSYSTEMS
• SUBSCRIBERPROFILES
• OVERLOADPROTECTION
• PERFORMANCEMETRICSJOB
Type: enum
Default: DEFAULT
Response code
Code 10-2 shows the response code for the exportPcrfSystemConfiguration
command.
10 — System API
Code 10-2: exportPcrfSystemConfiguration response code example

<env:Header/>
<env:Body>
<exportPcrfSystemConfigurationResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/system/51/systemConfiguration"
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/common"
<systemConfiguration>{
"DSCApplication": "PCRF",
"CMS": {"SystemPreferences": [
{
"Name": "Backup Interval (hours)",
"Value": "24"
},
{
"Name": "Backup File Retention #",
"Value": "2"
},
{
"Name": "Backup Start Time (hh:mm)",
"Value": "02:00"
},
{
"Name": "Backup Location",
"Value": "\/opt\/tpa\/backups\/daily"
},
{
"Name": "Backup Enabled",
"Value": "true"
},
{
"Name": "DB Status Monitoring Interval",
"Value": "30"
},
{
"Name": "CMS Inventory Interval",
"Value": "15"
}
]},
"Diameter": {
"Peers": [],
"OverloadProtection": {
"LowThreshold": 100,
"HighThreshold": 1000,
"ResoureceThreshold": 100000,
"LatencyLowThreshold": 40,
"LatencyHighThreshold": 50,
"LatencyResoureceThreshold": 100,
"Learning": false,
"ReconnectInterval": 1,
"SheddingConfigs": [
{
"ApplicationID": 1,
"Description": "Re-Auth-Request",
"Scenario": 11,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
},
{
"ApplicationID": 16777236,
"Scenario": 0,
},
{
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
10 — System API
},
{
"Scenario": 0,
},
{
"Description": "Emergency",
"Scenario": 6,
},
{
"ApplicationID": 1,
"Description": "Access request",
"Scenario": 7,
},
{
"Scenario": 6,
},
{
"Scenario": 0,
},
{
"ApplicationID": 1,
"Description": "Accounting stop",
"Scenario": 10,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
},
{
"Scenario": 1,
},
{
"Description": "UE-initiated dedicated bearer",
"Scenario": 3,
},
{
"Description": "Session termination",
"Scenario": 2,
},
{
"ApplicationID": 1,
"Scenario": 2,
10 — System API
},
{
"Scenario": 2,
},
{
"ApplicationID": 1,
"Description": "Accounting interim",
"Scenario": 9,
},
{
"Scenario": 6,
},
{
"Scenario": 1,
},
{
"Scenario": 0,
},
{
"ApplicationID": 1,
"Description": "Accounting start",
"Scenario": 8,
"DefaultLevel": "MAJOR",
"SheddingLevel": "MAJOR",
},
{
"Scenario": 3,
},
{
"Description": "Notification",
"Scenario": 5,
},
{
"Description": "Handover",
"Scenario": 4,
},
{
"Scenario": 2,
10 — System API
}
]
},
"SystemPreferences": [
{
"Name": "Geo-Redundant Auto Failback",
"Value": "true"
},
{
"Name": "Disable Origin State-Id Validation",
"Value": "false"
},
{
"Name": "Geo-Redundant Activity Switch Delay",
"Value": "30"
}
],
"Routes": [
{
"Active": true,
"OriginHost": "fireball.realm",
"Realm": "realm",
"Application": 1,
"Priority": 2,
"Description": "Default route required by NASREQ. Please do not change
it."
},
{
"Active": true,
"OriginHost": "maserati.realm",
"Realm": "*",
"Application": -1,
"Priority": 2,
"Description": "Route to CSB for all apps and realms"
},
{
"Active": true,
"Realm": "realm",
"Application": 16777236,
"Priority": 2,
"Description": "Default route required by RESTful API. Please do not
change it."
}
]
},
"SNMP": {"SystemPreferences": [
{
"Name": "SNMP Agent Description",
"Value": "DSC_5_0_I1103 5780 Dynamic Services Controller UNKNOWN Platform"
},
{
"Name": "SNMP Agent Community",
"Value": "marchrd"
},
{
"Name": "SNMP Agent OID",
"Value": "1.3.6.1.4.1.637.69.5.4.1.2"
}
]},
"WNG": {"SystemPreferences": [
{
"Name": "WNG Abusive Subscriber Event Audit Interval (seconds)",
"Value": "2100"
},
{
"Name": "WNG Abusive Subscriber Event Inactivity Duration (seconds)",
"Value": "2100"
},
{
"Name": "WNG Security & Attacks Event Audit Interval (seconds)",
"Value": "600"
},
{
"Name": "WNG Security & Attacks Event Inactivity Duration (seconds)",
"Value": "600"
},
{
"Name": "WNG Performance & Trend Event Audit Interval (seconds)",
"Value": "3600"
},
{
"Name": "WNG Performance & Trend Event Inactivity Duration (seconds)",
"Value": "3600"
}
]},
"PCRF": {
10 — System API
{
"Name": "IP CAN Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "IP CAN Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "S9 Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "S9 Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "AF Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "AF Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "Gateway Control Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "Gateway Control Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "NASREQ Session Audit Interval (seconds)",
"Value": "86400"
},
{
"Name": "NASREQ Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "NASREQ Session Auto ReAuth on Rule Reload",
"Value": "false"
},
{
"Name": "Auxiliary Gx Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "Auxiliary Gx Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "IP CAN Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "S9 Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "Gateway Control Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "AF Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "NASREQ Session Inactivity Duration (seconds)",
"Value": "86400"
},
{
"Name": "Auxiliary Gx Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "IP CAN Session Auto ReAuth on Rule Reload",
"Value": "false"
},
{
"Name": "IP CAN Session ReAuth Scheduler Interval (seconds)",
"Value": "3600"
},
{
"Name": "NASREQ Session ReAuth Scheduler Interval (seconds)",
"Value": "3600"
},
10 — System API
{
"Name": "IP CAN Session ReAuth Scheduler Interval Offset (seconds)",
"Value": "5"
},
{
"Name": "NASREQ Session ReAuth Scheduler Interval Offset (seconds)",
"Value": "5"
},
{
"Name": "Default 3GPP Version",
"Value": "june-2011"
},
{
"Name": "Usage Reset Schedule Interval (seconds)",
"Value": "3600"
},
{
"Name": "Reset Usage At The End Of Billing Day",
"Value": "true"
},
{
"Name": "Default Volume Quota (bytes)",
"Value": "1000000000"
},
{
"Name": "Default Time Quota (seconds)",
"Value": "3600"
},
{
"Name": "Sy OCS Realm",
"Value": ""
},
{
"Name": "Sy Specification Type",
"Value": "3GPP"
},
{
"Name": "Quota Allocation Factor (%)",
"Value": "20"
},
{
"Name": "Enable Accounting Record Logging",
"Value": "true"
},
{
"Name": "Metering Limit Priority Order - Low to High",
"Value": "true"
},
{
"Name": "Metering Limit Base Unit Rounding Type",
"Value": "up"
},
{
"Name": "Bypass Validation of Origin Host and Realm",
"Value": "false"
},
{
"Name": "Disable RAR for stale sessions",
"Value": "false"
},
{
"Name": "Metering Limit Prorate",
"Value": "false"
},
{
"Name": "Gx RAR Send Delay (milliseconds)",
"Value": "0"
}
],
"DiameterClients": []
},
"Roaming": {"Roaming": {
"HomeNetworkInfo": {
"NetworkIDs": [],
"Domains": [],
"EmergencyAPNs": [],
"APNs": [],
"IMSAPNs": []
},
"RoamingAgreements": [],
"RoamingPartners": []
}},
"RestfulAPI": {"SystemPreferences": [{
"Name": "RESTful API QoSFlow Session Cleanup Interval (mins)",
"Value": "5"
}]},
"Policy": {
"SystemPreferences": [{
"Name": "Configuration Distribution OSSI Timeout (milli secs)",
10 — System API
"Value": "60000"
}],
"NotificationConfig": {
"SmsServers": [],
"EmailServers": [],
"WebServers": [],
"XmppServers": []
}
},
"NAS": {
"RadiusHostClusters": [],
"NASProfiles": [],
"NASClusters": []
},
"SPR": {"SystemPreferences": [
{
"Name": "SPR Server Audit Interval (seconds)",
"Value": "300"
},
{
"Name": "SPR External Update Tries",
"Value": "3"
},
{
"Name": "Subscriber Data Expiry Time (seconds)",
"Value": "86400"
},
{
"Name": "Unknown Subscriber Expiry Time (seconds)",
"Value": "172800"
}
]},
"Common": {
{
"Name": "Statistics Sampling Interval in ms",
"Value": "900000"
},
{
"Name": "Statistics Rate Calculation Enabled",
"Value": "false"
},
{
"Name": "Overload Protection Escalation Interval",
"Value": "30"
}
],
"UserConfig": {
"Users": [],
"Roles": [
{
"Name": "Global",
"Create": true,
"Read": true,
"Update": true,
"Delete": true,
"Execute": true
},
{
"Name": "Read-only",
"Create": false,
"Read": true,
"Update": false,
"Delete": false,
"Execute": false
}
]
},
"PollInterval": 2,
"LowCPUThreshold": 70,
"HighCPUThreshold": 80,
"ResourceCPUThreshold": 90
}
},
"OSSI": {"SystemPreferences": [{
"Name": "OSSI SECURE",
"Value": "false"
}]}
}</systemConfiguration>
</exportPcrfSystemConfigurationResponse>
</env:Body>
</env:Envelope>
10 — System API
Response fields
Table 10-2 lists the fields required for the exportPcrfSystemConfiguration
command.
Table 10-2 exportPcrfSystemConfiguration field descriptions
systemConfiguration Contains a set of configuration categories. Values: n/a

Type: string
10.3 exportSystemConfiguration
Returns the local CSB system configuration if the request is addressed to the CSB,
or returns the local PCRF system configuration if the request is addressed to the
PCRF.
Parameter
• n/a.
Request code
Code 10-3 shows a request code example for the exportSystemConfiguration
command.
Code 10-3: exportSystemConfiguration request code example

<soapenv:Envelope
n"
xmlns:sys="http://www.alcatellucent.com/dsc/provisioningapi/system/5
1/systemConfiguration">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sys:exportSystemConfiguration/>
</soapenv:Body>
</soapenv:Envelope>
Response code
Code 10-4 shows the response code for the exportSystemConfiguration command.
10 — System API
Code 10-4: exportSystemConfiguration response code example

<env:Header/>
<env:Body>
<exportSystemConfigurationResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/system/51/sy
stemConfiguration"
n"
<systemConfiguration>{
"DSCApplication": "CSB",
"Diameter": {
"Routes": [
{
"Active": true,
"Realm": "realm",
"Application": 1,
"Priority": 2,
"Description": "Default route required by NASREQ.
Please do not change it."
},
{
"Active": true,
"Realm": "realm",
"Application": 16777236,
"Priority": 2,
"Description": "Default route required by RESTful
API. Please do not change it."
}
],
"Learning": false,
{
"Scenario": 3,
},
{
10 — System API
"Scenario": 6,
},
{
"ApplicationID": 1,
"Scenario": 0,
},
{
"ApplicationID": 1,
"Scenario": 9,
},
{
"ApplicationID": 1,
"Scenario": 8,
},
{
"Scenario": 5,
},
{
"ApplicationID": 1,
"Scenario": 7,
},
{
"Scenario": 0,
10 — System API
},
{
"Scenario": 2,
},
{
"Scenario": 3,
},
{
"ApplicationID": 1,
"Scenario": 2,
},
{
"Scenario": 0,
},
{
"Scenario": 6,
},
{
"Scenario": 1,
},
10 — System API
{
"Scenario": 1,
},
{
"ApplicationID": 1,
"Scenario": 11,
},
{
"Scenario": 2,
},
{
"ApplicationID": 1,
"Scenario": 10,
},
{
"Scenario": 2,
},
{
"Scenario": 0,
},
{
10 — System API
"Scenario": 0,
},
{
"Scenario": 1,
},
{
"Scenario": 4,
},
{
"Scenario": 6,
}
]
},
{
"Value": "true"
},
{
"Value": "false"
},
{
"Value": "30"
}
],
"Peers": [{
"Active": true,
"Address": "138.120.54.52",
"Port": 3868,
"Protocol": "TCP",
"TLS": false,
"Role": "PCRF",
10 — System API
"Description": "PCRF cluster 'fireball.realm'"

}]
},
{
"Value": "24"
},
{
"Value": "2"
},
{
"Value": "02:00"
},
{
},
{
"Value": "true"
},
{
"Value": "30"
},
{
"Value": "15"
}
]},
{
"Value": "DSC_5_0_I1103 5780 Dynamic Services Controller
UNKNOWN Platform"
},
{
"Value": "marchrd"
},
{
"Value": "1.3.6.1.4.1.637.69.5.4.1.2"
}
]},
"NetworkIDs": [],
"Domains": [],
"APNs": [],
"IMSAPNs": []
},
10 — System API
}},
"Name": "RESTful API QoSFlow Session Cleanup Interval
(mins)",
"Value": "5"
}]},
"Policy": {
"SystemPreferences": [{
"Name": "Configuration Distribution OSSI Timeout (milli
secs)",
"Value": "60000"
}],
"SmsServers": [],
"EmailServers": [],
"WebServers": [],
"XmppServers": []
}
},
"NAS": {
"NASProfiles": [],
"NASClusters": []
},
"SPR": {"SystemPreferences": [
{
"Value": "300"
},
{
"Value": null
},
{
"Name": "Subscriber Data Expiry Time (seconds)",
"Value": "86400"
},
{
"Name": "Unknown Subscriber Expiry Time (seconds)",
"Value": "172800"
}
]},
"Common": {
"UserConfig": {
"Users": [],
"Roles": [
{
"Name": "Global",
"Create": true,
"Read": true,
"Update": true,
"Delete": true,
"Execute": true
},
{
10 — System API
"Create": false,
"Read": true,
"Update": false,
"Delete": false,
"Execute": false
}
]
},
{
"Value": "900000"
},
{
"Value": "false"
},
{
"Value": "30"
}
],
"PollInterval": 2,
}
},
"Value": "false"
}]}
}</systemConfiguration>
</exportSystemConfigurationResponse>
</env:Body>
</env:Envelope>
Response fields
Table 10-3 lists the fields required for the exportSystemConfiguration command.
Table 10-3 exportSystemConfiguration field descriptions
systemConfiguration Contains a set of configuration categories. Values: n/a

Type: string
10 — System API
10.4 importSystemConfiguration
Imports the local CSB system configuration if the request is addressed to the CSB,
or imports the local PCRF system configuration if the request is addressed to the
PCRF.
Parameter
• n/a.
Request code
Code 10-3 shows a request code example for the importSystemConfiguration
command.
Code 10-5: importSystemConfiguration request code example

<soapenv:Envelope
n" xmlns:ns="http://www.alcatellucent.com/dsc/systemapi/51">
<soapenv:Header>
<com:header>
</com:header>
</soapenv:Header>
<soapenv:Body>
<ns:importSystemConfiguration>
<ns:systemConfiguration>{
"DSCApplication": "PCRF",
{
"Value": "24"
},
{
"Value": "2"
},
{
"Value": "02:00"
},
{
},
{
"Value": "true"
},
{
10 — System API

"Value": "30"
},
{
"Value": "15"
}
]},
"WNG": {"SystemPreferences": [
{
"Name": "WNG Abusive Subscriber Event Audit Interval
(seconds)",
"Value": "2100"
},
{
"Name": "WNG Abusive Subscriber Event Inactivity Duration
(seconds)",
"Value": "2100"
},
{
"Name": "WNG Security & Attacks Event Audit Interval
(seconds)",
"Value": "600"
},
{
"Name": "WNG Security & Attacks Event Inactivity
Duration (seconds)",
"Value": "600"
},
{
"Name": "WNG Performance & Trend Event Audit Interval
(seconds)",
"Value": "3600"
},
{
"Name": "WNG Performance & Trend Event Inactivity
"Value": "3600"
}
]},
"PCRF": {
{
"Name": "IP CAN Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "IP CAN Session Audit Interval Offset
(seconds)",
"Value": "7200"
},
{
"Name": "S9 Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "S9 Session Audit Interval Offset (seconds)",
10 — System API
"Value": "7200"
},
{
"Name": "AF Session Audit Interval (seconds)",
"Value": "259200"
},
{
"Name": "AF Session Audit Interval Offset (seconds)",
"Value": "7200"
},
{
"Name": "Gateway Control Session Audit Interval
(seconds)",
"Value": "259200"
},
{
"Name": "Gateway Control Session Audit Interval
Offset (seconds)",
"Value": "7200"
},
{
"Name": "NASREQ Session Audit Interval (seconds)",
"Value": "86400"
},
{
"Name": "NASREQ Session Audit Interval Offset
(seconds)",
"Value": "7200"
},
{
"Name": "NASREQ Session Auto ReAuth on Rule Reload",
"Value": "false"
},
{
"Name": "Auxiliary Gx Session Audit Interval
(seconds)",
"Value": "259200"
},
{
"Name": "Auxiliary Gx Session Audit Interval Offset
(seconds)",
"Value": "7200"
},
{
"Name": "IP CAN Session Inactivity Duration
(seconds)",
"Value": "259200"
},
{
"Name": "S9 Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "Gateway Control Session Inactivity Duration
(seconds)",
"Value": "259200"
},
10 — System API
{
"Name": "AF Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "NASREQ Non-Started Session Inactivity
"Value": "86400"
},
{
"Name": "NASREQ Started Session Inactivity Duration
(seconds)",
"Value": "259200"
},
{
"Name": "Auxiliary Gx Session Inactivity Duration
(seconds)",
"Value": "259200"
},
{
"Name": "IP CAN Session Auto ReAuth on Rule Reload",
"Value": "false"
},
{
"Name": "IP CAN Session ReAuth Scheduler Interval
(seconds)",
"Value": "3600"
},
{
"Name": "NASREQ Session ReAuth Scheduler Interval
(seconds)",
"Value": "3600"
},
{
"Name": "IP CAN Session ReAuth Scheduler Interval
Offset (seconds)",
"Value": "5"
},
{
"Name": "NASREQ Session ReAuth Scheduler Interval
Offset (seconds)",
"Value": "5"
},
{
"Name": "Default 3GPP Version",
"Value": "june-2011"
},
{
"Name": "Usage Reset Schedule Interval (seconds)",
"Value": "3600"
},
{
"Name": "Default Volume Quota (bytes)",
"Value": "1000000000"
},
{
"Name": "Default Time Quota (seconds)",
10 — System API
"Value": "3600"
},
{
"Name": "Sy OCS Realm",
"Value": ""
},
{
"Name": "Sy Specification Type",
"Value": "3GPP"
},
{
"Name": "Quota Allocation Factor (%)",
"Value": "20"
},
{
"Name": "Enable Accounting Record Logging",
"Value": "true"
},
{
"Name": "Metering Limit Priority Order - Low to High",
"Value": "true"
},
{
"Name": "Metering Limit Base Unit Rounding Type",
"Value": "up"
},
{
"Name": "Bypass Validation of Origin Host and Realm",
"Value": "false"
},
{
"Name": "Disable RAR for stale sessions",
"Value": "false"
},
{
"Name": "Metering Limit Prorate",
"Value": "false"
},
{
"Name": "Sd Session Re-Establishment Audit Interval
(seconds)",
"Value": "3600"
},
{
"Name": "Sd Session Re-Establishment Audit Interval
Offset (seconds)",
"Value": "60"
},
{
"Name": "Gx RAR Send Delay (milliseconds)",
"Value": "0"
},
{
"Name": "Sy OCS Enabled",
"Value": "false"
},
{
10 — System API
"Name": "Sy Register Dynamic Variable Notification",

"Value": "false"
}
],
"DiameterClients": []
},
"NetworkIDs": [],
"Domains": [],
"APNs": [],
"IMSAPNs": []
},
}},
"ReportingAPI": {"SystemPreferences": [
{
"Name": "Reporting API Cache Audit Interval (seconds)",
"Value": "905"
},
{
"Name": "Reporting API Cache Location",
"Value": "\/opt\/tpa\/reporting\/cache"
},
{
"Name": "Reporting API Cache Timeout (seconds)",
"Value": "900"
},
{
"Name": "Reporting API Max Concurrent Requests",
"Value": "1"
},
{
"Name": "Reporting API Result Page Size",
"Value": "50000"
}
]},
"Common": {
{
"Value": "900000"
},
{
"Value": "false"
},
{
"Value": "30"
}
],
"PollInterval": 2,
10 — System API
},
"UserConfig": {
"Users": [],
"Roles": [
{
"Name": "Global",
"Create": true,
"Read": true,
"Update": true,
"Delete": true
},
{
"Name": "Allow Reset Usage",
"Create": false,
"Read": false,
"Update": false,
"Delete": false
},
{
"Create": false,
"Read": true,
"Update": false,
"Delete": false
}
]
},
"ExternalSystems": []
},
"Notification": {
"SystemPreferences": [],
"SmsServers": [],
"EmailServers": [],
"WebServers": [],
"XmppServers": [],
"RestWebServers": []
}
},
"Value": "true"
}]},
"GUI": {"SystemPreferences": [
{
"Name": "GUI Session Inactivity Timeout (mins)",
"Value": "60"
},
{
"Name": "External SPR Local Write Override",
"Value": "false"
}
]},
"Diameter": {
"Peers": [
10 — System API
{
"Active": false,
"OriginHost": "clientHost.clientRealm",
"Address": "138.120.140.36",
"Port": 4000,
"Protocol": "TCP",
"TLS": false,
"Role": "ROUTING_AGENT",
"Description": "test client 1"
},
{
"Active": false,
"OriginHost": "clientHost1.clientRealm1",
"Address": "138.120.140.36",
"Port": 4001,
"Protocol": "TCP",
"TLS": false,
"Role": "ROUTING_AGENT",
"Description": "test client 2"
}
],
"Learning": false,
"DiameterRequestTimeout": 2990,
{
"Scenario": 1,
},
{
"Scenario": 1,
},
{
"Scenario": 5,
10 — System API
},
{
"Scenario": 0,
},
{
"ApplicationID": 1,
"Scenario": 2,
},
{
"Scenario": 2,
},
{
"Scenario": 4,
},
{
"Scenario": 6,
},
{
"Scenario": 2,
},
{
10 — System API
"ApplicationID": 1,
"Scenario": 0,
},
{
"Scenario": 3,
},
{
"Scenario": 6,
},
{
"ApplicationID": 1,
"Scenario": 7,
},
{
"Scenario": 6,
},
{
"Scenario": 0,
},
{
"ApplicationID": 1,
"Scenario": 9,
10 — System API
},
{
"Scenario": 1,
},
{
"Scenario": 0,
},
{
"Scenario": 2,
},
{
"Scenario": 3,
},
{
"Scenario": 0,
},
{
"ApplicationID": 1,
"Scenario": 10,
10 — System API
},
{
"ApplicationID": 1,
"Scenario": 8,
},
{
"ApplicationID": 1,
"Scenario": 11,
}
]
},
"Routes": [],
{
"Value": "true"
},
{
"Name": "RFC-3588: Non-Compliant Origin-State-Id
Value",
"Value": "1"
},
{
"Name": "RFC-3588: Use Compliant Origin-State-Id",
"Value": "true"
},
{
"Value": "false"
},
{
"Value": "30"
}
]
},
{
"Value": "DSC_5_1_I1249 5780 Dynamic Services Controller
UNKNOWN Platform"
},
{
"Value": "marchrd"
},
10 — System API
{
"Value": "1.3.6.1.4.1.637.69.5.4.1.2"
}
]},
"Name": "RESTful API QoSFlow Session Cleanup Interval
(mins)",
"Value": "5"
}]},
"MeasurementJobSchedules": {"JobSchedule": []},
"Policy": {"SystemPreferences": [{
"Name": "Configuration Distribution OSSI Timeout (milli
secs)",
"Value": "60000"
}]},
"Gateway": {"SystemPreferences": [
{
"Name": "RADIUS Gateway Cache Audit Interval (seconds)",
"Value": "86400"
},
{
"Name": "RADIUS Gateway Cache Inactivity Duration
(seconds)",
"Value": "3600"
}
]},
"NAS": {
"NASProfiles": [],
"NASClusters": []
},
"SPR": {
{
"Value": "300"
},
{
"Value": "3"
},
{
"Name": "Account Data Expiry Time (seconds)",
"Value": "86400"
},
{
"Name": "Unknown Account Expiry Time (seconds)",
"Value": "172800"
},
{
"Name": "SPR Event Queue Maximum Size",
"Value": "1000000"
},
{
"Name": "Unused Subscriber Expiry Time (days)",
"Value": "60"
10 — System API
},
{
"Name": "Write Last Session Terminate Time to
Subscriber Record",
"Value": "false"
}
],
"ProfileConfiguration": {"SubscriberProfiles": []}
}
}</ns:systemConfiguration>
</ns:importSystemConfiguration>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 10-4 lists the fields required for the importSystemConfiguration command.
Type: string
Default: empty
Response code
Code 10-4 shows the response code for the importSystemConfiguration command.
Code 10-6: importSystemConfiguration response code example

<env:Header/>
<env:Body>
<importSystemConfigurationResponse
xmlns="http://www.alcatellucent.com/dsc/systemapi/51"
n"
>
</env:Body>
</env:Envelope>
10 — System API
11 — Ud Notification API
11.1 Using the Ud notification API 11-2
11.2 notification 11-3
11.1 Using the Ud notification API
The 5780 DSC has implemented a portion of 3GPP TS 29.335 v11.0.0 (2012-09)
User Data Convergence (UDC); User Data Repository Access Protocol over the Ud
interface; Stage 3 and User Data Convergence (UDC); Technical realization and
information flows; Stage 2.
The 5780 DSC supports integration with external SPR using the SPR plug-in
framework. You must install a customer-specific Ud plug-in to use the Ud
notification API. The plug-in must be installed on the CSB and PRCF, or just PCRF
depending on your configuration. For more information, see your customer-specific
user documentation.
Note — The 5780 DSC Ud implementation in Release 5.1 R4 is

limited to notification.
• All Ud message content is ignored with the exception of
identification (that is, notification object attributes). This is subject
to change in future releases.
• Delete subscriber notification would result in the removal of the
subscriber and its associated account in 5780 DSC.
• An HTTP 200 (OK) status code response received without a
header is treated as an error.
• Upon receiving a “modify” notification, the 5780 DSC triggers a
reload of the entire subscriber record.
• Subscription procedure is not supported. Notifications are
processed in the order they arrive. The 5780 DSC would still
process older messages that arrive to the 5780 DSC at a later point
in time once its successors have been processed by 5780 DSC.
• The supported SOAP version is 1.2.
• The API assumes that the subscriber is created before any updates
can occur. If the subscriber is not created, notification will be
rejected.
• The 5780 DSC only supports one notification per message.
Error codes
Table 11-1 describes the HTTP error codes that may be generated and the possible
reason(s) they are returned.
Note — For the error codes described in Table 11-1, you should only
retry/resend for error code 500.
Table 11-1 Error code mapping
Error Code Description
409 Indicates missing subscribers.
403 Indicates OSSI security, bad information (DN or objectClass or

any other badly formatted values).
500 Returned for all temporary and unknown problems.
501 Indicates unsupported operations/functionality (for example,

‘add’ or ‘none’).
11.2 notification
Notifications can be triggered by UDR for modify and delete operations, and are
processed in the order they arrive.
Note 1 — The 5780 DSC only processes modify and delete
notification operations. The add and none notifications are rejected
and should be filtered at the source to reduce the load on the 5780
DSC.
Note 2 — Since subscription is currently not supported by the
5780 DSC, a third-party should do it on the behalf of the 5780 DSC.
Parameters
• object
Defines the subscriber or accounts on which the notification is arriving.
SOAP message envelope header

The notification request messages use the HTTP Post method and contain a SOAP
message envelope. Notification response messages are coded as HTTP response
messages and contain a SOAP message envelope.
A Correlation header is mandatory in the SOAP message, as defined in 3GPP TS
29.335 User Data Convergence (UDC); User Data Repository Access Protocol over
the Ud interface. The header field must be non-null.
Notify request and response messages contain a SOAP message envelope header
with a header block containing the elements shown in Table 11-2.
Table 11-2 Header field descriptions
serviceName This optional element identifies a service in the Front End. Values: Any non-null and Optional
The value is copied from the Subscribe message or non-empty string up to 20
pre-configured in the UDR. The serviceName is of type characters.
string with up to 20 characters Type: string
Default: DEFAULT
msgId This element uniquely identifies the Notify message Values: 0 to 2^31 - 1. Optional
request - response pair within a connection. The msgId is Type: integer
of type integer. The UDR shall allocate the value and use
it together with the connId (if any) to correlate a received Default: n/a
notify response with a sent notify request. Mandatory.
Message order from a source is not currently verified
currently using this Id and connection Id.
connId This optional element identifies the connection between Values: 0 to 2^31 - 1. Mandatory
the UDR and the FE. The connId is of type integer. If used, Type: integer
the value is allocated by the UDR and is used together with
the msgId to correlate a notify response with a notify Default: n/a
request.
Request code
Code 11-1 shows a request code example for the notification command.
Code 11-1: notification request code example

<soapenv:Envelope
xmlns:urn="urn:headerblock"
xmlns:not="http://www.3gpp.org/udc/notification">
<soapenv:Header>
<urn:CorrelationHeader>
<serviceName>PCRF</serviceName>
<msgId>m123123</msgId>
<connId>c123</connId>
</urn:CorrelationHeader>
<soapenv:Body>
<not:notification>
<not:object objectClass="UserProfile" DN="example"
operation="modify">
<not:attribute name="test" modification="add">
<not:currentValue>12</not:currentValue>
</not:attribute>
</not:object>
</not:notification>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 11-3 lists the fields required for the notification command.
Table 11-3 notification request field descriptions
object Defines the subscriber or accounts on which the

notification is arriving.
objectClass Values: Optional

The entity class name for which the subscription applies. Type: xs:string
Default:
DN Values: : Any valid string Optional

The Distinguished Name of the entity. Type: xs:string
Default:
operation Values: Optional

The 5780 DSC only processes modify and delete • modify
notification operations. The add and none notifications are • delete
rejected and should be filtered at the source to reduce the
load on the 5780 DSC. Type: enum
Note: The subscriber is refreshed on a modify notification Default: none
operation. The delta content in the notification is not
processed.
attribute Values: Any valid string value Optional

Currently not supported. Type: string
Default:
Response code
Code 11-2 shows the response code for the notification command.
Code 11-2: notification response code example

<soapenv:Envelope
xmlns:urn="urn:headerblock"
xmlns:not="http://www.3gpp.org/udc/notification">
<soapenv:Header>
<urn:CorrelationHeader>
<serviceName>PCRF</serviceName>
<msgId>m123123</msgId>
<connId>c123</connId>
</urn:CorrelationHeader>
</soapenv:Header>
<soapenv:Body/>
</soapenv:Envelope>
Response fields
Table 11-4 lists the fields required for the notification command.
Table 11-4 Correlation Header field descriptions
serviceName This element identifies a service in the Front End. The Values: Any non-null and Optional
value is copied from the Subscribe message or non-empty string up to 20
pre-configured in the UDR. The serviceName is of type characters.
string with up to 20 characters Type: string
Default: DEFAULT
msgId This element uniquely identifies the Notify message Values: 0 to 2^31 - 1. Optional
request - response pair within a connection. The msgId is Type: integer
of type integer. The UDR shall allocate the value and use
it together with the connId (if any) to correlate a received Default: n/a
notify response with a sent notify request. Message order
from a source is not currently verified currently using this
Id and connection Id.
connId This optional element identifies the connection between Values: 0 to 2^31 - 1. Mandatory
the UDR and the FE. The connId is of type integer. If used, Type: integer
the value is allocated by the UDR and is used together with
the msgId to correlate a notify response with a notify Default: n/a
request.
12 — RESTFul API reference
12.1 5780 DSC RESTful API overview 12-2
12.1 5780 DSC RESTful API overview
The Application Enablement RESTful API provides two easy-to-use interfaces, QoS
Flow and Relay, for non-Diameter based applications to create and/or modify
service data flow policies and charging rules via common internet protocol
http/https.
Application QoS Integration using RESTful APIs

The 5780 DSC can be used to request a specified QoS on flows using Rx. In addition
to Rx, the 5780 DSC provides the ability to make application flow requests using
XML over the RESTful API. Over the RESTful API, the following types of flow
request mechanisms are supported: QoS flow requests and Rx relay requests.
Any flow request to the 5780 DSC requires information based on the Rx interface
requirements. A QoS flow request is a simplified request in which minimal
information is required for a flow request. The remainder of the information is
provided depending on the previous settings or default values to formulate a
complete flow request.
The Rx relay request uses XML instead of Diameter to make flow requests using Rx.
The XML information requirements of Rx Relay requests are the same as typical
Diameter-based Rx requests.
Note — You must create settings for the QoS flow mode before you
create the session; however, it is optional for Rx relay mode.
Specifying the Charging-Identifier in a QoS Flow message is
optional.
The RESTful APIs are located in the ALATPArestfulapi package.
QoS flow
The QoS flow session mode allows you to use a set of tags to set up the required QoS
for a data flow. In the context of the guaranteed QoS for Application Establishment
over a RESTful API, the requests are called QoS flow requests.
QoS flow requests allow you to manage the resources on the 5780 DSC and use the
following HTTP methods:
• POST—creates a resource state
• PUT—modifies a resource state
• GET—queries a resource state
• DELETE—deletes a resource state
Caution — If you attempt to POST an XML file that has an empty

line at the top of the file, the POST operation fails.
When you perform an HTTP POST to the 5780 DSC, you create a QoS flow by
typing:
HTTP POST http://dscserver/rxaf/qosflow/category/sessions
Code 12-1: QoS flow code

<session>
<ue id="joe@moes.com" ipAddr="1.2.3.4" port="4242"/>
<server ipAddr="4.5.6.7" port="8998"/>
<bandwidth uplink="128000" downlink="5000000"/>
<duration>3600</duration>
<chargingId>GoldFlows</chargingId>
</session>
You need to specify the subscriber, bandwidth and QoS level, server ID, and duration
(optional) for the QoS flow API.
Figure 12-1 shows the flow of information for a QoS flow request.
Figure 12-1 QoS flow request
Service 5780 DSC PGW/

Provider BNG
Start HTTP post QoS Flow

flow
Failure N Flow
allowed
Y
Success; Session mytv3 Gx RAR Changing-Rule-Install
N
Accept
HTTP POST QoS Flow
Failure (mytv3)
Y
Start HTTP delete QoS Flow (mytv3)
Gx RAR Changing-Rule-Remove
flow
21211
A QoS flow request starts when the data related to a QoS flow is posted to the
5780 DSC. The 5780 DSC verifies whether the subscriber identified in the request is
authorized for admission based on the SPR information of the subscriber and the
location of the UE.
If the subscriber is not authorized due to constraints applied by the SPR information
or location of the UE, the request is rejected. If the subscriber is authorized and the
5780 DSC considers the request to be valid, the 5780 DSC returns the corresponding
session id, which may be used for subsequent updates or queries related to the
session.
When the request is valid, the 5780 DSC then formulates a PCC rule and sends the
request over the Gx interface to the relevant gateway. The gateway may accept or
reject the request based on resource availability. A rejection from the gateway is sent
from the 5780 DSC as a notification using HTTP and a successful installation of a
PCC rule is noted. Additional messages are not sent to the content provider.
A QoS flow request must identify the following key elements related to the flow and
validation of the request against the entitlements of the identified subscriber in order
to send the request to the appropriate mobile gateway or BNG:
• identity of the user for whom a request is being placed
• endpoint information (IP address and port) at the user end
• endpoint information (IP address and port) at the network end
• type of information in play
• charging identifier that is used for billing correlations
• application identifier for the type of service for which the request is made
Note 1 — You can request the QoS flow for a specific duration. In the
above example, the flow is automatically terminated after the duration
time (in seconds) has elapsed.
Note 2 — A previously allowed request may be rejected because of a
change in network conditions.
When interacting with the 5780 DSC, the resource states are accessed using the
following URL format:
• https://dscserver:8443/rxaf/qosflow/category/sessions
• https://dscserver:8443/rxaf/qosflow/category/settings
The 5780 DSC provides a mechanism to specify common information for a category
of flows using category-specific settings. Category settings can be specified using
the following URL:
http://dscserver/rxaf/qosflow/category/settings
A category is any arbitrary string that contains the following characters:
• a to z
• A to Z
• 0 to 9
Codes 12-2 and 12-3 show settings in which two categories of video applications are
used (mytvhd and mytvsd). The category settings must first be specified to the
5780 DSC.
Code 12-2: URL for mytvhd

HTTP POST https://dscserver:8443/rxaf/qosflow/mytvhd/settings
<settings>
<afApplicationId>mytvhd</afApplicationId>
<protocol>6</protocol>
<subscriptionIdType>END_USER_NAI</subscriptionIdType>
<notificationURL>http://www.acmetv.com/rxnotify</notificationURL>
</settings>
Code 12-3: URL for mytvsd

HTTP POST https://dscserver:8443/rxaf/qosflow/mytvsd/settings
<settings>
<afApplicationId>mytvsd</afApplicationId>
</settings>
After you specify the settings for a category of flows, flows of the category may be
created using the following URL:
https://dscserver:8443/rxaf/qosflow/category/sessions
The notificationURL tag specifies the web server URL that accepts notifications
related to the QoS flow sessions. For example, if radio conditions degrade so that a
QoS flow session is terminated, a notification is sent to the notification URL
indicated in the tag.
Table 12-1 shows the HTTP methods using the category examples from Codes 12-2
and 12-3.
Table 12-1 Methods available
To Use method Result

Create a QoS flow HTTP POST https://dscserver:8443/rxaf/qosflow/mytvhd/sessions Returns a session id.
session
Query the session HTTP GET https://dscserver:8443/rxaf/qosflow/mytvhd/sessions/sessionId Queries the session.

after creation
Delete the session HTTP DELETE https://dscserver:8443/rxaf/qosflow/mytvhd/sessions/sessionId Deletes the session.

Get all sessions for HTTP GET https://dscserver:8443/rxaf/qosflow/mytvhd/sessions Returns the sessions
the category for the category.
The request must then become an AAR message. An AAR message can be one of the
following types of AVPs:
• an AVP type that the RESTful gateway can get from its information
• an AVP type that the RESTful information can use for default values
• AVP types that are common to a <category> of QoS flow sessions
A <<category>> is an arbitrary partition in the namespace. All of the QoS Flow
sessions are created in the context of a category. The AVPs that are common to a
category of QoS flow sessions are specified as category settings, and do not need
to be specified repeatedly.
• AVP types that are specific to a QoS flow session. All QoS flow sessions are
created in the context of a <category>.
Code 12-4 shows how the request becomes an AAR message.
Code 12-4: Example QoS flow as an AAR message

<settings>
<afApplicationId>mytvhd</afApplicationId>
</settings>
Plus
<session>
<ue id="joe@moes.com" ipAddr="1.2.3.4" port="4242"/>
<server ipAddr="4.5.6.7" port="8998"/>
<bandwidth uplink="128000" downlink="5000000"/>
<duration>3600</duration>
<chargingId>GoldFlows</chargingId>
</session>
Equals
IPFilterRule ::= ue.ipAddr + up.port + server.ipAddr + server.port

<AA-Request> ::= < Diameter Header: 265, REQ, PXY >
< Session-Id >
{ Auth-Application-Id }
{ Origin-Host }
{ Origin-Realm }
{ Destination-Realm }
[ Destination-Host ]
[ AF-Application-Identifier = settings.afApplicationId ]
*[ Media-Component-Description ] ::= < AVP Header: 517 >
Rx relay
Although the QoS flow mechanism may be adequate for many QoS-based flow
enhancements, some applications require finer control over the settings. The Rx
relay API provides the access to an XML variation of Rx and to Diameter Rx
gateway functionality for more complex flows.
The Rx relay mechanism provides the capabilities of Rx without the complexities of
Diameter session management. N-way conferencing, which is possible in Rx by
specifying multiple flows, is an example where the Rx relay mechanism is used.
The 5780 DSC provides an interface to map any Diameter message into XML and
send the message to the 5780 DSC. The Rx relay mode only requires that you create
an Rx session and configure the notification URL as a setting. The notification URL
is used to receive session updates. Code 12-5 shows the settings and session creation.
Code 12-5: Rx Relay

HTTP POST https://dscserver:8443/rxaf/qosflow/rxrelay/settings
<settings>
</settings>
HTTP POST https://dscserver:8443/rxaf/qosflow/rxrelay/sessions
Example Diameter message

Code 12-6 shows an example of the Diameter message from an Rx Relay session.
Code 12-6: Diameter message

HTTP POST https://dscserver:8443/rxaf/qosflow/rxrelay/sessions
<diameterMessage xmlns="diameterRequest"
application="Rx"
command="AA-Request"
destinationRealm=""

<simpleAVP name="AF-Application-Identifier" value="testClient"/>
<simpleAVP name="Service-Info-Status" value="1"/>
<groupedAVP name="Media-Component-Description">
<simpleAVP name="Media-Component-Number" value="1"/>

<simpleAVP name="AF-Application-Identifier"
value="6e657374656441664964" conversion="hex"/>
<simpleAVP name="Media-Type" value="3"/>

<simpleAVP name="Max-Requested-Bandwidth-UL" value="10"/>
<simpleAVP name="Max-Requested-Bandwidth-DL" value="20"/>
<simpleAVP name="Flow-Status" value="1"/>
<groupedAVP name="Media-Sub-Component">
<simpleAVP name="Flow-Number" value="1"/>

<simpleAVP name="Flow-Usage" value="0"/>
<simpleAVP name="Flow-Description"
value="permit in ip from 1.2.3.4 to 3.4.5.6"/>
value="permit out ip from 3.4.5.6 to 1.2.3.4"/>
</groupedAVP>


value="permit in ip from 1.2.3.4 to any"/>
value="permit out ip from any to 1.2.3.4"/>
</groupedAVP>
</groupedAVP>

<groupedAVP name="Media-Component-Description">
<simpleAVP name="Media-Component-Number" value="2"/>

<simpleAVP name="Media-Type" value="0"/>


<simpleAVP name="Flow-Usage" value="0"/>
value="permit in ip from 1.2.3.4 to 3.4.5.6"/>
value="permit out ip from 3.4.5.6 to 1.2.3.4"/>
</groupedAVP>

value="permit in ip from 1.2.3.4 to any"/>
</groupedAVP>
</groupedAVP>

<simpleAVP name="Af-Charging-Identifier" value="6d7942696c6c"
conversion="hex"/>
<simpleAVP name="SIP-Forking-Indication" value="0"/>

<simpleAVP name="Specific-Action" value="0"/>
<simpleAVP name="Specific-Action" value="3"/>
<groupedAVP name="Subscription-Id">
<simpleAVP name="Subscription-Id-Type" value="0"/>

<simpleAVP name="Subscription-Id-Data"
value="mySubscriptionIdData"
conversion="ascii"/>
</groupedAVP>
<simpleAVP name="Reservation-Priority" value="7"/>

<simpleAVP name="Framed-IP-Address" value="31302e312e312e31"
conversion="hex"/>
<simpleAVP name="Framed-IPv6-Prefix"
value="10FA:6604:8136:6502::/64"/>
<simpleAVP name="Service-URN" value="sos.ambulance"/>
</diameterMessage>
A. Differences in the API
A.1 Differences between the 4.0 and 5.1 API A-2
A.2 Differences between the 5.0 and 5.1 API A-3
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 A-1
A.1 Differences between the 4.0 and 5.1 API

This section describes the differences between the 4.0 and 5.1 API.
Subscriber provisioning API

For the subscriber provisioning API, the 5.1 version of the API has introduced the
concept of accounts. Some subscriber fields have been moved to the new account
object, which causes differences in the content used for the operations and operation
parameters.
As a result, the subscriber object has a new version. For example, the meteringLimit
field has moved from subscriber to the account, and new fields such as
resetDayOfWeek and resetHourOfDay have been introduced. In addition,
billingDay, previously a subscriber field, has been moved to the account object and
renamed to resetDayOfMonth.
See Table 1-2 for list of the new operations introduced in 5.1.
For more information about the 4.0 version of the WS API, see the 5780 DSC
Release 4.0 or 5.0 API documentation. You can also compare the schema in the
WSDLs to see the differences between the old and new version of the objects. For
more information about accounts, see the 5780 DSC User Guide.
NASREQ and IP-CAN session APIs

For the IP-CAN session API, some new parameters were added to the getSession
API response (for example, afSessionId and sySessionId fields). See section 6.2 for
information.
Subscriber profile provisioning API

For the subscriber profile provisioning API, new operations were added to manage
the new customDataProfile field of the Subscriber profile. For example, the
CustomDataProfiles field was added to the SubscriberProfile object.
See Table 1-2 for list of the new operations introduced in 5.1.
Reporting APIs
The 4.0 Reporting APIs have been deprecated and replaced by the Streaming
reporting APIs.
System APIs
The 5780 DSC system API has been introduced in 5.1 and is used to perform
operations related to exporting system configuration data. New operations
introduced with this API include exportPcrfSystemConfiguration,
exportSystemConfiguration, and importSystemConfiguration.
Ud API
The Ud API has been introduced in 5.1 and implements a portion of 3GPP
A-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
TS 29.335 User Data Convergence (UDC); User Data Repository Access

Protocol over the Ud interface; Stage 3 and User Data Convergence (UDC);
Technical realization and information flows; Stage 2.
See Table 1-2 for list of the new operation introduced in 5.1.
Af Session API
The Af Session API has been introduced in 5.1 and is used to query informa-
tion related to AF sessions. Session modification is not possible using this
API.
Sy Session API
The Sy Session API has been introduced in 5.1 and is used to query informa-
tion related to Sy sessions. Session modification is not possible using this
API.
Rule provisioning API

For the Rule provisioning API, the importRuleSystemVersion and expor-
tRuleSystemVersion operations were introduced, as well as getActiveRule-
SystemVersionName and getRuleSystemVersionNames.
Streaming reporting API

For the Streaming reporting API, ListAFSessionSummary is introduced to return a
list of AF session summaries for all AF sessions, ListIPCanSessionSummary is
introduced to return a list of IP-CAN session summaries for all IPCan sessions and
ListSYSessionSummary is introduced to return a list of Sy session summaries for all
Sy sessions.
A.2 Differences between the 5.0 and 5.1 API
This section describes the differences between the 5.0 and 5.1 API.
Streaming reporting API

For the Streaming reporting API, ListAccountsWithFilter was introduced to merge
the functionality of ListSubscribers and ListSubscribersWithFilter. Both
ListSubscribers and ListSubscribersWithFilter have been removed.
In addition, some new parameters were added to the ListAccountsWithFilter API

(for example, NASCOAFAILEDSTATUS). See Table 1-2 for list of the new
operations introduced in 5.1, and Table 9-1. The supported operations can now be
viewed through the service url: http://[host]/reporting/streaming/dsc51.
Customer documentation and product support
Customer documentation
http://www.alcatel-lucent.com/myaccess
Product manuals and documentation updates are available at
alcatel-lucent.com. If you are a new user and require access to this
service, please contact your Alcatel-Lucent sales representative.
Technical Support
http://support.alcatel-lucent.com
Documentation feedback
documentation.feedback@alcatel-lucent.com
© 2012-2013 Alcatel-Lucent. All rights reserved.

5780 DSC API Reference Manual

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

5780 DSC API Reference Manual

Uploaded by

Copyright:

Available Formats

API REFERENCE MANUAL

Copyright 2012-2013 Alcatel-Lucent.

When printed by Alcatel-Lucent, this document is printed on recycled paper.

2. PROTECTION AND SECURITY OF LICENSED PROGRAMS

5. SUPPORT AND UPGRADES

6. WARRANTIES AND INDEMNIFICATION

5780 DSC documentation suite

Table 1 5780 DSC documentation set

Title Description Part number

Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 ix

Title Description Part number

x May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4

Procedure 1 To find the 5780 DSC user documentation

The user documentation is available from the following sources:

• the top level of the product DVD:

Note — Users of Mozilla browsers may receive an error message when

Alcatel-Lucent recommends changing the offline storage (Mozilla

Searching for information in this guide

Procedure 2 To search for specific information in this guide

3 Enter the search criteria.

4 Click on the In the current PDF Document radio button.

Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xi

5 Select the following search criteria, if required:

• Whole words only

Procedure 3 To search for specific information in multiple 5780 DSC

1 Open the Adobe Reader.

3 Enter the search criteria.

4 Click on the All PDF Documents in radio button.

5 Choose the folder in which to search using the drop-down menu.

6 Select the following search criteria, if required:

• Whole words only

Table 2 Documentation conventions

Convention Description Example

Key name Press a keyboard key. Delete

Italics Italics identifies a variable. hostname

Key+Key Type the appropriate consecutive keystroke sequence. CTRL+G

* An asterisk is a wildcard character, which means “any character” log_file*.txt

↵ Press the Return key. ↵

— An em dash indicates there is no information. —

Convention Description Example

User-defined Appears in examples of code to denote user-defined parameters. <password>password</password>

Procedures with options or substeps

Example of options in a procedure

a This is one option.

b This is another option.

2 You must perform this step.

Example of substeps in a procedure

i This is the first substep.

ii This is the second substep.

iii This is the third substep.

2 You must perform this step.

Table 3 Bits and bytes conventions

kilobits per second kb/s

Glossary entries in this documentation set

Warning — Warning indicates that the described activity or situation

Caution — Caution indicates that the described activity or situation

Note — Notes provide information that is, or may be, of special

Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xv

1— 5780 DSC API reference 1-1

2— Subscriber provisioning API 2-1

2.11 getCustomDataProfiles ................................................................ 2-42

Response code ....................................................................... 2-70

xx May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4

2.29 updateAccountCustomDataProfiles................................................ 2-103