Академический Документы
Профессиональный Документы
Культура Документы
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.
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.
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.
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).
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 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)
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)
The mibs directory in the product DVD contains all the .mib files packaged in the
product.
2 Choose Edit→Search from the Acrobat Reader main menu. The Search panel
appears.
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.
Note — The PDF files that you search must be in the same folder.
2 Choose Edit→Search from the Adobe Reader main menu. The Search panel
appears.
xii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Preface
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.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xiii
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Preface
→ A right arrow indicates that a cascading submenu opens when you Policies→Routing
choose a menu item.
(2 of 2)
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:
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:
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
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Preface
Measurement Symbol
bit b
byte byte
Important information
The following conventions are used to indicate important information.
Contact information
If you have questions or comments about this documentation, contact:
documentation.feedback@alcatel-lucent.com
xvi May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xvii
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xviii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xix
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxi
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xxii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxiii
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xxiv May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxv
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xxvi May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxvii
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xxviii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxix
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xxx May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 xxxi
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
Contents
xxxii May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1— 5780 DSC API reference
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
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.
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
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
1-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
getAccountCustomData — — 5.1R1 Gets the set of custom data objects from 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.
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.
getSubscriptionIds 4.0R1 — 5.1R1 Gets the subscription ids from the subscriber
object.
(1 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
resetUsage 4.0R1 — 5.1R1 Resets the usage data to zero for the specified
subscriber object.
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.
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.
(2 of 6)
1-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
Subscriber updateSubscriptionId 4.0R1 — 5.1R1 Updates the subscriber by replacing the specified
provisioning old subscription id with the specified new
(continued) subscription id.
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
subscriber profile object.
getQciGuaranteedBitRates 4.0R3 — 5.1R1 Gets the list of QCI guaranteed bit rates from the
subscriber profile object.
getQciMaxBitRates 4.0R3 — 5.1R1 Gets the list of QCI maximum bit rates from the
subscriber profile object.
getSubscriberProfileCustomData 4.0R3 — 5.1R1 Gets the set of custom data entries from the
subscriber profile object.
getSubscriberProfileCustomDataProfiles — — 5.1R1 Gets the set of custom data profiles from the
subscriber profile object.
removeSubscriberProfile 4.0R3 — 5.1R1 Removes the subscriber profile object.
updateAFApplications 4.0R3 — 5.1R1 Updates all the AF application entries for the
subscriber profile object.
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.
(3 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
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.
getActiveRuleSystemVersionName — — 5.1R2 Gets the active rule system version by the name
specified.
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.
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
(4 of 6)
1-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
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.
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.
(5 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
ListIPCANSessionSummary — 5.0R5 5.1R2 Returns a list of IP-CAN session summaries for all
IP-CAN sessions.
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.
(6 of 6)
1-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
<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.
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.
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
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 1-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
1 — 5780 DSC API reference
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.
1-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2— Subscriber provisioning API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2.2 addAccount
Parameter
• account
Indicates the account to be added.
Request code
Code 2-1 shows a request code example for the addAccount command.
2-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<sub:password>pass123</sub:password>
<!--Optional:-->
<sub:description>subnew1 desc</sub:description>
<!--Optional:-->
<sub:unknownSubscriber>false</sub:unknownSubscribe
r>
<!--Optional:-->
<sub:state>ENABLED</sub:state>
<!--Optional:-->
<sub:subscriptionIds>
<!--Zero or more repetitions:-->
<sub:subscriptionId>
<sub:value>33012000091223</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriptionIds>
<!--Optional:-->
<sub:notificationConfig>
<!--Optional:-->
<sub:emailAddress/>
<!--Optional:-->
<sub:mobileNumber/>
<sub:notifyableByEmail>false</sub:notifyableByE
mail>
<sub:notifyableBySMS>false</sub:notifyableBySMS
>
</sub:notificationConfig>
<!--Optional:-->
<sub:allowOverage>true</sub:allowOverage>
<sub:syOCSEnabled>false</sub:syOCSEnabled>
<!--Optional:-->
<sub:subscriberProfiles>
<!--Zero or more repetitions:-->
<sub:subscriberProfile>subprofile1</sub:subscri
berProfile>
</sub:subscriberProfiles>
<!--Optional:-->
<sub:customData>
<!--Zero or more repetitions:-->
<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>
<!--Optional:-->
<sub:customDataProfiles>
<!--Zero or more repetitions:-->
<sub:customDataProfile>CDF1</sub:customDataProf
ile>
</sub:customDataProfiles>
</sub:subscriber>
</sub:subscribers>
<!--Optional:-->
<sub:meteredServices>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request fields
Table 2-1 lists the subfields as required for the addAccount command.
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)
2-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
Type: Enum
Default: no default value set
(3 of 4)
2-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<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.
Parameter
• subscriber
Indicates the subscriber record to be added.
Request code
Code 2-3 shows a request code example for the addSubscriber command.
2-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns1:clientAppId>4821</ns1:clientAppId>
<ns1:requestId>396321</ns1:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:addSubscriber>
<!--Optional:-->
<ns:subscriber>
<!--Optional:-->
<ns:accountId>ML2User</ns:userId>
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:category>gold</ns:category>
<!--Optional:-->
<ns:password>!@123Abc</ns:password>
<!--Optional:-->
<ns:description>VIP customer</ns:description>
<!--Optional:-->
<ns:unknownSubscriber>false</ns:unknownSubscriber>
<!--Optional:-->
<!--Optional:-->
<ns:State>DISABLED</ns:State>
<ns:subscriptionIds>
<!--Zero or more repetitions:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriptionIds>
<!--Optional:-->
<ns:notificationConfig>
<!--Optional:-->
<ns:emailAddress>johnsmith@abccompany.com</ns:emailAd
dress>
<!--Optional:-->
<ns:mobileNumber>6135551212</ns:mobileNumber>
<ns:notifyableByEmail>false</ns:notifyableByEmail>
<ns:notifyableBySMS>true</ns:notifyableBySMS>
</ns:notificationConfig>
<!--Optional:-->
<ns:allowOverage>true</ns:allowOverage>
<!--Optional:-->
<ns:subscriberProfiles>
<!--Zero or more repetitions:-->
<ns:subscriberProfile>Subprofile1</ns:subscriberProfi
le>
</ns:subscriberProfiles>
<!--Optional:-->
<ns:customData>
<!--Zero or more repetitions:-->
<ns:item>
<ns:name>CD1</ns:name>
<ns:value>
<ns:type>DECIMAL</ns:type>
<ns:data>999.999</ns:data>
</ns:value>
</ns:item>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</ns:customData>
<!--Optional:-->
<ns:customDataProfiles>
<!--Zero or more repetitions:-->
<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.
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
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)
2-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
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
(3 of 4)
2-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: Enum
Default: no default value set
customDataProfiles Defines a list of zero or more custom data profile names that Default: Empty list Optional
are applied to the subscriber.
(4 of 4)
Response code
Code 2-4 shows the response code for the addSubscriber command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
Request code
Code 2-5 shows a request code example for the clearPenaltyPeriod command.
2-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Optional:-->
<sub:meteringLimitName>ML</sub:meteringLimitName>
</sub:clearPenaltyPeriod>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-3 lists the fields required for the clearPenaltyPeriod command.
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.
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
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
2.5 getAccount
Parameters
• accountid
The unique identifier or name for the account.
2-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-7 shows a request code example for the getAccount command.
Request fields
Table 2-4 lists the fields required for the getAccount command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
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
Response code
Code 2-8 shows the response code for the getAccount command.
2-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<getAccountResponse
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">
<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>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<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>
<customDataProfiles>
<customDataProfile>cdf1</customDataProfile>
</customDataProfiles>
</account>
</getAccountResponse>
</env:Body>
</env:Envelope>
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
meter to the time of day that you want the reset.
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
Default: SUNDAY
(1 of 6)
2-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
usageDataReport Allows you to view the usage data report in its entirety on a — Optional
subscriber-by-subscriber basis.
(2 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(3 of 6)
2-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: enum
(4 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
cutomDataEntry — —
Defines the custom data used for a
single custom data entry based on:
• name
• value
Type: Enum
Default: no default value set
(5 of 6)
2-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
customData (continued) data Values: Dependant on the Type Mandatory within each
Contains the data for the custom data selected. item.
item value. Valid values 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
customDataProfiles Defines a list of zero or more custom Default: Empty list Optional
data profile names that are applied to
the subscriber.
(6 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-9 shows a request code example for the getAccountCustomData command.
2-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</sub:getAccountCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-6 lists the fields required for the getAccountCustomData command.
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.
subscriberId userId Values: 1 to 32 characters Optional
The unique identifier or name for the subscriber. Type: string
Default: n/a
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
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-29
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-10 shows the response code for the getAccountCustomData command.
Response fields
Table 2-7 lists the fields for the getAccountCustomData command.
customData Defines the custom data used for a single custom data entry —
based on:
• name
• value
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)
2-30 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
2.7 getAccountCustomDataProfiles
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-31
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request code
Code 2-11 shows a request code example for the getAccountCustomDataProfiles
command.
Request fields
Table 2-8 lists the fields required for the getAccountCustomDataProfiles command.
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.
(1 of 2)
2-32 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-12 shows the response code for the getAccountCustomDataProfiles
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-33
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response fields
Table 2-9 lists the fields for the getAccountCustomDataProfiles command.
customDataProfile A unique name for the Custom Data Profile. Values: 1 to 80 characters
Type: string
2.8 getAllowOverage
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-13 shows a request code example for the getAllowOverage command.
2-34 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:value>31007012345678</ns:value>
<ns:type>END_USER_IMSI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
</ns:getAllowOverage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-10 lists the fields required for the getAllowOverage command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a either userId or
subscriberId.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-35
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-14 shows the response code for the getAllowOverage command.
Response fields
Table 2-11 lists the fields for the getAllowOverage command.
2.9 getCategory
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-15 shows a request code example for the getCategory command.
2-36 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request fields
Table 2-12 lists the fields for the getCategory command.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-37
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-16 shows the response code for the getCategory command.
2-38 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response fields
Table 2-13 lists the fields for the getCategory command.
2.10 getCustomData
Gets the set of custom data objects from the subscriber object.
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-17 shows a request code example for the getCustomData command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-39
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
</ns:getCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-14 lists the fields required for the getCustomData command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
2-40 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-18 shows the response code for the getCustomData command.
Response fields
Table 2-15 lists the fields for the getCustomData command.
customData Defines the custom data used for a single custom data entry —
based on:
• name
• value
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-41
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
2.11 getCustomDataProfiles
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-19 shows a request code example for the getCustomDataProfiles command.
2-42 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request fields
Table 2-16 lists the fields required for the getCustomDataProfiles command.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-43
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-20 shows the response code for the getCustomDataProfiles command.
2-44 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response fields
Table 2-17 lists the fields for the getCustomDataProfiles command.
customDataProfile A unique name for the Custom Data Profile. Values: 1 to 80 characters
Type: string
2.12 getMeteringLimits
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-21 shows a request code example for the getMeteringLimits command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-45
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
</sub:getMeteringLimits>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-18 lists the fields required for the getMeteringLimits command.
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.
(1 of 2)
2-46 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 2)
Response code
Code 2-22 shows the response code for the getMeteringLimits command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-47
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</env:Body>
</env:Envelope>
Response fields
Table 2-19 lists the fields for the getMeteringLimits command.
meteringLimit Name of the metering limit to be assigned to the Values: 1 to 255 characters
subscriber. Type: string
2.13 getNotification
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-23 shows a request code example for the getNotification command.
2-48 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
</ns:getNotification>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-20 lists the fields required for the getNotification command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-49
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-24 shows the response code for the getNotification command.
Response fields
Table 2-21 lists the fields for the getNotification command.
2-50 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2.14 getResetDayOfMonth
Gets the account monthly reset day which represents the day of the month that the
usage is reset.
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-25 shows a request code example for the getResetDayOfMonth command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-51
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request fields
Table 2-22 lists the fields required for the getResetDayOfMonth command.
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.
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
Response code
Code 2-26 shows the response code for the getResetDayOfMonth command.
2-52 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response fields
Table 2-23 lists the fields for the getResetDayOfMonth command.
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
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-27 shows a request code example for the getResetDayOfWeek command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-53
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request fields
Table 2-24 lists the fields required for the getResetDayOfWeek command.
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.
(1 of 2)
2-54 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 2)
Response code
Code 2-28 shows the response code for the getResetDayOfWeek command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-55
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</env:Body>
</env:Envelope>
Response fields
Table 2-25 lists the fields for the getResetDayOfWeek command.
resetDayOfWeek Used for weekly resets, which can occur on any day of the week Values:
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
parameter to the time of day that you want the reset.
• 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
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-29 shows a request code example for the getResetHourOfDay command.
2-56 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getResetHourOfDay>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
</sub:getResetHourOfDay>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-26 lists the fields required for the getResetHourOfDay command.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-57
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 2)
Response code
Code 2-30 shows the response code for the getResetHourOfDay command.
2-58 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</env:Body>
</env:Envelope>
Response fields
Table 2-27 lists the fields for the getResetHourOfDay command.
getResetHourOfDay ResetHourOfDay must be configured for any reset, whether a Values: 0-24
day of the week or month. The reset time can be configured as Type: enum
follows:
• 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.17 getSubProfileNames
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-31 shows a request code example for the getSubProfileNames command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-59
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</soapenv:Header>
<soapenv:Body>
<ns:getSubProfileNames>
<!--Optional:-->
<ns:subscriberId>
<!--Optional:-->
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
</ns:getSubProfileNames>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-28 lists the fields required for the getSubProfileNames command.
(1 of 2)
2-60 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-32 shows the response code for the getSubProfileNames command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-61
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response fields
Table 2-29 lists the fields for the getSubProfileNames command.
2.18 getSubscriber
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-33 shows a request code example for the getSubscriber command.
2-62 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<sub:subscriberId>
<!--Optional:-->
<sub:userId>ML2User</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>33012000091</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
</sub:getSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-30 lists the fields required for the getSubscriber command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-63
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-34 shows a response code example for the getSubscriber command.
2-64 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<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.
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
a subscriber (for example, Gold, Silver, or Bronze). Type: string
password A case-sensitive password for the subscriber. Applies to Values: 1 to 128 characters
NASREQ sessions only. Type: string
description Information about the subscriber. Values: 0 to 255 characters
Type: string
(1 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-65
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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 E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
(2 of 4)
2-66 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
item —
Defines the custom data used for a single custom data entry
based on:
• name
• value
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
(3 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-67
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
customDataProfiles Defines a list of zero or more custom data profile names that Optional
are applied to the subscriber.
item Values: 1 to 80 characters
The name of a custom data profile. Type: string
(4 of 4)
2.19 getSubscriberState
2-68 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-35 shows a request code example for the GetSubscriberState command.
Request fields
Table 2-32 lists the fields required for the GetSubscriberState command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-69
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
userId The unique identifier or name for the Values: 1 to 32 characters Mandatory
subscriber. Type: string Note: You must enter
Default: n/a either userId or
subscriberId.
Response code
Code 2-36 shows a response code example for the GetSubscriberState command.
2-70 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<env:Header/>
<env:Body>
<getSubscriberStateResponse
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">
<subscriberState>ENABLED</subscriberState>
</getSubscriberStateResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-33 lists the fields for the GetSubscriberState command.
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
The state of the subscriber is enabled.
2.20 getSubscriptionIds
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-37 shows a request code example for the getSubscriptionIds command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-71
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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:getSubscriptionIds>
<!--Optional:-->
<ns:subscriberId>
<!--Optional:-->
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
</ns:getSubscriptionIds>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-34 lists the fields required for the getSubscriptionIds command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
2-72 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-38 shows the response code for the getSubscriptionIds command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-73
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response fields
Table 2-35 lists the fields for the getSubscriptionIds command.
type Values:
The type of identifier that is carried by the associated value. • END_USER_E164
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].
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.
2.21 getUnknownSubscriber
2-74 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-39 shows a request code example for the getUnknownSubscriber command.
Request fields
Table 2-36 lists the fields required for the getUnknownSubscriber command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-75
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
Response code
Code 2-40 shows the response code for the getUnknownSubscriber command.
2-76 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</env:Body>
</env:Envelope>
Response fields
Table 2-37 lists the fields for the getUnknownSubscriber command.
2.22 getUsage
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-41 shows a request code example for the getUsage command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-77
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</soapenv:Header>
<soapenv:Body>
<sub:getUsage>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
</sub:getUsage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-38 lists the fields required for the getUsage command.
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.
(1 of 2)
2-78 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 2)
Response code
Code 2-42 shows the response code for the getUsage command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-79
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<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</nextSched
uledReset>
</usageData>
</getUsageResponse>
</env:Body>
</env:Envelope>
Response fields
Table 2-39 lists the fields for the getUsage command.
subscriber —
Indicates the subscriber record to be added.
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
(1 of 2)
2-80 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
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.
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
(2 of 2)
2.23 removeAccount
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-81
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-43 shows a request code example for the removeAccount command.
Request fields
Table 2-40 lists the fields required for the removeAccount command.
2-82 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
Response code
Code 2-44 shows the response code for the removeAccount command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-83
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<removeAccountResponse
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.24 removeSubscriber
Parameter
• subscriberId
Identifies a subscriber by user id or subscription id.
Request code
Code 2-45 shows a request code example for the removeSubscriber command.
2-84 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
</ns:removeSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-41 lists the fields required for the removeSubscriber command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-85
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-46 shows the response code for the removeSubscriber command.
2.25 resetUsage
Note — One or all usage data for the account can be reset to 0.
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
2-86 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:resetUsage>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Zero or more repetitions:-->
<sub:meteringLimit>ML</sub:meteringLimit>
</sub:resetUsage>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-42 lists the fields required for the resetUsage command.
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.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-87
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
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.
2-88 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
2.26 updateAccount
Parameter
• account
The unique identifier or name for the account.
Request code
Code 2-49 shows a request code example for the updateAccount command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-89
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<!--Optional:-->
<sub:description>update desc</sub:description>
<!--Optional:-->
<sub:unknownSubscriber>false</sub:unknownSubscribe
r>
<!--Optional:-->
<sub:state>ENABLED</sub:state>
<!--Optional:-->
<sub:subscriptionIds>
<!--Zero or more repetitions:-->
<sub:subscriptionId>
<sub:value>33012000091223</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriptionIds>
<!--Optional:-->
<sub:notificationConfig>
<!--Optional:-->
<sub:emailAddress/>
<!--Optional:-->
<sub:mobileNumber/>
<sub:notifyableByEmail>false</sub:notifyableByE
mail>
<sub:notifyableBySMS>false</sub:notifyableBySMS
>
</sub:notificationConfig>
<!--Optional:-->
<sub:allowOverage>true</sub:allowOverage>
<sub:syOCSEnabled>false</sub:syOCSEnabled>
<!--Optional:-->
<sub:subscriberProfiles>
<!--Zero or more repetitions:-->
<sub:subscriberProfile>updatepf</sub:subscriber
Profile>
</sub:subscriberProfiles>
<!--Optional:-->
<sub:customData>
<!--Zero or more repetitions:-->
<sub:item>
<sub:name>updatecd</sub:name>
<sub:value>
<sub:type>STRING</sub:type>
<sub:data>updatecd</sub:data>
</sub:value>
</sub:item>
</sub:customData>
<!--Optional:-->
<sub:customDataProfiles>
<!--Zero or more repetitions:-->
<sub:customDataProfile>updatecdf</sub:customDat
aProfile>
</sub:customDataProfiles>
</sub:subscriber>
</sub:subscribers>
<!--Optional:-->
<sub:meteredServices>
<!--Zero or more repetitions:-->
2-90 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<sub:meteringLimitName>ml</sub:meteringLimitName>
</sub:meteredServices>
<!--Optional:-->
<sub:customData>
<!--Zero or more repetitions:-->
<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>
<!--Optional:-->
<sub:customDataProfiles>
<!--Zero or more repetitions:-->
<sub:customDataProfile>updatecdf</sub:customDataProfi
le>
</sub:customDataProfiles>
</sub:account>
</sub:updateAccount>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-43 lists the fields required for the updateAccount command.
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
parameter to the time of day that you want the reset.
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
Default: SUNDAY
(1 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-91
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 4)
2-92 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
customData Defines a list of one or more custom data entries (item). — Optional
cutomDataEntry — —
Defines the custom data used for a single custom data entry
based on:
• name
• value
Type: Enum
Default: no default value set
(3 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-93
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
customDataProfiles Defines a list of zero or more custom data profile names that Default: Empty list Optional
are applied to the subscriber.
item 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-50 shows the response code for the updateAccount command.
2-94 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<env:Body>
<updateAccountResponse
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.27 updateAccountCustomData
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-95
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</soapenv:Header>
<soapenv:Body>
<sub:updateAccountCustomData>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Zero or more repetitions:-->
<sub:customData>
<sub:name>cd1</sub:name>
<sub:value>
<sub:type>STRING</sub:type>
<sub:data>updatecd1</sub:data>
</sub:value>
</sub:customData>
<sub:customData>
<sub:name>cd2</sub:name>
<sub:value>
<sub:type>STRING</sub:type>
<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.
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.
(1 of 2)
2-96 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
customData Defines the custom data used for a single custom data entry — —
based on:
• name
• value
value — —
Defines the value of the item using:
• type
• data
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-97
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: Enum
Default: no default value set
(2 of 2)
2-98 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-52 shows the response code for the updateAccountCustomData command.
2.28 updateAccountCustomDataEntry
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• customData
Defines the custom data used for a single custom data entry based on name and
value.
Request code
Code 2-53 shows a request code example for the updateAccountCustomDataEntry
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-99
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateAccountCustomDataEntry>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Optional:-->
<sub:customData>
<sub:name>cd1</sub:name>
<sub:value>
<sub:type>STRING</sub:type>
<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.
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.
(1 of 2)
2-100 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
customData Defines the custom data used for a single custom data entry — —
based on:
• name
• value
value — —
Defines the value of the item using:
• type
• data
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-101
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: Enum
Default: no default value set
(2 of 2)
Response code
Code 2-54 shows the response code for the updateAccountCustomDataEntry
command.
2-102 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<updateAccountCustomDataEntryResponse
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.29 updateAccountCustomDataProfiles
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• customDataProfile
The name of a custom data profile.
Request code
Code 2-55 shows a request code example for the updateAccountCustomDataProfiles
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-103
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Zero or more repetitions:-->
<sub:customDataProfile>cdf1</sub:customDataProfile>
</sub:updateAccountCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-48 lists the fields required for the updateAccountCustomDataProfiles
command.
accountid The unique identifier or name for the Values: 1 to 32 characters Optional
account. Type: string Note: You must enter
Default: n/a accountId, userId or
subscriptionId.
subscriberId userId Values: 1 to 32 characters Optional
The unique identifier or name for the Type: string
subscriber. Default: n/a
(1 of 2)
2-104 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-56 shows the response code for the updateAccountCustomDataProfiles
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-105
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<updateAccountCustomDataProfilesResponse
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.30 updateAllowOverage
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• allowOverage
Indicates if overage is allowed for the subscriber.
Request code
Code 2-57 shows a request code example for the updateAllowOverage command.
2-106 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:type>END_USER_NAI</ns:type>
</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.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-107
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
2.31 updateCategory
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
2-108 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Subparameters
Tables 2-51 and 2-52 lists the subparameters required for the updateCategory
command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-109
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-60 shows the response code for the updateCategory command.
2-110 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<updateCategoryResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
"/>
</env:Body>
</env:Envelope>
2.32 updateCustomData
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• customData
Defines the custom data used for a single custom data entry based on name and
value.
Request code
Code 2-61 shows a request code example for the updateCustomData command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-111
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
<!--Zero or more repetitions:-->
<ns:customData>
<ns:name>CD1</ns:name>
<ns:value>
<ns:type>DECIMAL</ns:type>
<ns:data>999.99</ns:data>
</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.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
2-112 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
customData Defines the custom data used for a single custom data entry — —
based on:
• name
• value
value — —
Defines the value of the item using:
• type
• data
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-113
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: Enum
Default: no default value set
(2 of 2)
2-114 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-62 shows the response code for the updateCustomData command.
2.33 updateCustomDataEntry
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• customData
Defines the custom data used for a single custom data entry based on name and
value.
Request code
Code 2-63 shows a request code example for the updateCustomDataEntry command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-115
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns1:requestId>396321</ns1:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:updateCustomDataEntry>
<!--Optional:-->
<ns:subscriberId>
<!--Optional:-->
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
<!--Optional:-->
<ns:customData>
<ns:name>CD1</ns:name>
<ns:value>
<ns:type>DECIMAL</ns:type>
<ns:data>999.99</ns:data>
</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.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
2-116 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
customData Defines the custom data used for a single custom data entry — —
based on:
• name
• value
value — —
Defines the value of the item using:
• type
• data
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-117
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: Enum
Default: no default value set
(2 of 2)
Response code
Code 2-64 shows the response code for the updateCustomDataEntry command.
2-118 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<updateCustomDataEntryResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
"/>
</env:Body>
</env:Envelope>
2.34 updateCustomDataProfiles
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• customDataProfile
The name of a custom data profile.
Request code
Code 2-65 shows a request code example for the updateCustomDataProfiles
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-119
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</ns:subscriptionId>
</ns:subscriberId>
<!--Zero or more repetitions:-->
<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.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
2-120 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-66 shows the response code for the updateCustomDataProfiles command.
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
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• oldmeteringLimit
Identifies the old meteringLimit to be replaced.
• newmeteringLimit
Identifies the new meteringLimit to be assigned.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-121
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request code
Code 2-67 shows a request code example for the updateMeteringLimitEntry
command.
Request fields
Tables 2-59, 2-60, 2-61, and 2-62 list the fields required for the
updateMeteringLimitEntry command.
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.
2-122 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
oldmeteringLimit Name of the metering limit to be replaced. Values: 1 to 255 characters Optional
Type: string
Default: n/a
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-123
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
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
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
2-124 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Request fields
Table 2-63 lists the fields required for the updateMeteringLimits command.
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.
subscriberId userId Values: 1 to 32 characters Optional
The unique identifier or name for the subscriber. Type: string
Default: n/a
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-125
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
2-126 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</env:Envelope>
2.37 updateNotification
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• notificationConfig
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-127
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</ns:emailAddress>johnsmith@abccompany.com</ns:emailAddr
ess>
<!--Optional:-->
<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.
2-128 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
notificationConfig Configuration used to determine how the 5780 DSC notification — Optional
is sent to the subscriber.
Response code
Code 2-72 shows the response code for the updateNotification command.
2.38 updateResetDayOfMonth
Updates the account reset day of month, which represents the day of the month that
monthly usage rests occurs.
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-129
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
• 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.
Request fields
Table 2-66 lists the fields required for the updateResetDayOfMonth command.
2-130 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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.
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
Response code
Code 2-74 shows the response code for the updateResetDayOfMonth command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-131
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2.39 updateResetDayOfWeek
Updates the account reset day of week, which represents the day of week on which
weekly resets occur.
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
2-132 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<sub:updateResetDayOfWeek>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Optional:-->
<sub:resetDayOfWeek>MONDAY</sub:resetDayOfWeek>
</sub:updateResetDayOfWeek>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-67 lists the fields required for the updateResetDayOfWeek command.
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.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-133
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
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
(2 of 2)
Response code
Code 2-76 shows the response code for the updateResetDayOfWeek command.
2-134 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2.40 updateResetHourOfDay
Updates the account reset hour of day, which represents the hour of day on which
usage resets occur.
Parameters
• accountid
The unique identifier or name for the account.
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-135
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<sub:updateResetHourOfDay>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>451131AB</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>john.smith@abccompany.com</sub:value>
<sub:type>END_USER_NAI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Optional:-->
<sub:resetHourOfDay>0</sub:resetHourOfDay>
</sub:updateResetHourOfDay>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-68 lists the fields required for the updateResetHourOfDay command.
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.
(1 of 2)
2-136 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
(2 of 2)
Response code
Code 2-78 shows the response code for the updateResetHourOfDay command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-137
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
Identifies a subscriber by user id or subscription id.
• subscriberProfile
Name of subscriber profile.
Request code
Code 2-79 shows a request code example for the updateSubProfileNames command.
2-138 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:subscriberId>
<!--Optional:-->
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</ns:subscriptionId>
</ns:subscriberId>
<!--Zero or more repetitions:-->
<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.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-139
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-80 shows the response code for the updateSubProfileNames command.
2-140 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<updateSubProfileNamesResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
"/>
</env:Body>
</env:Envelope>
2.42 updateSubscriber
Updates the specified subscriber object by replacing the existing values with those
specified.
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.
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-141
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateSubscriber>
<!--Optional:-->
<sub:subscriber>
<!--Optional:-->
<sub:accountId>ML2User</sub:accountId>
<sub:userId>ML2User</sub:userId>
<!--Optional:-->
<sub:category>Silver</sub:category>
<!--Optional:-->
<sub:password>pass123</sub:password>
<!--Optional:-->
<sub:description>Renew subscriber</sub:description>
<!--Optional:-->
<sub:unknownSubscriber>false</sub:unknownSubscriber>
<!--Optional:-->
<sub:state>ENABLED</sub:state>
<!--Optional:-->
<sub:subscriptionIds>
<!--Zero or more repetitions:-->
<sub:subscriptionId>
<sub:value>2341234567890</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriptionIds>
<!--Optional:-->
<sub:notificationConfig>
<!--Optional:-->
<sub:emailAddress>newEmail@gmail.com
</sub:emailAddress>
<!--Optional:-->
<sub:mobileNumber>61378941234</sub:mobileNumber>
<sub:notifyableByEmail>true</sub:notifyableByEmail>
<sub:notifyableBySMS>true</sub:notifyableBySMS>
</sub:notificationConfig>
<!--Optional:-->
<sub:allowOverage>true</sub:allowOverage>
<sub:syOCSEnabled>true</sub:syOCSEnabled>
<!--Optional:-->
<sub:subscriberProfiles>
<!--Zero or more repetitions:-->
<sub:subscriberProfile>sub_profile</sub:subscriberPro
file>
</sub:subscriberProfiles>
<!--Optional:-->
<sub:customData>
<!--Zero or more repetitions:-->
<sub:item>
<sub:name>LANGUAGE</sub:name>
<sub:value>
<sub:type>STRING</sub:type>
<sub:data>FRENCH</sub:data>
2-142 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</sub:value>
</sub:item>
</sub:customData>
<!--Optional:-->
<sub:customDataProfiles>
<!--Zero or more repetitions:-->
<sub:customDataProfile>sub_cdp</sub:customDataProfile
>
</sub:customDataProfiles>
</sub:subscriber>
</sub:updateSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-71 lists the fields required for the updateSubscriber command.
accountid The unique identifier or name for the account. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
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
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-143
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
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
(2 of 4)
2-144 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
customData Defines a list of one or more custom data entries (item). Default: Empty list Optional
(3 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-145
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Type: Enum
Default: no default value set
customDataProfiles Defines a list of zero or more custom data profile names that — Optional
are applied to the subscriber.
(4 of 4)
2-146 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-82 shows the response code for the updateSubscriber command.
2.43 updateSubscriberState
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• subscriberState
Updates the state of the subscriber object.
Request code
Code 2-83 shows a request code example for the UpdateSubscriberState command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-147
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<sub:updateSubscriberState>
<!--Optional:-->
<sub:subscriberId>
<!--Optional:-->
<sub:userId>peter</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>31001212345699</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Optional:-->
<sub:subscriberState>ENABLED</sub:subscriberState>
</sub:updateSubscriberState>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 2-72 lists the fields required for the UpdateSubscriberState command.
(1 of 2)
2-148 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
subscriberState 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.
(2 of 2)
Response code
Code 2-84 shows a response code example for the UpdateSubscriberState command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-149
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<env:Header/>
<env:Body>
<updateSubscriberStateResponse
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.44 updateSubscriptionId
Updates the subscriber by replacing the specified old subscription id with the
specified new subscription id.
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• 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.
2-150 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<!--Optional:-->
<sub:userId>peter</sub:userId>
<!--Optional:-->
<sub:subscriptionId>
<sub:value>31001212345699</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:subscriptionId>
</sub:subscriberId>
<!--Optional:-->
<sub:oldSubscriptionId>
<sub:value>31001212345699</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</sub:oldSubscriptionId>
<!--Optional:-->
<sub:newSubscriptionId>
<sub:value>31001212348857</sub:value>
<sub:type>END_USER_IMSI</sub:type>
</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.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-151
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
2-152 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-153
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-86 shows the response code for the updateSubscriptionId command.
2-154 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2.45 updateSubscriptionIds
Updates the subscriber by replacing the existing set of subscription ids with the
specified new set of subscription ids.
Parameters
• subscriberId
Identifies a subscriber by user id or subscription id.
• subscriptionId
Contains the identity of the subscription.
Request code
Code 2-87 shows a request code example for the updateSubscriptionIds command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-155
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
</soapenv:Envelope>
Request fields
Table 2-76 lists the fields required for the updateSubscriptionIds command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
2-156 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
Response code
Code 2-88 shows the response code for the updateSubscriptionIds command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-157
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
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
Identifies a subscriber by user id or subscription id.
• unknownSubscriber
Indicates an unknown subscriber.
Request code
Code 2-89 shows a request code example for the updateUnknownSubscriber
command.
2-158 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<ns:subscriberId>
<!--Optional:-->
<ns:userId>451131AB</ns:userId>
<!--Optional:-->
<ns:subscriptionId>
<ns:value>john.smith@abccompany.com</ns:value>
<ns:type>END_USER_NAI</ns:type>
</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.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-159
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
(2 of 2)
Response code
Code 2-90 shows the response code for the updateUnknownSubscriber command.
2-160 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
<updateUnknownSubscriberResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
"/>
</env:Body>
</env:Envelope>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 2-161
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
2 — Subscriber provisioning API
2-162 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3— Subscriber profile provisioning API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
3-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
3.2 addCalledStationIdEntry
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.
Request fields
Tables 3-1 and 3-2 lists the fields for the addCalledStationIdEntry command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
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.
3.3 addSubscriberProfile
Parameter
• subProfile
The subscriber profile object to be added.
Request code
Code 3-3 shows a request code example for the addSubscriberProfile command.
3-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<sub1:maxMBR>
<sub1:upLinkBw>1300</sub1:upLinkBw>
<sub1:downLinkBw>1400</sub1:downLinkBw>
</sub1:maxMBR>
</sub1:guaranteedBitRate>
</sub1:qciGuaranteedBitRate>
</sub1:qciGuaranteedBitRates>
<!--Optional:-->
<sub1:qciMaxBitRates>
<!--Zero or more repetitions:-->
<sub1:qciMaxBitRate>
<sub1:qosId>QCI_6</sub1:qosId>
<sub1:maxBitRate>
<sub1:upLinkBw>3000</sub1:upLinkBw>
<sub1:downLinkBw>3100</sub1:downLinkBw>
</sub1:maxBitRate>
</sub1:qciMaxBitRate>
</sub1:qciMaxBitRates>
<!--Optional:-->
<sub1:afApplications>
<!--Zero or more repetitions:-->
<sub1:afApplication>
<sub1:applicationIdentifier>AFApn1</sub1:applicati
onIdentifier>
<!--Optional:-->
<sub1:requestedPriority>7</sub1:requestedPriority>
<!--Optional:-->
<sub1:bandwidth>
<sub1:upLinkBw>100</sub1:upLinkBw>
<sub1:downLinkBw>150</sub1:downLinkBw>
</sub1:bandwidth>
<!--Optional:-->
<sub1:online>ENABLE_ONLINE</sub1:online>
<!--Optional:-->
<sub1:offline>ENABLE_OFFLINE</sub1:offline>
<!--Optional:-->
<sub1:meteringMethod>VOLUME</sub1:meteringMethod>
<!--Optional:-->
<sub1:ratingGroup>2</sub1:ratingGroup>
</sub1:afApplication>
</sub1:afApplications>
<!--Optional:-->
<sub1:customData>
<!--Zero or more repetitions:-->
<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>
<!--Optional:-->
<sub1:customDataProfiles>
<!--Zero or more repetitions:-->
3-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<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.
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
requests are handled by the 5780 DSC Type: boolean
for the subscriber. When set to false,
access to unknown applications is not Default: false
allowed.
(1 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
(2 of 6)
3-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
downlink values as follows: 0 or a negative value.
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(4 of 6)
3-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
item — —
Defines the custom data used for a
single custom data entry based on:
• name
• value
(5 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(6 of 6)
Response code
Code 3-4 shows the response code for the addSubscriberProfile command.
3-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riberprofile"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
3.4 getAFApplications
Parameter
• profileName
A unique name for the subscriber data.
Request code
Code 3-5 shows a request code example for the getAFApplications command.
Request fields
Table 3-4 lists the fields for the getAFApplications command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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.
Response fields
Table 3-5 lists the fields for the getAFApplications command.
Type: string
(1 of 2)
3-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
requestedPriority The value used as the Priority Level in a PCC rule Values: 1 to 15
Allocation Retention Priority. Type: integer
Type: string
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
A unique name for the subscriber data.
Request code
Code 3-7 shows a request code example for the getCalledStationIds command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
riberprofile"
xmlns:sub1="http://www.alcatellucent.com/dsc/provisioningapi/51/subs
criber">
<soapenv:Header>
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getCalledStationIds>
<!--Optional:-->
<sub1:profileName>subProfile1</sub1:profileName>
</sub:getCalledStationIds>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-6 lists the fields for the getCalledStationIds command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-8 shows the response code for the getCalledStationIds command.
Response fields
Table 3-7 lists the fields for the getCalledStationIds command.
3-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
A unique name for the subscriber data.
Request code
Code 3-9 shows a request code example for the getQciGuaranteedBitRates
command.
Request fields
Table 3-8 lists the fields for the getQciGuaranteedBitRates command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-10 shows the response code for the getQciGuaranteedBitRates command.
Response fields
Table 3-9 lists the fields for the getQciGuaranteedBitRates command.
3-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
guaranteedBitRate quaranteedBitRate —
Contains the guaranteed and maximum bit rate for the
specified GBR QCI as follows:
• maxGBR
• maxMBR
3.7 getQciMaxBitRates
Gets the list of QCI maximum bit rates from the subscriber profile object.
Parameter
• profileName
A unique name for the subscriber data.
Request code
Code 3-11 shows a request code example for the getQciMaxBitRate command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Request fields
Table 3-10 lists the fields for the getQciMaxBitRates command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-12 shows the response code for the getQciMaxBitRates command.
3-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<upLinkBw>3000</upLinkBw>
<downLinkBw>3100</downLinkBw>
</maxBitRate>
</qciMaxBitRate>
</ns2:getQciMaxBitRatesResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-11 lists the fields for the getQciMaxBitRates command.
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
Maximum bit rate for downlinks.
3.8 getSubscriberProfile
Parameter
• profileName
A unique name for the subscriber data.
Request code
Code 3-13 shows a request code example for the getSubscriberProfile command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Request fields
Table 3-12 lists the fields for the getSubscriberProfile command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-14 shows the response code for the getSubscriberProfile command.
3-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<ueAccessToUnKnownApps>true</ueAccessToUnKnownApps>
<calledStationIds>
<item>apn1</item>
</calledStationIds>
<defaultQCI>QCI_9</defaultQCI>
<arp>
<priorityLevel>9</priorityLevel>
<preEmptionCapability>PRE_EMPTION_CAPABILITY_DISABLED
</preEmptionCapability>
</arp>
<aggregateMaxBitRate>
<upLinkBw>120000</upLinkBw>
<downLinkBw>110000</downLinkBw>
</aggregateMaxBitRate>
<qciGuaranteedBitRates>
<qciGuaranteedBitRate>
<qosId>QCI_1</qosId>
<guaranteedBitRate>
<maxGBR>
<upLinkBw>1100</upLinkBw>
<downLinkBw>1200</downLinkBw>
</maxGBR>
<maxMBR>
<upLinkBw>1300</upLinkBw>
<downLinkBw>1400</downLinkBw>
</maxMBR>
</guaranteedBitRate>
</qciGuaranteedBitRate>
</qciGuaranteedBitRates>
<qciMaxBitRates>
<qciMaxBitRate>
<qosId>QCI_6</qosId>
<maxBitRate>
<upLinkBw>3000</upLinkBw>
<downLinkBw>3100</downLinkBw>
</maxBitRate>
</qciMaxBitRate>
</qciMaxBitRates>
<afApplications>
<afApplication>
<applicationIdentifier>AFApn1</applicationIdentifi
er>
<requestedPriority>7</requestedPriority>
<bandwidth>
<upLinkBw>100</upLinkBw>
<downLinkBw>150</downLinkBw>
</bandwidth>
<online>ENABLE_ONLINE</online>
<offline>ENABLE_OFFLINE</offline>
<meteringMethod>VOLUME</meteringMethod>
<ratingGroup>2</ratingGroup>
</afApplication>
</afApplications>
<customData>
<item>
<name>BCM_1</name>
<value>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<type>LIST</type>
<data>ENUM:BearerControlMode.RESERVED|BearerCon
trolMode.UE_ONLY</data>
</value>
</item>
</customData>
<customDataProfiles>
<customDataProfile>CdProfile_1</customDataProfile>
</customDataProfiles>
</subProfile>
</ns2:getSubscriberProfileResponse>
</env:Body>
</env:Envelope>
Response fields
Table 3-13 lists the fields for the getSubscriberProfile command.
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
requests are handled by the 5780 DSC Type: boolean
for the subscriber. When set to false,
access to unknown applications is not Default: false
allowed.
(1 of 7)
3-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(2 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
downlink values as follows: 0 or a negative value.
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 7)
3-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(4 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(5 of 7)
3-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
item — —
Defines the custom data used for a
single custom data entry based on:
• name
• value
(6 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-29
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(7 of 7)
3.9 getSubscriberProfileCustomData
Gets the set of custom data entries from the subscriber profile object.
Parameter
• profileName
A unique name for the subscriber data.
3-30 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Request code
Code 3-15 shows a request code example for the getSubscriberProfileCustomData
command.
Request fields
Table 3-14 lists the fields for the getSubscriberProfileCustomData command.
Response code
Code 3-16 shows the response code for the getSubscriberProfileCustomData
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-31
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
riberprofile"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common">
<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.
customData Defines the custom data used for a single custom data entry — Optional
based on:
• name
• value
Type: Enum
Default: no default value set
(1 of 2)
3-32 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(2 of 2)
3.10 getSubscriberProfileCustomDataProfiles
Gets the set of custom data profile from the subscriber profile.
Parameter
• profileName
A unique name for the subscriber data.
Request code
Code 3-17 shows a request code example for the
getSubscriberProfileCustomDataProfiles command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-33
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
n"
xmlns:sub="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riberprofile"
xmlns:sub1="http://www.alcatellucent.com/dsc/provisioningapi/51/subs
criber">
<soapenv:Header>
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:getSubscriberProfileCustomDataProfiles>
<!--Optional:-->
<sub1:profileName>subProfile1</sub1:profileName>
</sub:getSubscriberProfileCustomDataProfiles>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 3-16 lists the fields for the getSubscriberProfileCustomDataProfiles
command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-18 shows the response code for the getSubscriberProfileCustomDataProfiles
command.
3-34 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Response fields
Table 3-17 lists the fields for the getSubscriberProfileCustomDataProfile command.
3.11 removeSubscriberProfile
Parameter
• profileName
A unique name for the subscriber data.
Request code
Code 3-19 shows a request code example for the removeSubscriberProfile
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-35
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Request fields
Table 3-18 lists the fields for the removeSubscriberProfile command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-20 shows the response code for the removeSubscriberProfile command.
3.12 updateAFApplicationEntry
Updates the specified AF application entry for the subscriber profile object.
Parameters
• profileName
A unique name for the subscriber data.
• 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.
3-36 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Request fields
Tables 3-19 and 3-20 list the fields for the updateAFApplicationEntry command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-37
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
Type: string
Default: not set
(1 of 2)
3-38 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Type: string
Default: not set
(2 of 2)
Response code
Code 3-22 shows the response code for the updateAFApplicationEntry command.
3.13 updateAFApplications
Updates all the AF application entries for the subscriber profile object.
Parameters
• profileName
A unique name for the subscriber data.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-39
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
• 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.
Request fields
Tables 3-21 and 3-22 lists the fields for the updateAFApplications command.
3-40 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
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
Type: string
Default: not set
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-41
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Type: string
Default: not set
(2 of 2)
Response code
Code 3-24 shows the response code for the updateAFApplications command.
3.14 updateCalledStationIds
Updates the complete list of called station Ids for the subscriber profile object.
Parameters
• profileName
A unique name for the subscriber data.
3-42 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
• calledstationId
A unique identifier for the called station ID.
Request code
Code 3-25 shows a request code example for the updateCalledStationIds command.
Request fields
Tables 3-23 and 3-24 lists the fields for the updateCalledStationIds command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-43
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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.
3.15 updateQciGuaranteedBitRateEntry
Updates the specified QCI guaranteed bit rate entries for the subscriber profile
object.
Parameters
• profileName
A unique name for the subscriber data.
• 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.
3-44 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
riberprofile"
xmlns:sub1="http://www.alcatellucent.com/dsc/provisioningapi/51/subs
criber">
<soapenv:Header>
<com:header>
<com:clientAppId>4821</com:clientAppId>
<com:requestId>396321</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sub:updateQciGuaranteedBitRateEntry>
<!--Optional:-->
<sub1:profileName>subProfile1</sub1:profileName>
<!--Optional:-->
<sub1:qciGuaranteedBitRate>
<sub1:qosId>QCI_3</sub1:qosId>
<sub1:guaranteedBitRate>
<!--Optional:-->
<sub1:maxGBR>
<sub1:upLinkBw>4100</sub1:upLinkBw>
<sub1:downLinkBw>4000</sub1:downLinkBw>
</sub1:maxGBR>
<!--Optional:-->
<sub1:maxMBR>
<sub1:upLinkBw>5100</sub1:upLinkBw>
<sub1:downLinkBw>5000</sub1:downLinkBw>
</sub1:maxMBR>
</sub1:guaranteedBitRate>
</sub1:qciGuaranteedBitRate>
</sub:updateQciGuaranteedBitRateEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-25 and 3-26 list the fields for the UpdateQciGuaranteedBitRateEntry
command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-45
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
specified GBR QCI as follows:
• maxGBR
• maxMBR
Response code
Code 3-28 shows the response code for the UpdateQciGuaranteedBitRateEntry
command.
3.16 updateQciGuaranteedBitRates
Updates the complete set of QCI guaranteed bit rate entries for the subscriber profile
object.
3-46 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Parameters
• profileName
A unique name for the subscriber data.
• 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.
Request fields
Tables 3-27 and 3-28 list the fields for the updateQciGuaranteedBitRates command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-47
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
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
quaranteedBitRate — Optional
Contains the guaranteed and maximum bit rate for the
specified GBR QCI as follows:
• maxGBR
• maxMBR
Response code
Code 3-30 shows the response code for the updateQciGuaranteedBitRates command.
3-48 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<ns2:updateQciGuaranteedBitRatesResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riberprofile"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
3.17 updateQciMaxBitRateEntry
Updates the specified QCI maximum bit rate entries for the subscriber profile object.
Parameters
• profileName
A unique name for the subscriber data.
• 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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-49
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
</sub1:qciMaxBitRate>
</sub:updateQciMaxBitRateEntry>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-29 and 3-30 lists the fields for the updateQciMaxBitRateEntry command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
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
Response code
Code 3-32 shows the response code for the updateQciMaxBitRateEntry command.
3-50 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<ns2:updateQciMaxBitRateEntryResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/subscribe
r"
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riberprofile"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
3.18 updateQciMaxBitRates
Updates the complete set of QCI maximum bit rate entries for the subscriber profile
object.
Parameters
• profileName
A unique name for the subscriber data.
• 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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-51
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
</sub1:qciMaxBitRate>
</sub:updateQciMaxBitRates>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-31 and 3-32 list the fields for the updateQciMaxBitRates command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
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
3-52 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Response code
Code 3-34 shows the response code for the updateQciMaxBitRates command.
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-53
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<sub1:ueAccessToKnownApps>true</sub1:ueAccessToKnownApps
>
<sub1:ueAccessToUnKnownApps>true</sub1:ueAccessToUnKnown
Apps>
<sub1:calledStationIds>
<!--Zero or more repetitions:-->
<sub1:item>Apn9</sub1:item>
</sub1:calledStationIds>
<!--Optional:-->
<sub1:defaultQCI>QCI_7</sub1:defaultQCI>
<!--Optional:-->
<sub1:arp>
<!--Optional:-->
<sub1:priorityLevel>8</sub1:priorityLevel>
<!--Optional:-->
<sub1:preEmptionCapability>PRE_EMPTION_CAPABILITY_DIS
ABLED</sub1:preEmptionCapability>
<!--Optional:-->
<sub1:preEmptionVulnerability>PRE_EMPTION_VULNERABILI
TY_ENABLED</sub1:preEmptionVulnerability>
</sub1:arp>
<!--Optional:-->
<sub1:aggregateMaxBitRate>
<sub1:upLinkBw>1500000</sub1:upLinkBw>
<sub1:downLinkBw>1400000</sub1:downLinkBw>
</sub1:aggregateMaxBitRate>
<!--Optional:-->
<sub1:qciGuaranteedBitRates>
<!--Zero or more repetitions:-->
<sub1:qciGuaranteedBitRate>
<sub1:qosId>QCI_3</sub1:qosId>
<sub1:guaranteedBitRate>
<!--Optional:-->
<sub1:maxGBR>
<sub1:upLinkBw>3100</sub1:upLinkBw>
<sub1:downLinkBw>3000</sub1:downLinkBw>
</sub1:maxGBR>
<!--Optional:-->
<sub1:maxMBR>
<sub1:upLinkBw>4100</sub1:upLinkBw>
<sub1:downLinkBw>4000</sub1:downLinkBw>
</sub1:maxMBR>
</sub1:guaranteedBitRate>
</sub1:qciGuaranteedBitRate>
</sub1:qciGuaranteedBitRates>
<!--Optional:-->
<sub1:qciMaxBitRates>
<!--Zero or more repetitions:-->
<sub1:qciMaxBitRate>
<sub1:qosId>QCI_5</sub1:qosId>
<sub1:maxBitRate>
<sub1:upLinkBw>5100</sub1:upLinkBw>
<sub1:downLinkBw>5000</sub1:downLinkBw>
</sub1:maxBitRate>
</sub1:qciMaxBitRate>
</sub1:qciMaxBitRates>
<!--Optional:-->
3-54 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<sub1:afApplications>
<!--Zero or more repetitions:-->
<sub1:afApplication>
<sub1:applicationIdentifier>AFApn3</sub1:applicati
onIdentifier>
<!--Optional:-->
<sub1:requestedPriority>9</sub1:requestedPriority>
<!--Optional:-->
<sub1:bandwidth>
<sub1:upLinkBw>300</sub1:upLinkBw>
<sub1:downLinkBw>350</sub1:downLinkBw>
</sub1:bandwidth>
<!--Optional:-->
<sub1:online>ENABLE_ONLINE</sub1:online>
<!--Optional:-->
<sub1:offline>DISABLE_OFFLINE</sub1:offline>
<!--Optional:-->
<sub1:meteringMethod>VOLUME</sub1:meteringMethod>
<!--Optional:-->
<sub1:ratingGroup>6</sub1:ratingGroup>
</sub1:afApplication>
</sub1:afApplications>
<!--Optional:-->
<sub1:customData>
<!--Zero or more repetitions:-->
<sub1:item>
<sub1:name>Language</sub1:name>
<sub1:value>
<sub1:type>LIST</sub1:type>
<sub1:data>STRING:English|French|BahasaMalaysia
</sub1:data>
</sub1:value>
</sub1:item>
</sub1:customData>
<!--Optional:-->
<sub1:customDataProfiles>
<!--Zero or more repetitions:-->
<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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-55
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
requests are handled by the 5780 DSC Type: boolean
for the subscriber. When set to false,
access to unknown applications is not Default: false
allowed.
(1 of 6)
3-56 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(2 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-57
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
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
downlink values as follows: 0 or a negative value.
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)
3-58 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(4 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-59
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
item — —
Defines the custom data used for a
single custom data entry based on:
• name
• value
value Values:
Defines the value of the item using: • STRING Mandatory
• type • IP_ADDRESS within each
• LIST item.
• data
• ENUM
type
• NUMBER
Type of data held in the custom data • DECIMAL
item.
Type: string
Default: no default value set
(5 of 6)
3-60 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(6 of 6)
Response code
Code 3-36 shows the response code for the updateSubscriberProfile command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-61
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/subsc
riberprofile"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
3.20 updateSubscriberProfileCustomData
Updates the complete set of subscriber profile custom data entries for the subscriber
profile object.
Parameters
• profileName
A unique name for the subscriber data.
• customData
Defines a list of one or more custom data entries (item).
Request code
Code 3-37 shows a request code example for the
updateSubscriberProfileCustomData command.
3-62 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
</sub:updateSubscriberProfileCustomData>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 3-34 and 3-35 list the fields for the updateSubscriberProfileCustomData
command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
value — —
Defines the value of the item using:
• type
• data
Type: Enum
Default: no default value set
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-63
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(2 of 2)
Response code
Code 3-38 shows the response code for the updateSubscriberProfileCustomData
command.
3-64 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
n"
xmlns:ns4="http://www.alcatellucent.com/dsc/provisioningapi/common"/
>
</env:Body>
</env:Envelope>
3.21 updateSubscriberProfileCustomDataEntry
Updates the specified subscriber profile custom data entry for the subscriber profile
object.
Parameters
• profileName
A unique name for the subscriber data.
• customData
Defines a list of one or more custom data entries (item).
Request code
Code 3-39 shows a request code example for the
updateSubscriberProfileCustomDataEntry command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-65
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
Request fields
Tables 3-36 and 3-37 lists the fields for the
updateSubscriberProfileCustomDataEntry command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
value — —
Defines the value of the item using:
• type
• data
Type: Enum
Default: no default value set
(1 of 2)
3-66 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
(2 of 2)
Response code
Code 3-40 shows the response code for the
updateSubscriberProfileCustomDataEntry command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-67
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
3.22 updateSubscriberProfileCustomDataProfiles
Updates the specified subscriber profile custom data profile for the subscriber profile
object.
Parameters
• profileName
A unique name for the subscriber data.
• customDataProfile
Defines a list of zero or more custom data profile names that are applied to the
subscriber.
Request code
Code 3-41 shows a request code example for the
updateSubscriberProfileCustomDataProfiles command.
3-68 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
<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
updateSubscriberProfileCustomDataProfiles command.
profileName A unique name for the subscriber profile. Values: 1 and 255 characters Optional
Type: string
Default: empty
Response code
Code 3-42 shows the response code for the
updateSubscriberProfileCustomDataProfiles command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 3-69
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
3 — Subscriber profile provisioning API
3-70 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4— Rule provisioning API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — 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
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Table 4-1 lists the fields required for the activateRuleSystemVersion command.
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.
4.3 addCustomDataProfiles
Adds a custom data profile object to the specified rule system version.
Parameter
• customDataProfile
Identifies the custom data profile.
Request code
Code 4-3 shows a request code example for the addCustomDataProfile command.
4-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<ns1:clientAppId>4821</ns1:clientAppId>
<ns1:requestId>396321</ns1:requestId
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:addCustomDataProfile>
<!--Zero or more repetitions:-->
<ns:customDataProfile>
<ns:versionedObjectId>
<ns:name>CDP1</ns:name>
<ns:ruleSystemVersionName>ns</ns:ruleSystemVersionNam
e>
</ns:versionedObjectId>
<!--Optional:-->
<ns:description>c1</ns:description>
<ns:priority>0</ns:priority>
<!--Optional:-->
<ns:customData>
<!--Zero or more repetitions:-->
<ns:item>
<ns:name>CD1</ns:name>
<ns:value>
<ns:type>DECIMAL</ns:type>
<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.
(1 of 3)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
item — —
Defines the custom data used for a
single custom data entry based on:
• name
• value
value — —
Defines the value of the item using:
• type
• value
Type: Enum
Default: no default value set
(2 of 3)
4-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(3 of 3)
Response code
Code 4-4 shows the response code for the addCustomDataProfile command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.4 addMeteringLimits
Parameter
• meteringLimit
Metering limit to be added.
Request code
Code 4-5 shows a request code example for the addMeteringLimits command.
4-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<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>
<type>DECIMAL</type>
<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>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<meteringLimit>
<versionedObjectId>
<name>NeverExpired_ML2</name>
<ruleSystemVersionName>clone1</ruleSystemVersionName>
</versionedObjectId>
<description>Never_Expired_ML2</description>
<meteringLimitType>BASIC</meteringLimitType>
<flowLevelArming>ML_flowKey</flowLevelArming>
<priority>2114901</priority>
<quotaType>TIME</quotaType>
<quota>3.0992E7</quota>
<overageAllowed>true</overageAllowed>
<baseUnit>160</baseUnit>
<minimumBaseUnit>15</minimumBaseUnit>
<recurrence>WEEKLY</recurrence>
<carryOverExpiration>NEVER_EXPIRE</carryOverExpiration>
<applicabilityConditions>
<condition>
<criteria>
<sourceContext>ACCOUNT</sourceContext>
<name>Account-Billing-Day</name>
</criteria>
<criteriaArguments/>
<operator>GREATER_THAN</operator>
<value>
<type>NUMBER</type>
<value>15</value>
</value>
<valueArguments/>
<adjustmentOperator>ADD</adjustmentOperator>
<adjustmentValues>
<value>
<value>
<type>TIME_DURATION</type>
<value>93785000</value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
</applicabilityConditions>
<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>
4-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-3 lists the fields required for the addMeteringLimits command.
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(2 of 7)
4-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
Type: enum
Default: n/a
Type: enum
Default: n/a
(3 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
(4 of 7)
4-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
threshold — —
Defines threshold crossings and the
actions to be taken.
(5 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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.
rateConditions — Optional
List of conditions under which the rating
factor is applied. If none are specified,
this rating factor is always used.
See Table 4-4 for a description of the
rateConditions
(6 of 7)
4-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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)
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
(1 of 3)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
value —
Defines the value of the item using:
• type
• value
type Values:
Type of data held in the custom data item. • STRING
• IP_ADDRESS
• LIST
• ENUM
• NUMBER
• DECIMAL
Type: Enum
value —
The Value parameter defines how the value(s) are input for the
comparison or collection.
(2 of 3)
4-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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)
actionAttribute The action attribute consists of a result context and attribute name. —
Type: string
(1 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
• PREVIOUS_SPR_SUBSCRIBER
• SERVICE_INFORMATION
• NAS_CLUSTER
• NASREQ_MESSAGE (rules tables only)
• AUXILIARY_GX_SESSION
• 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
(2 of 4)
4-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
• CHARGING_INFORMATION
• ARP
• SUBSCRIBER_QOS_OVERRIDE
• 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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
appear. Not all attributes have arguments so the adjustment
arguments section may not appear.
(4 of 4)
Response code
Code 4-6 shows the response code for the addMeteringLimits command.
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.
4-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<ns1:clientAppId>4821</ns1:clientAppId>
<ns1:requestId>396321</ns1:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:cloneRuleSystemVersion>
<!--Optional:-->
<ns:existingName>Default</ns:existingName>
<!--Optional:-->
<ns:cloneName>clonedRSns</ns:cloneName>
</ns:cloneRuleSystemVersion>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-6 lists the fields required for the cloneRuleSystemVersion command.
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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.
Request fields
Table 4-7 lists the fields required for the exportRuleSystemVersion command.
name Name of the existing rule system version. Values: 1 to 255 Mandatory
characters
Type: string
Default: n/a
4-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-10 shows the response code for the exportRuleSystemVersion command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
},
{
"name": "USAGE_RESET",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "IPCAN_SESSION_TERMINATION",
"RuleTablePrecedence": ["Default Notification
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"
}],
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "AUXGX_SESSION_ESTABLISHMENT",
"action": [
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.USER_LOCATION_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAI_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAT_CHANGE"
}
]
},
{
"name": "DYNAMIC_RULE_CREATION",
"action": [
{
"name": "DSC.Rating-Group",
"value": "5"
},
{
"name": "DSC.Service-Identifier",
"value": "1"
},
{
4-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"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"
}
],
"RuleTablePrecedence": [
"Media-Type to QCI",
"PCC Rule default QCI",
"Reservation Priority to ARP Priority",
"Default Notification Variables"
]
},
{
"name": "AF_SESSION_TERMINATION",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{"name": "GATEWAY_SESSION_TERMINATION"},
{
"name": "NASREQ_SESSION_CREATION",
"RuleTablePrecedence": [
"Default Notification Variables",
"Reject-Disabled-Subscriber-NAS-Creation"
]
},
{
"name": "NASREQ_SESSION_START",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "IPCAN_SESSION_ESTABLISHMENT",
"action": [
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAI_CHANGE"
},
{
"name": "DSC.Online",
"value": "null"
},
{
"name": "DSC.Offline",
"value": "null"
},
{
"name": "DSC.Charging\/QoS-Rule-Definition",
"value": "null"
},
{
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"name": "DSC.Event-Trigger",
"value": "EventTrigger.QOS_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.USER_LOCATION_CHANGE"
},
{
"name": "DSC.Charging-Information",
"value": "null"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.IP_CAN_CHANGE"
},
{
"name": "DSC.Bearer-Control-Mode",
"value": "null"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAT_CHANGE"
}
],
"RuleTablePrecedence": [
"Default Notification Variables",
"Reject-Disabled-Subscriber-IP-CAN-Establishment"
]
},
{
"name": "AF_SESSION_MODIFICATION",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{"name": "AUXGX_SESSION_TERMINATION"},
{
"name": "AF_SESSION_ESTABLISHMENT",
"RuleTablePrecedence": ["Default Notification
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":
"BitRateCheckResult.AUTHORIZE_AT_LOWER_RATE"
},
4-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
{
"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":
"QosUpgradeCheckResult.AUTHORIZE_AT_HIGHER_RATE"
}
],
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "NASREQ_DYNAMIC_AUTHORIZATION",
"RuleTablePrecedence": ["Default Notification
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": [{
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-29
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"name": "DSC.Session-Command",
"value": "SessionCommandType.TERMINATE"
}]
}]
},
{
"name": "Reject-Disabled-Subscriber-NAS-Creation",
"rules": [{
"name": "Reject Disabled Subscriber",
"precedence": 1,
"enabled": true,
"condition": "(SPR_SUBSCRIBER.Subscriber-State ==
SubscriberState.DISABLED)",
"actions": [{
"name": "DSC.Session-Command",
"value": "SessionCommandType.TERMINATE"
}]
}]
},
{
"name":
"Reject-Disabled-Subscriber-IP-CAN-Establishment",
"rules": [{
"name": "Reject Disabled Subscriber",
"precedence": 1,
"enabled": true,
"condition": "(DSC.Emergency-APNs DOES NOT CONTAIN
GX.Called-Station-ID) AND (SPR_SUBSCRIBER.Subscriber-State ==
SubscriberState.DISABLED)",
"actions": [{
"name": "DSC.Session-Command",
"value": "SessionCommandType.TERMINATE"
}]
}]
},
{
"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,
"condition": "(NASREQ_MESSAGE.NAS-Message-Type
== NASReqMessageType.ACCOUNTING_START)",
"actions": [{
"name": "DSC.Auxiliary-Request-Type",
4-30 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"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": [{
"name": "DSC.QoS-Class-Identifier",
"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": [{
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-31
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_2"
}]
},
{
"name": "Text To QCI 6",
"precedence": 7,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.TEXT)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_6"
}]
},
{
"name": "Other To QCI 9",
"precedence": 6,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.OTHER)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_9"
}]
},
{
"name": "Message To QCI 9",
"precedence": 5,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.MESSAGE)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_9"
}]
},
{
"name": "Data To QCI 8",
"precedence": 4,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.DATA)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_8"
}]
},
{
"name": "Control To QCI 6",
"precedence": 3,
"enabled": true,
4-32 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.CONTROL)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_6"
}]
},
{
"name": "Audio To QCI 1",
"precedence": 2,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.AUDIO)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_1"
}]
},
{
"name": "Application To QCI 2",
"precedence": 1,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.APPLICATION)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_2"
}]
}
]
},
{
"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":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "15"
}]
},
{
"name": "Seven",
"precedence": 7,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY7)",
"actions": [{
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-33
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "2"
}]
},
{
"name": "Six",
"precedence": 6,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY6)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "4"
}]
},
{
"name": "Five",
"precedence": 5,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY5)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "6"
}]
},
{
"name": "Four",
"precedence": 4,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY4)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "8"
}]
},
{
"name": "Three",
"precedence": 3,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY3)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "10"
}]
},
{
4-34 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"name": "Two",
"precedence": 2,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY2)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "12"
}]
},
{
"name": "One",
"precedence": 1,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY1)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "14"
}]
}
]
}
]
}</exportData>
</exportRuleSystemVersionResponse>
</env:Body>
</env:Envelope>
4.7 getActiveRuleSystemVersionName
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-35
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<rul:getActiveRuleSystemVersionName/>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-8 lists the fields required for the getActiveRuleSystemVersionName
command.
Response code
Code 4-12 shows the response code for the getActiveRuleSystemVersionName
command.
Response fields
Table 4-9 lists the fields for the getActiveRuleSystemVersionName command.
4-36 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.8 getCustomDataProfile
Gets a fully populated custom data profile object identified by the name specified.
Parameter
• versionedObjectId
Identifies a custom data profile by name and rule system version name.
Request code
Code 4-13 shows a request code example for the getCustomDataProfile command.
Request fields
Table 4-10 lists the fields required for the getCustomDataProfile command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-37
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-14 shows the response code for the getCustomDataProfile command.
Response fields
Table 4-11 lists the fields for the getCustomDataProfile command.
4-38 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
item —
Defines the custom data used for a single custom
data entry based on:
• name
• value
Type: Enum
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-39
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(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
• versionedObjectId
Identifies a custom data profile by name and rule system version name.
Request code
Code 4-15 shows a request code example for the
getCustomDataProfile_CustomData command.
4-40 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Table 4-12 lists the fields required for the getCustomDataProfile_CustomData
command.
Response code
Code 4-16 shows the response code for the getCustomDataProfile_CustomData
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-41
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<env:Body>
<getCustomDataProfile_CustomDataResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesyste
m"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
">
<customData>
<name>CDP1</name>
<value>
<type>DECIMAL</type>
<value>999.999</value>
</value>
</customData>
</getCustomDataProfile_CustomDataResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-13 lists the fields for the getCustomDataProfile command.
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)
4-42 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(2 of 2)
4.10 getCustomDataProfilePriority
Gets the priority from the custom data profiles object identified by name and rule
system version name.
Parameter
• versionedObjectId
Identifies a custom data profile by name and rule system version name.
Request code
Code 4-17 shows a request code example for the getCustomDataProfilePriority
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-43
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Table 4-14 lists the fields for the getCustomDataProfilePriority command.
Response code
Code 4-18 shows the response code for the getCustomDataProfilePriority command.
4-44 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<getCustomDataProfilePriorityResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesyste
m"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/common
">
<priority>0</priority>
</getCustomDataProfilePriorityResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-15 lists the fields for the getCustomDataProfilePriority command.
4.11 getMeteringLimit
Returns a fully populated metering limit object from the specified rule system
version.
Parameter
• versionedObjectId
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-45
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<rul:getMeteringLimit>
<!--Optional:-->
<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.
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.
4-46 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<minimumBaseUnit>1</minimumBaseUnit>
<recurrence>MONTHLY</recurrence>
<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.
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-47
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(2 of 5)
4-48 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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,
or 252. You cannot enter 0 or a
negative value.
Type: integer
Type: enum
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
See Table 4-4 for a description of the Conditions
applicability Conditions.
(3 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-49
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
threshold —
Defines threshold crossings and the actions to
be taken.
thresholdType Values:
Defines the threshold type to configure. • PERCENTAGE
PERCENTAGE • VALUE
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
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
The value of the threshold defined. maximum of 4503599627370495,
or 252. You cannot enter 0 or a
negative value.
Type: string
thresholdConditions —
List of conditions under which threshold
actions are applied.
See Table 4-4 for a description of the
Threshold Conditions.
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)
4-50 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
Controlled Overage metering limit
(5 of 5)
4.12 getMeteringLimitApplicabilityConditions
Returns the complete set of applicability conditions for the metering limit object.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-51
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Parameter
• versionedObjectId
Identifies the metering limit to be fetched specified by name and rule system
version name.
Request code
Code 4-21 shows a request code example for the
getMeteringLimitApplicabilityConditions command.
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
Note: A null value for the RSV name will
result in an error.
4-52 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-22 shows the response code for the
getMeteringLimitApplicabilityConditions command.
Response fields
Table 4-19 lists the fields for the getMeteringLimitApplicabilityConditions
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-53
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Type: tns:RelationalOperator
(1 of 2)
4-54 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
• CHARGING_INFORMATION
• ARP
• SUBSCRIBER_QOS_OVERRIDE
• 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
• versionedObjectId
Identifies the metering limit to be fetched specified by name and rule system
version name.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-55
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request code
Code 4-23 shows a request code example for the getMeteringLimitDefaultActions
command.
Request fields
Table 4-20 lists the fields required for the getMeteringDefaultActions 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
Note: A null value for the RSV name will
result in an error.
Response code
Code 4-24 shows the response code for the getMeteringLimitDefaultActions
command.
4-56 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<env:Body>
<getMeteringLimitDefaultActionsResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesyste
m"
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/common">
<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/>
<adjustmentOperator>ADD</adjustmentOperator>
<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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-57
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
actionAttribute The action attribute consists of a result context and attribute name. —
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
• PREVIOUS_SPR_SUBSCRIBER
• SERVICE_INFORMATION
• NAS_CLUSTER
• NASREQ_MESSAGE (rules tables only)
• AUXILIARY_GX_SESSION
• 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
(1 of 3)
4-58 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
• CHARGING_INFORMATION
• ARP
• SUBSCRIBER_QOS_OVERRIDE
• 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
adjustmentData Used to specify the amount of adjustment to apply to the Data Values: tns:GenericValue
Type: string
(2 of 3)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-59
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
appear. Not all attributes have arguments so the adjustment
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.
Request fields
Table 4-22 lists the fields required for the getMeteringLimitNames command.
4-60 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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-26 shows the response code for the getMeteringLimitNames command.
Response fields
Table 4-23 lists the fields for the getMeteringLimitNames command.
4.15 getMeteringLimitPriority
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-61
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Parameter
• versionedObjectId
Identifies the metering limit to be fetched specified by name and rule system
version name.
Request code
Code 4-27 shows a request code example for the getMeteringLimitPriority
command.
Request fields
Table 4-24 lists the fields required for the getMeteringLimitPriority command.
name The name of the metering limit to get. Values: 1 to 80 characters Mandatory
Type: string
Default: n/a
ruleSystemVersionName The name of the rule system version in Values: 1 to 80 characters Mandatory
which the metering limit is defined. Type: string
Note: A null value for the RSV name Default: n/a
will result in an error.
4-62 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-28 shows the response code for the getMeteringLimitPriority command.
Response fields
Table 4-25 lists the fields for the getMeteringLimitPriority command.
4.16 getMeteringLimitQuota
Parameter
• versionedObjectId
Identifies the metering limit to be fetched specified by name and rule system
version name.
Request code
Code 4-29 shows a request code example for the getMeteringLimitQuota command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-63
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
n"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesy
stem">
<soapenv:Header>
<ns1:header>
<ns1:clientAppId>4821</ns1:clientAppId>
<ns1:requestId>396321</ns1:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:getMeteringLimitQuota>
<!--Optional:-->
<ns:versionedObjectId>
<ns:name>ML1</ns:name>
<ns:ruleSystemVersionName>ns</ns:ruleSystemVersionName>
</ns:versionedObjectId>
</ns:getMeteringLimitQuota>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 4-26 lists the fields required for the getMeteringLimitQuota command.
name The name of the metering limit to get. Values: 1 to 80 characters Mandatory
Type: string
Default: n/a
ruleSystemVersionName The name of the rule system version in Values: 1 to 80 characters Mandatory
which 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-30 shows the response code for the getMeteringLimitQuota command.
4-64 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
</env:Envelope>
Response fields
Table 4-27 lists the fields for the getMeteringLimitQuota command.
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
• versionedObjectId
Identifies the metering limit to be fetched specified by name and rule system
version name.
Request code
Code 4-31 shows a request code example for the getMeteringLimits command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-65
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Table 4-28 lists the fields required for the getMeteringLimits command.
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-32 shows the response code for the getMeteringLimits command.
4-66 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<ratingInfos/>
<overageInfos/>
<overageReferenceData/>
</meteringLimit>
<meteringLimit>
<versionedObjectId>
<name>mlnew</name>
<ruleSystemVersionName>clone1</ruleSystemVersionName>
</versionedObjectId>
<description>Roaming_7_6_N</description>
<flowLevelArming>VFBIL_flowKey</flowLevelArming>
<meteringLimitType>BASIC</meteringLimitType>
<priority>2114900</priority>
<quotaType>TOTAL</quotaType>
<quota>2.0992E7</quota>
<overageAllowed>false</overageAllowed>
<baseUnit>102400.0</baseUnit>
<minimumBaseUnit>4</minimumBaseUnit>
<recurrence>MONTHLY</recurrence>
<carryOverExpiration>TWO_MONTHS</carryOverExpiration>
<applicabilityConditions>
<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>
<type>DECIMAL</type>
<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>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-67
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
</argument>
</criteriaArguments>
<operator>EQUAL</operator>
<value>
<type>ENUM</type>
<value>WNGEventSeverity.CRITICAL_CLEARED</value
>
</value>
<valueArguments/>
<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/>
<actionAdjustmentValues/>
</action>
</defaultActions>
<thresholds/>
<ratingInfos/>
<overageInfos/>
<overageReferenceData/>
</meteringLimit>
<meteringLimit>
<versionedObjectId>
<name>NeverExpired_ML2</name>
<ruleSystemVersionName>clone1</ruleSystemVersionName>
</versionedObjectId>
<description>Never_Expired_ML2</description>
<flowLevelArming>ML_flowKey</flowLevelArming>
<meteringLimitType>BASIC</meteringLimitType>
<priority>2114901</priority>
<quotaType>TIME</quotaType>
<quota>3.0992E7</quota>
<overageAllowed>true</overageAllowed>
<baseUnit>160.0</baseUnit>
<minimumBaseUnit>15</minimumBaseUnit>
<recurrence>WEEKLY</recurrence>
<carryOverExpiration>NEVER_EXPIRE</carryOverExpiration>
<applicabilityConditions>
<condition>
<criteria>
<sourceContext>ACCOUNT</sourceContext>
<name>Account-Billing-Day</name>
</criteria>
<criteriaArguments/>
<operator>GREATER_THAN</operator>
<value>
4-68 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<type>NUMBER</type>
<value>15</value>
</value>
<valueArguments/>
<adjustmentOperator>ADD</adjustmentOperator>
<adjustmentValues>
<value>
<value>
<type>TIME_DURATION</type>
<value>93785000</value>
</value>
<arguments/>
</value>
</adjustmentValues>
</condition>
</applicabilityConditions>
<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/>
<overageReferenceData/>
</meteringLimit>
</getMeteringLimitsResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-29 lists the fields for the getMeteringLimits command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-69
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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.
(1 of 5)
4-70 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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,
or 252. You cannot enter 0 or a
negative value.
Type: integer
Type: enum
(2 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-71
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
See Table 4-4 for a description of the Conditions
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)
4-72 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
threshold —
The type of threshold defined in the metering
limit.
thresholdType Values:
Defines the threshold type to configure. • PERCENTAGE
PERCENTAGE • VALUE
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
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
The value of the threshold defined. maximum of 4503599627370495,
or 252. You cannot enter 0 or a
negative value.
Type: string
thresholdConditions —
List of conditions under which threshold actions
are applied.
See Table 4-4 for a description of the Threshold
Conditions.
(4 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-73
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
Controlled Overage metering limit
(5 of 5)
4.18 getRuleSystemVersion
Parameter
• name
Name of the rule system version to be fetched.
4-74 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request code
Code 4-33 shows a request code example for the getRuleSystemVersion command.
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-75
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<state>DRAFT</state>
</ruleSystemVersion>
</getRuleSystemVersionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-31 lists the fields for the getRuleSystemVersion command.
4.19 getRuleSystemVersionDescription
Parameter
• name
Name of the rule system version to be fetched.
4-76 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request code
Code 4-35 shows a request code example for the getRuleSystemVersionDescription
command.
<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.
Response code
Code 4-36 shows the response code for the getRuleSystemVersionDescription
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-77
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
</ruleSystemVersion>
</getRuleSystemVersionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 4-33 lists the fields for the getRuleSystemVersionDescription command.
4.20 getRuleSystemVersionNames
Parameter
• name
Name of the rule system version to be fetched.
Request code
Code 4-37 shows a request code example for the getRuleSystemVersionNames
command.
Request fields
Table 4-34 lists the fields required for the getRuleSystemVersionNames command.
4-78 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-38 shows the response code for the getRuleSystemVersionNames command.
Response fields
Table 4-35 lists the fields for the getRuleSystemVersionNames command.
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
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-79
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
• 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.
4-80 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"name": "DSC.Event-Trigger",
"value": "EventTrigger.QOS_CHANGE"
},
{
"name": "DSC.Online",
"value": "null"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAI_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.USER_LOCATION_CHANGE"
},
{
"name": "DSC.Charging\/QoS-Rule-Definition",
"value": "null"
},
{
"name":
"DSC.Charging\/QoS-Rule-Definition-Name",
"value": "null"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.IP_CAN_CHANGE"
}
],
"RuleTablePrecedence": [
"Default Notification Variables",
"Reject-Disabled-Subscriber-IP-CAN-Establishment"
]
},
{
"name": "USAGE_RESET",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "PENALTY_CLEAR",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "QOS_MANAGEMENT",
"action": [
{
"name": "DSC.QoS-Negotiation-GBR-Result",
"value":
"BitRateCheckResult.AUTHORIZE_AT_LOWER_RATE"
},
{
"name":
"DSC.Allocation-Retention-Priority.Pre-emption-Capability",
"value": "null"
},
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-81
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
{
"name": "DSC.QoS-Upgrade-MBR-Result",
"value":
"QosUpgradeCheckResult.AUTHORIZE_AT_HIGHER_RATE"
},
{
"name": "DSC.Default-Bearer-QCI",
"value": "null"
},
{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "null"
},
{
"name": "DSC.Default-Bandwidth-UL",
"value": "0"
},
{
"name": "DSC.QoS-Negotiation-MBR-Result",
"value":
"BitRateCheckResult.AUTHORIZE_AT_LOWER_RATE"
},
{
"name":
"DSC.Allocation-Retention-Priority.Pre-emption-Vulnerability",
"value": "null"
},
{
"name": "DSC.QoS-Upgrade-GBR-Result",
"value":
"QosUpgradeCheckResult.AUTHORIZE_AT_HIGHER_RATE"
},
{
"name": "DSC.Default-Bandwidth-DL",
"value": "0"
}
],
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{"name": "GATEWAY_SESSION_MODIFICATION"},
{
"name": "NASREQ_AUX_DYNAMIC_AUTHORIZATION",
"RuleTablePrecedence": ["Auxiliary Request Type"]
},
{
"name": "AF_SESSION_TERMINATION",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "NASREQ_SESSION_CREATION",
"RuleTablePrecedence": [
"Default Notification Variables",
"Reject-Disabled-Subscriber-NAS-Creation"
]
4-82 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
},
{
"name": "NASREQ_SESSION_STOP",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "NASREQ_DYNAMIC_AUTHORIZATION",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{"name": "AUXGX_SESSION_TERMINATION"},
{
"name": "AF_SESSION_MODIFICATION",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "DYNAMIC_RULE_CREATION",
"action": [
{
"name": "DSC.Metering-Method",
"value": "MeteringMethod.DURATION_VOLUME"
},
{
"name": "DSC.Service-Identifier",
"value": "1"
},
{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_5"
},
{
"name": "DSC.Rating-Group",
"value": "5"
},
{
"name": "DSC.Reporting-Level",
"value": "ReportingLevel.RATING_GROUP_LEVEL"
}
],
"RuleTablePrecedence": [
"Media-Type to QCI",
"PCC Rule default QCI",
"Reservation Priority to ARP Priority"
]
},
{
"name": "AUXGX_SESSION_ESTABLISHMENT",
"action": [
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAI_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.USER_LOCATION_CHANGE"
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-83
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAT_CHANGE"
}
]
},
{
"name": "IPCAN_SESSION_MODIFICATION",
"action": [{
"name": "DSC.IPCanSessionModificationResult",
"value": "IPCanSessionModificationResult.REMOVE"
}],
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "IPCAN_SESSION_TERMINATION",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{
"name": "SPR_NOTIFICATION_UPDATE",
"RuleTablePrecedence": [
"Default Notification Variables",
"Reject-Disabled-Subscriber-SPR-Modification"
]
},
{"name": "SPR_NOTIFICATION_DELETE"},
{"name": "AUXGX_SESSION_MODIFICATION"},
{
"name": "AF_SESSION_ESTABLISHMENT",
"RuleTablePrecedence": ["Default Notification
Variables"]
},
{"name": "GATEWAY_SESSION_TERMINATION"},
{
"name": "GATEWAY_SESSION_ESTABLISHMENT",
"action": [
{
"name": "DSC.Bearer-Control-Mode",
"value": "null"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RAT_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.USER_LOCATION_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.QOS_CHANGE"
},
{
"name": "DSC.Event-Trigger",
4-84 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"value":
"EventTrigger.DEFAULT_EPS_BEARER_QOS_CHANGE"
},
{
"name": "DSC.Event-Trigger",
"value": "EventTrigger.RECOVERY_OF_BEARER"
},
{
"name": "DSC.Event-Trigger",
"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": [{
"name": "DSC.QoS-Class-Identifier",
"value":
"SERVICE_DATA.QoS-Information.QoS-Class-Identifier"
}]
}]
},
{
"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": "Reservation Priority to ARP Priority",
"rules": [
{
"name": "Zero",
"precedence": 8,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.DEFAULT)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-85
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"value": "8"
}]
},
{
"name": "Seven",
"precedence": 7,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY7)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "2"
}]
},
{
"name": "Six",
"precedence": 6,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY6)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "4"
}]
},
{
"name": "Five",
"precedence": 5,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY5)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "6"
}]
},
{
"name": "Four",
"precedence": 4,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY4)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "8"
}]
},
{
"name": "Three",
"precedence": 3,
4-86 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY3)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "10"
}]
},
{
"name": "Two",
"precedence": 2,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY2)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "12"
}]
},
{
"name": "One",
"precedence": 1,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Reservation-Priority ==
ReservationPriority.PRIORITY1)",
"actions": [{
"name":
"DSC.Allocation-Retention-Priority.Priority-Level",
"value": "14"
}]
}
]
},
{
"name": "Reject-Disabled-Subscriber-NAS-Creation",
"rules": [{
"name": "Reject Disabled Subscriber",
"precedence": 1,
"enabled": true,
"condition": "(SPR_SUBSCRIBER.Subscriber-State ==
SubscriberState.DISABLED)",
"actions": [{
"name": "DSC.Session-Command",
"value": "SessionCommandType.TERMINATE"
}]
}]
},
{
"name": "Auxiliary Request Type",
"rules": [
{
"name": "Accounting Stop",
"precedence": 2,
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-87
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"enabled": true,
"condition": "(NASREQ_MESSAGE.NAS-Message-Type
== NASReqMessageType.ACCOUNTING_STOP)",
"actions": [
{
"name": "DSC.Auxiliary-Request-Type",
"value":
"AuxiliaryRequestType.DISCONNECT"
},
{
"name":
"NASREQ_MESSAGE.ALUTIMETRA.ALC-AA-Transit-IP",
"value": "1"
}
]
},
{
"name": "Default",
"precedence": 1,
"enabled": true,
"condition": "true",
"actions": [
{
"name": "DSC.Auxiliary-Request-Type",
"value": "AuxiliaryRequestType.COA"
},
{
"name":
"NASREQ_MESSAGE.ALUTIMETRA.ALC-AA-Transit-IP",
"value": "1"
}
]
}
]
},
{
"name":
"Reject-Disabled-Subscriber-IP-CAN-Establishment",
"rules": [{
"name": "Reject Disabled Subscriber",
"precedence": 1,
"enabled": true,
"condition": "(DSC.Emergency-APNs DOES NOT CONTAIN
GX.Called-Station-ID) AND (SPR_SUBSCRIBER.Subscriber-State ==
SubscriberState.DISABLED)",
"actions": [{
"name": "DSC.Session-Command",
"value": "SessionCommandType.TERMINATE"
}]
}]
},
{
"name": "Media-Type to QCI",
"rules": [
{
"name": "Video To QCI 2",
"precedence": 8,
4-88 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.VIDEO)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_2"
}]
},
{
"name": "Text To QCI 6",
"precedence": 7,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.TEXT)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_6"
}]
},
{
"name": "Other To QCI 9",
"precedence": 6,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.OTHER)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_9"
}]
},
{
"name": "Message To QCI 9",
"precedence": 5,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.MESSAGE)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_9"
}]
},
{
"name": "Data To QCI 8",
"precedence": 4,
"enabled": true,
"condition":
"(SERVICE_DATA.Media-Component-Description.Media-Type ==
MediaType.DATA)",
"actions": [{
"name": "DSC.QoS-Class-Identifier",
"value": "QOSClassIdentifier.QCI_8"
}]
},
{
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-89
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4-90 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
"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.
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.
4.22 removeCustomDataProfile
Removes the specified custom data profile from the given rule system version.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-91
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Parameter
• versionedObjectId
Identifies the custom data profile name and rule system version.
Request code
Code 4-41 shows a request code example for the removeCustomDataProfile
command.
Request fields
Table 4-37 lists the fields required for the removeCustomDataProfile command.
4-92 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-42 shows the response code for the removeCustomDataProfile command.
4.23 removeMeteringLimit
Removes the specified metering limit from the specified subscriber object.
Parameter
• versionedObjectId
Identifies the metering limit to be removed.
Request code
Code 4-43 shows a request code example for the removeMeteringLimit command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-93
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Table 4-38 lists the fields required for the removeMeteringLimit command.
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.
4.24 removeRuleSystemVersion
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.
4-94 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
n"
xmlns:ns="http://www.alcatellucent.com/dsc/provisioningapi/51/rulesy
stem">
<soapenv:Header>
<ns1:header>
<ns1:clientAppId>4821</ns1:clientAppId>
<ns1:requestId>396321</ns1:requestId>
</ns1:header>
</soapenv:Header>
<soapenv:Body>
<ns:removeRuleSystemVersion>
<!--Optional:-->
<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.
4.25 updateCustomDataProfile
Updates a custom data profile object, replacing all existing attributes with those
specified, applying defaults as required.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-95
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Parameter
• customDataProfile
The custom data profile to be updated.
Request code
Code 4-47 shows a request code example for the updateCustomDataProfile
command.
Request fields
Table 4-40 lists the fields required for the updateCustomDataProfile command.
4-96 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
item — —
Defines the custom data used for a
single custom data entry based on:
• name
• value
value — —
Defines the value of the item using:
• type
• data
Type: Enum
Default: no default value set
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-97
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(2 of 2)
Response code
Code 4-48 shows the response code for the updateCustomDataProfile command.
4-98 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.26 updateCustomDataProfile_CustomData
Updates the complete set of custom data entries for the specified custom data profile
object.
Parameters
• versionedObjectId
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
Code 4-49 shows a request code example for the
updateCustomDataProfile_CustomData command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-99
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Tables 4-41 and 4-42 lists the fields required for the
updateCustomDataProfile_CustomData command.
value — —
Defines the value of the item using:
• type
• data
Type: Enum
Default: no default value set
(1 of 2)
4-100 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(2 of 2)
Response code
Code 4-50 shows the response code for the updateCustomDataProfile_CustomData
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-101
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.27 updateCustomDataProfile_CustomDataEntry
Updates a single custom data entry for the custom data profile object.
Parameters
• versionedObjectId
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
Code 4-51 shows a request code example for the
updateCustomDataProfile_CustomDataEntry command.
Request fields
Tables 4-43 and 4-44 lists the fields required for the
updateCustomDataProfile_CustomDataEntry command.
4-102 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
value — —
Defines the value of the item using:
• type
• data
Type: Enum
Default: no default value set
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-103
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
(2 of 2)
Response code
Code 4-52 shows the response code for the
updateCustomDataProfile_CustomDataEntry command.
4-104 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.28 updateCustomDataProfilePriority
Parameters
• versionedObjectId
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.
Request fields
Tables 4-45 and 4-46 lists the fields required for the
updateCustomDataProfilePriority command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-105
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-54 shows the response code for the updateCustomDataProfilePriority
command.
4.29 updateMeteringLimit
Updates the specified metering limit object by replacing the existing version with the
one provided.
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.
4-106 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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.
Parameter
• meteringLimit
Metering limit to be assigned to the subscriber.
Request code
Code 4-55 shows a request code example for the updateMeteringLimit command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-107
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<rul:sourceContext>WNG_EVENTS</rul:sourceContex
t>
<rul:name>WNG-Event.Severity</rul:name>
</rul:criteria>
<!--Optional:-->
<rul:criteriaArguments>
<!--1 or more repetitions:-->
<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>
<!--Optional:-->
</rul:condition>
</rul:applicabilityConditions>
<!--Optional:-->
<rul:defaultActions>
<!--1 or more repetitions:-->
<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>
<!--Optional:-->
<rul:thresholds>
<!--1 or more repetitions:-->
<rul:threshold>
<rul:name>th80</rul:name>
<!--Optional:-->
<rul:thresholdType>PERCENTAGE</rul:thresholdType>
<!--Optional:-->
<rul:thresholdValue>80</rul:thresholdValue>
<rul:recurringThreshold>false</rul:recurringThresh
old>
</rul:threshold>
</rul:thresholds>
</rul:meteringLimit>
</rul:updateMeteringLimit>
</soapenv:Body>
</soapenv:Envelope>
4-108 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Request fields
Table 4-47 lists the fields required for the updateMeteringLimit command.
(1 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-109
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
Type: enum
Default: n/a
(2 of 5)
4-110 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
See Table 4-4 for a description of the Conditions
applicability Conditions. Default: n/a
(3 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-111
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
threshold — —
Defines threshold crossings and the
actions to be taken.
(4 of 5)
4-112 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
provisioned within a metering limit.
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
(5 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-113
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-56 shows the response code for the updateMeteringLimit command.
4.30 updateMeteringLimitApplicabilityConditions
Updates the complete set of applicability conditions for the metering limit.
Parameters
• versionedObjectId
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
Code 4-57 shows a request code example for the
updateMeteringLimitApplicabilityConditions command.
4-114 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<rul:ruleSystemVersionName>clonedRSV2</rul:ruleSystemVer
sionName>
</rul:versionedObjectId>
<!--Zero or more repetitions:-->
<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>987654321</rul:value>
</rul:value>
</rul:condition>
</rul:updateMeteringLimitApplicabilityConditions>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-48 and 4-49 lists the fields required for the
updateMeteringLimitApplicabilityConditions command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-115
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Type: tns:RelationalOperator
(1 of 2)
4-116 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
• CHARGING_INFORMATION
• ARP
• SUBSCRIBER_QOS_OVERRIDE
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 shows the response code for the
updateMeteringLimitApplicabilityConditions command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-117
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
</env:Body>
</env:Envelope>
4.31 updateMeteringLimitDefaultActions
Updates the complete set of default actions for the metering limit.
Parameters
• versionedObjectId
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
Code 4-59 shows a request code example for the
updateMeteringLimitDefaultActions command.
4-118 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<!--Optional:-->
<rul:adjustmentOperator>ADD</rul:adjustmentOperator>
<!--Optional:-->
<rul:adjustmentData>
<rul:type>NUMBER</rul:type>
<rul:value>4</rul:value>
</rul:adjustmentData>
<!--Optional:-->
</rul:action>
</rul:updateMeteringLimitDefaultActions>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-50 and 4-51 lists the fields required for the
updateMeteringLimitDefaultActions command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-119
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
actionAttribute The action attribute consists of a result context and attribute name. —
Type: string
(1 of 2)
4-120 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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
• CHARGING_INFORMATION
• ARP
• SUBSCRIBER_QOS_OVERRIDE
• CUSTOM_DATA
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
adjustmentData Used to specify the amount of adjustment to apply to the Data Values: tns:GenericValue
Type: string
(2 of 2)
Response code
Code 4-60 shows the response code for the updateMeteringLimitDefaultActions
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-121
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.32 updateMeteringLimitPriority
Parameters
• versionedObjectId
The ID of the metering limit to be fetched.
• 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.
4-122 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
<!--Optional:-->
<ns:priority>4</ns:priority>
</ns:updateMeteringLimitPriority>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 4-52 and 4-53 list the fields required for the updateMeteringLimitPriority
command.
Response code
Code 4-62 shows the response code for the updateMeteringLimitPriority command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-123
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.33 updateMeteringLimitQuota
Parameters
• versionedObjectId
The ID of the metering limit to be fetched.
• 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.
Request fields
Tables 4-54 and 4-55 lists the fields required for the updateMeteringLimitQuota
command.
4-124 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
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.
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.
4.34 updateMeteringLimitRateLimitRate
Updates the rate within a specified rating limit for the metering limit.
Parameters
• versionedObjectId
The ID of the metering limit to be fetched.
• rcfName
Unique name for the rating information entry.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-125
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
• 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
Code 4-65 shows a request code example for the
updateMeteringLimitRateLimitRate command.
Request fields
Tables 4-56 , 4-57, and 4-58 list the fields required for the
updateMeteringLimitRateLimitRate command.
4-126 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
versionedObjectId The ID of the metering limit for which the rule will be — Mandatory
updated.
rcfName Unique name for the rating information entry. Values: 1 to 80 characters Mandatory
Type:string
Response code
Code 4-66 shows the response code for the updateMeteringLimitRateLimitRate
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-127
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4.35 updateRuleSystemVersionDescription
Parameters
• name
Name of the rule system version to be updated.
• description
Information about the rule system version.
Request code
Code 4-67 shows a request code example for the
updateRuleSystemVersionDescription command.
</soapenv:Envelope>
Request fields
Tables 4-59 list the fields required for the updateRuleSystemVersionDescription
command.
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
4-128 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
Response code
Code 4-68 shows the response code for the updateRuleSystemVersionDescription
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 4-129
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
4 — Rule provisioning API
4-130 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5— NASREQ session API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — 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
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.
5-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
<ns:subscriptionId>
<ns:type>END_USER_NAI</ns:type>
<ns:value>john.smith@abccompany.com</ns:value>
</ns:subscriptionId>
</ns:bindSubscriber>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 5-1 and 5-2 lists the fields required for the bindSubscriber command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a either userId or
subscriberId.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
5-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
Response code
Code 5-2 shows the response code for the bindSubscriber command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
5.3 disconnectSession
Parameter
• sessionIdentifier
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.
Request fields
Tables 5-3 and lists the fields required for the disconnectSession command.
5-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a either userId or
subscriberId.
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
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
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
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
Response code
Code 5-4 shows the response code for the disconnectSession command.
5.4 getSession
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 5-5 shows a request code example for the getSession command.
5-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
Request fields
Table 5-4 lists the fields required for the command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a either userId or
subscriberId.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
5-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
Response code
Code 5-6 shows the response code for the getSession command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
<acctMultiSessionId>acct-session-id-2</acctMultiSessionI
d>
<!--Optional:-->
<nasInfo>
<!--Zero or more repetitions:-->
<nas>
<!--Optional:-->
<type>STANDALONE</type>
<!--Optional:-->
<identifier>nas1</identifier>
<!--Optional:-->
<ipAddress>127.32.67.15</ipAddress>
<!--Optional:-->
<ipv6Address>::127.32.67.15</ipv6Address>
</nas>
</nasInfo>
<!--Optional:-->
<nasPort>1813</nasPort>
<!--Optional:-->
<nasPortId>nas1_port</nasPortId>
<!--Optional:-->
<nasPortType>SYNC</nasPortType>
<!--Optional:-->
<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.
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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
(1 of 6)
5-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription
based on:
• type
• value
(2 of 6)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
diameterHost The name of the Diameter host of the gateway. Values:1 to 255 characters
Type: string
value —
Defines the value of the item using:
• type
• value
(3 of 6)
5-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
Type: enum
nasPort Contains the physical port number of the NAS which Values:1-80 characters
is authenticating the user. Type: integer
(5 of 6)
5-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 5-7 shows a request code example for the getSessionSummary command.
Request fields
Table 5-6 lists the fields required for the command.
5-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Mandatory
Type: string
Default: n/a
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
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
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
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
Response code
Code 5-8 shows the response code for the getSessionSummary command.
5-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
<!--Optional:-->
<vendorSpecificAttributes>
<!--Zero or more repetitions:-->
<vendorSpecificAttribute>
<name>ALUTIMETRA.ALC-Subscriber-Profile-String</na
me>
<value>
<type>STRING</type>
<value>HSI_Gold_Sub</value>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
</nasreqSessionSummary>
</getSessionSummaryResponse>
</env:Body>
</env:Envelope>
Table 5-7 lists the fields required for the getSessionSummary command.
sessionId A unique number that the server assigns to a user Values: valid session id
for the duration of session. Type: string
(1 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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
E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription
based on:
• type
• value
type Values:
The type of identifier that is carried by the • END_USER_E164
associated value. • END_USER_IMSI
END_USER_E164 • END_USER_SIP_URI
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 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
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.
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:
<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 4)
5-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 5-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
5 — NASREQ session API
item —
Defines the custom data used for a single custom
data entry based on:
• name
• value
value —
Defines the value of the item using:
• type
• value
type Values:
Type of data held in the vendorSpecificAttributes • STRING
item. • IP_ADDRESS
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
List is an option for each of the following:
• STRING
• IP_ADDRESS
(4 of 4)
5-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6— IP-CAN session API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — 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
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 6-1 shows a request code example for the getSession command.
6-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
Request fields
Table 6-1 lists the fields required for the command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a userId, subscriberId,
ipAddress or ipv6Prefix
to identify the
subscriber.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
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
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
Response code
Code 6-2 shows the response code for the getSession command.
6-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
<vendorSpecificAttribute>
<name>ALU.Diameter-Client-Type</name>
<value>
<type>STRING</type>
<value>Default</value>
</value>
</vendorSpecificAttribute>
<vendorSpecificAttribute>
<name>ALU.3GPP-Minor-Version</name>
<value>
<type>STRING</type>
<value>DIAMETER_PEER_DECEMBER_2009</value>
</value>
</vendorSpecificAttribute>
<vendorSpecificAttribute>
<name>ALU.Vendor-Type</name>
<value>
<type>NUMBER</type>
<value>3</value>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
<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>
<online>ENABLE_ONLINE</online>
<offline>ENABLE_OFFLINE</offline>
<pccRules/>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
<sySessionId>tpapps.realm;1353697191;1;SySession</sySess
ionId>
<AFSessions/>
</ipcanSession>
</getSessionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 6-2 lists the fields for the command.
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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
(1 of 15)
6-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription
based on:
• type
• value
type Values:
The type of identifier that is carried by the • END_USER_E164
associated value. • END_USER_IMSI
END_USER_E164 • END_USER_SIP_URI
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 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
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.
diameterHost The name of the Diameter host of the gateway. Values:1 to 255 characters
Type: string
(2 of 15)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
vendorSpecificAttributes vendorSpecificAttribute —
(continued) Defines the vendorSpecificAttribute used for a
single entry based on:
• name
• value
value —
Defines the value of the item using:
• type
• value
type Values:
Type of data held in the vendorSpecificAttributes • STRING
item. • IP_ADDRESS
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
List is an option for each of the following:
• STRING
• IP_ADDRESS
(3 of 15)
6-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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)
6-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
related with the same APN. 252. You cannot enter 0 or a negative
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
related with the same APN. 252. You cannot enter 0 or a negative
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
related with the same APN. 252. You cannot enter 0 or a negative
value.
Type: long
(6 of 15)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
• preEmptionCapability
• preEmptionVulnerability
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)
6-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
252. You cannot enter 0 or a negative
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
252. You cannot enter 0 or a negative
value.
Type: string
(8 of 15)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
sgsnIpv6Address Identifies the IPv6 address of the SGSN. Values: Long values of up to a
maximum of 4503599627370495, or
252. You cannot enter 0 or a negative
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
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)
6-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
(11 of 15)
6-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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)
6-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
(14 of 15)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
(15 of 15)
6.3 getSessionSummary
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 6-3 shows a request code example for the getSessionSummary command.
6-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
</ses:sessionIdentifier>
</ses:getSessionSummary>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 6-3 lists the fields required for the command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string
Default: n/a
subscriptionId The subscriptionId identifies the subscription based on a valid Default: n/a Optional
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:
• type
• value
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
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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
hexadecimal numbers
separated by colons and uses
the following format:
<ipv6Prefix>/<PrefixLength>
For example:
0011:2233:4455:6677:889
9:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation
for supported IPv6 Prefix
representations.
(2 of 2)
Response code
Code 6-4 shows the response code for the getSessionSummary command.
6-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
<AdjustedApnMaximumBitrateDL>0</AdjustedApnMaximumBitrat
eDL>
<AdjustedApnMaximumBitrateUL>0</AdjustedApnMaximumBitrat
eUL>
<lastUpdatedTime>2012-10-17 15:47:39</lastUpdatedTime>
<pccRuleNames>
<ruleName>ggsn_gold</ruleName>
</pccRuleNames>
<vendorSpecificAttributes>
<vendorSpecificAttribute>
<name>ALU.Diameter-Client-Type</name>
<value>
<type>STRING</type>
<value>Default</value>
</value>
</vendorSpecificAttribute>
<vendorSpecificAttribute>
<name>ALU.Vendor-Type</name>
<value>
<type>NUMBER</type>
<value>3</value>
</value>
</vendorSpecificAttribute>
<vendorSpecificAttribute>
<name>ALU.3GPP-Minor-Version</name>
<value>
<type>STRING</type>
<value>DIAMETER_PEER_DECEMBER_2009</value>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
</ipcanSessionSummary>
</getSessionSummaryResponse>
</env:Body>
</env:Envelope>
Table 6-4 lists the fields required for the getSessionSummary command.
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of session. Type: string
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
(1 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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 E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• type
• value
type Values:
The type of identifier that is carried by the associated value. • END_USER_E164
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].
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.
(2 of 5)
6-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
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 —
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
• preEmptionCapability
• preEmptionVulnerability
priorityLevel Values: 1 to 15
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
resource limitations.
(3 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
Type: string
preEmptionVulnerability Values:
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,
or 252. You cannot enter 0 or a
negative value.
Type: string
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a single entry
based on:
• name
• value
value —
Defines the value of the item using:
• type
• value
(4 of 5)
6-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
(5 of 5)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 6-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
6 — IP-CAN session API
6-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7— AF session API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
7.2 getSession
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 7-1 shows a request code example for the getSession command.
7-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
Request fields
Table 7-1 lists the fields required for the command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a userId, subscriberId,
ipAddress or ipv6Prefix
to identify the
subscriber.
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
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
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation for
supported IPv6 Prefix
representations.
(2 of 2)
Response code
Code 7-2 shows the response code for the getSession command.
7-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
<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>
<afApplicationId>application_1</afApplicationId>
<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>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit in ip from
2001:db8:85a3:0:0:8a2e:373:7331 to 8.8.8.11</flowDescription1>
<flowDescription2>permit out ip from 8.8.8.11
to 2001:db8:85a3:0:0:8a2e:373:7331</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afSign
allingProtocol>
</subComponentFlowDescription>
</subComponentFlowDescriptions>
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
<anChargingIds>
<chargingId>
<anChargingIdValue>ANCIValue</anChargingIdValue>
<serviceFlows>
<serviceFlow>
<afSessionId>afsess1</afSessionId>
<mediaComponentNumber>1</mediaComponentNumbe
r>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
<flowNumber>1</flowNumber>
</serviceFlow>
<serviceFlow>
<afSessionId>afsess1</afSessionId>
<mediaComponentNumber>1</mediaComponentNumbe
r>
<flowNumber>2</flowNumber>
</serviceFlow>
</serviceFlows>
</chargingId>
</anChargingIds>
</afSession>
<afSession>
<sessionId>afsess2</sessionId>
<lastUpdatedTime>2013-02-06 06:10:14</lastUpdatedTime>
<userId>testSub1</userId>
<sessionBindingIdentifier>
<ipAddress>111.111.11.1</ipAddress>
<calledStationId>apn2</calledStationId>
<subscriptionIds>
<subscriptionId>
<type>END_USER_IMSI</type>
<value>31012000091</value>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<diameterHost>dsc67.18002.clientRealm.18002</diameterHos
t>
<vendorSpecificAttributes/>
<afApplicationId>application_1</afApplicationId>
<afChargingId>21586</afChargingId>
<serviceInfoStatus>FINAL_SERVICE_INFORMATION</serviceInf
oStatus>
<reservationPriority>0</reservationPriority>
<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>
<ipCanSessionId>gxsess2</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>
7-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
<maxRequestedBandwidthUL>1000</maxRequestedBandwid
thUL>
<subComponentFlowDescriptions>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit out ip from 8.8.8.11
to 111.111.11.1</flowDescription1>
<flowDescription2>permit in ip from
111.111.11.1 to 8.8.8.11</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afSign
allingProtocol>
</subComponentFlowDescription>
</subComponentFlowDescriptions>
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
<anChargingIds/>
</afSession>
</getSessionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 7-2 lists the fields for the command.
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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
(1 of 10)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription
based on:
• type
• value
(2 of 10)
7-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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 Values: Attribute value pairs as defined by the vendor.
AF session. Type: string
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a
single entry based on:
• name
• value
name Values: As defined in the vendor dictionaries, for example:
A unique vendor name. ALC-App-Prof-Str.
Type: string
value —
Defines the value of the item using:
• type
• value
(3 of 10)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
afApplicationId Indicates the interfaces that the PCRF supports for Values:
the authentication and authorization portion of the • 1 and 255 characters (ASCII)
application.
• 1 and 510 characters (Hexadecimal)
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
Type: tns:ServiceInfoStatus
(4 of 10)
7-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
serviceURN Indicates that an AF Session is used for emergency Values: 1 to 255 characters long
traffic; for example, sos.fire. Type: string
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
mediaType Values:
Determines the media type of a session component. • AUDIO
• VIDEO
• DATA
• APPLICATION
• CONTROL
• TEXT
• MESSAGE
• OTHER
Type: enum
(5 of 10)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
during the AF creation of a PCC rule.
(6 of 10)
7-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
• flowDescription2
• afSignallingProtocol
flowUsage Values:
Provides information about the usage of IP Flows • NO_INFORMATION
• RTCP
• AF_SIGNALLING
Type: enum
(7 of 10)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
(8 of 10)
7-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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.
(9 of 10)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
during the AF creation of a PCC rule.
(10 of 10)
7.3 getSessionSummary
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id, IP
Address, IPv6 Prefix.
Request code
Code 7-3 shows a request code example for the getSessionSummary command.
7-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
</soapenv:Header>
<soapenv:Body>
<ses:getSessionSummary>
<!--Optional:-->
<ses:sessionIdentifier>
<!--Optional:-->
<ses:userId>subscriberId</ses:userId>
<!--Optional:-->
<ses:subscriptionId>
<ses:type>END_USER_NAI</ses:type>
<ses:value>a@a.com</ses:value>
</ses:subscriptionId>
<!--Optional:-->
<ses:ipAddress>1.1.1.1</ses:ipAddress>
<!--Optional:-->
<ses:ipv6Prefix>1:2:3:4:5:6:7:8</ses:ipv6Prefix>
</ses:sessionIdentifier>
</ses:getSessionSummary>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 7-3 lists the fields required for the command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string
Default: n/a
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
subscriptionId The subscriptionId identifies the subscription based on a valid Default: n/a Optional
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
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 preceded by /) to be Values: A valid IPv6 Address Optional
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:889
9:aab:ccdd:eeff
abc1:3:1010:f3af::/64
Type: string
Default: user-defined
See RFC 5952 A
Recommendation for IPv6
Address Text Representation
for supported IPv6 Prefix
representations.
(2 of 2)
7-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
Response code
Code 7-4 shows the response code for the getSessionSummary command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
</subComponentFlowDescription>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit in ip from
2001:db8:85a3:0:0:8a2e:373:7331 to 8.8.8.11</flowDescription1>
<flowDescription2>permit out ip from 8.8.8.11
to 2001:db8:85a3:0:0:8a2e:373:7331</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afSign
allingProtocol>
</subComponentFlowDescription>
</subComponentFlowDescriptions>
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
<vendorSpecificAttributes>
<vendorSpecificAttribute>
<name>DSLForum.Agent-Remote-Id</name>
<value>
<type>STRING</type>
<value>TEST_AGENT_REMOTE_ID</value>
</value>
</vendorSpecificAttribute>
<vendorSpecificAttribute>
<name>ALU.SAP-Id</name>
<value>
<type>STRING</type>
<value>TEST_SAP_ID</value>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
</afSessionSummary>
<afSessionSummary>
<sessionId>afsess2</sessionId>
<userId>testSub1</userId>
<sessionBindingIdentifier>
<ipAddress>100.100.100.1</ipAddress>
<ipv6Prefix>2001:db8:32c5:0:0:0:0:52b3/128</ipv6Prefi
x>
<calledStationId>test_apn</calledStationId>
<subscriptionIds>
<subscriptionId>
<type>END_USER_E164</type>
<value>0300091</value>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<lastUpdatedTime>2013-02-06 06:10:57</lastUpdatedTime>
<serviceFlows>
<serviceFlow>
<mediaType>VIDEO</mediaType>
<mediaComponentNumber>1</mediaComponentNumber>
<flowStatus>ENABLED_DOWNLINK</flowStatus>
<afApplicationId>application_1</afApplicationId>
7-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
<afSignallingProtocol>NO_INFORMATION</afSign
allingProtocol>
</subComponentFlowDescription>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>RTCP</flowUsage>
<flowStatus>REMOVED</flowStatus>
<flowDescription1>permit in ip from
100.100.100.1 to 10.10.10.10</flowDescription1>
<flowDescription2>permit out ip from
33.33.33.8 to 100.100.100.1</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afSign
allingProtocol>
</subComponentFlowDescription>
</subComponentFlowDescriptions>
<reservationPriority>2</reservationPriority>
<rrBandwidth>200</rrBandwidth>
<rsBandwidth>220</rsBandwidth>
</serviceFlow>
</serviceFlows>
<vendorSpecificAttributes>
<vendorSpecificAttribute>
<name>DSLForum.Agent-Remote-Id</name>
<value>
<type>STRING</type>
<value>TEST_AGENT_REMOTE_ID</value>
</value>
</vendorSpecificAttribute>
<vendorSpecificAttribute>
<name>ALU.SAP-Id</name>
<value>
<type>STRING</type>
<value>TEST_SAP_ID</value>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
</afSessionSummary>
</getSessionSummaryResponse>
</env:Body>
</env:Envelope>
Table 7-4 lists the fields required for the getSessionSummary command.
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of session. Type: string
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
(1 of 8)
7-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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 E164 or IMSI expected
in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
(2 of 8)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
• preEmptionCapability
• preEmptionVulnerability
priorityLevel Values: 1 to 15
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.
preEmptionCapability Values:
Defines whether a bearer with a lower ARP priority level • PRE_EMPTION_CAPABILITY_
should be dropped to free up the required resources. ENABLED
• PRE_EMPTION_CAPABILITY_
DISABLED
Type: string
(3 of 8)
7-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
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
serviceflows Select the traffic for which the rule applies. —
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
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
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
(4 of 8)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
afApplicationId Values:
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
maxRequestedBandwidthDlSource Values:
The source of the requested maximum bit rate downlink • REQUEST
bandwidth. • PDF
Type: string
maxRequestedBandwidthUlSource Values:
The source of the requested maximum bit rate uplink • REQUEST
bandwidth. • PDF
Type: string
(5 of 8)
7-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
Type: enum
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
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
afSignallingProtocol Values:
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
reservationPriority Values: 1 to 15
Provides the relative priority for a session. Type: integer
(6 of 8)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
vendorSpecificAttributes The Vendor Specific Attributes associated with the AF Values: Attribute value pairs as
session. defined by the vendor.
Type: string
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a single entry
based on:
• name
• value
value —
Defines the value of the item using:
• type
• value
(7 of 8)
7-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
vendorSpecificAttributes type
(continued) Type of data held in the vendorSpecificAttributes item.
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
(8 of 8)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 7-29
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
7 — AF session API
7-30 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8— Sy session API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 8-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
8.2 getSession
Parameter
• sessionIdentifier
Session Identifier must contain one of the following: User Id, Subscription Id.
Request code
Code 8-1 shows a request code example for the getSession command.
8-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
Request fields
Table 8-1 lists the fields required for the command.
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters Optional
Type: string Note: You must enter
Default: n/a userId or subscriberId,
to identify the
subscriber.
Response code
Code 8-2 shows the response code for the getSession command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 8-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
<getSessionResponse
xmlns="http://www.alcatellucent.com/dsc/provisioningapi/51/session"
xmlns:ns2="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:ns3="http://www.alcatellucent.com/dsc/provisioningapi/common">
<sySession>
<sessionId>tpapps.realm;1360148293;7;SySession</sessionI
d>
<lastUpdatedTime>2013-02-06 06:11:46</lastUpdatedTime>
<userId>testSub1</userId>
<sessionBindingIdentifier>
<subscriptionIds>
<subscriptionId>
<type>END_USER_NAI</type>
<value>nai1@3gppnetwork.com</value>
</subscriptionId>
<subscriptionId>
<type>END_USER_IMSI</type>
<value>31012000091</value>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<diameterHost>host8005.realm8005</diameterHost>
<vendorSpecificAttributes/>
<policyCounters>
<policyCounter>
<id>goldService</id>
<status>
<id>goldService</id>
<status>green0</status>
<serviceParameters>
<serviceParameter>
<name>servicename</name>
<value>servicevalue</value>
</serviceParameter>
</serviceParameters>
</status>
</policyCounter>
<policyCounter>
<id>bronzeService</id>
<status>
<id>bronzeService</id>
<status>red</status>
<serviceParameters>
<serviceParameter>
<name>servicename0</name>
<value>servicevalue0</value>
</serviceParameter>
</serviceParameters>
</status>
</policyCounter>
</policyCounters>
<ip-canSessions>
<sessionId>gxsess1</sessionId>
<sessionId>gxsess2</sessionId>
</ip-canSessions>
</sySession>
8-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
<sySession>
<sessionId>tpapps.realm;1360148293;8;SySession</sessionI
d>
<lastUpdatedTime>2013-02-06 06:11:50</lastUpdatedTime>
<userId>testSub1</userId>
<sessionBindingIdentifier>
<subscriptionIds>
<subscriptionId>
<type>END_USER_E164</type>
<value>0300091</value>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<diameterHost>host8005.realm8005</diameterHost>
<vendorSpecificAttributes/>
<policyCounters>
<policyCounter>
<id>goldService</id>
<status>
<id>goldService</id>
<status>green</status>
<serviceParameters>
<serviceParameter>
<name>servicename</name>
<value>servicevalue</value>
</serviceParameter>
</serviceParameters>
</status>
</policyCounter>
<policyCounter>
<id>extraService</id>
<status>
<id>extraService</id>
<status>grey</status>
<serviceParameters>
<serviceParameter>
<name>servicename2</name>
<value>servicevalue2</value>
</serviceParameter>
</serviceParameters>
</status>
</policyCounter>
</policyCounters>
<ip-canSessions>
<sessionId>gxsess3</sessionId>
</ip-canSessions>
</sySession>
</getSessionResponse>
</env:Body>
</env:Envelope>
Response fields
Table 8-2 lists the fields for the command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 8-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
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.
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
E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription
based on:
• type
• value
(1 of 4)
8-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
diameterHost The name of the Diameter host of the gateway. Values:1 to 255 characters
Type: string
(2 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 8-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
vendorSpecificAttributes The Vendor Specific Attributes associated with the Values: Attribute value pairs as
IP-CAN session. defined by the vendor.
Type: string
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a
single entry based on:
• name
• value
value —
Defines the value of the item using:
• type
• value
type Values:
Type of data held in the vendorSpecificAttributes • STRING
item. • IP_ADDRESS
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
List is an option for each of the following:
• STRING
• IP_ADDRESS
(3 of 4)
8-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
(4 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 8-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
8 — Sy session API
8-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9— Streaming reporting API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — 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.
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.
9-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</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.
9-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
(1 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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.
9-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<userId>peter</userId>
<accountId>peter</accountId>
<subscriptionIds>
<subscriptionId>
<value>404059638527413@wlan.mnc404.mcc05.
3gppnetwork.org</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>404059638527413</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>ML4User</accountId>
<resetDayOfMonth>31</resetDayOfMonth>
<resetDayOfWeek>SUNDAY</resetDayOfWeek>
<resetHourOfDay>0</resetHourOfDay>
<meteredServices/>
<subscribers>
<subscriber>
<userId>ML4User</userId>
<accountId>ML4User</accountId>
<subscriptionIds>
<subscriptionId>
<value>030001</value>
<type>END_USER_E164</type>
</subscriptionId>
<subscriptionId>
<value>nai4@3gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>3301200009</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>MLUser</accountId>
<resetDayOfMonth>1</resetDayOfMonth>
<resetDayOfWeek>SUNDAY</resetDayOfWeek>
<resetHourOfDay>0</resetHourOfDay>
<meteredServices/>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<subscribers>
<subscriber>
<userId>MLUser</userId>
<accountId>MLUser</accountId>
<subscriptionIds>
<subscriptionId>
<value>nai@2gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>3012000091</value>
<type>END_USER_IMSI</type>
</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:ListAccountsWithFilterResult>
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>unknown_20121123135951318_5</accountId>
<resetDayOfMonth>1</resetDayOfMonth>
<resetDayOfWeek>SUNDAY</resetDayOfWeek>
<resetHourOfDay>0</resetHourOfDay>
<meteredServices/>
<subscribers>
<subscriber>
<userId>unknown_20121123135951318_5</userId>
<accountId>unknown_20121123135951318_5</account
Id>
<subscriptionIds>
<subscriptionId>
<value>31012000091</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>nai1@3gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
9-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>unknown_20121123140707575_7</accountId>
<resetDayOfMonth>1</resetDayOfMonth>
<resetDayOfWeek>SUNDAY</resetDayOfWeek>
<resetHourOfDay>0</resetHourOfDay>
<meteredServices/>
<subscribers>
<subscriber>
<userId>unknown_20121123140707575_7</userId>
<accountId>unknown_20121123140707575_7</account
Id>
<subscriptionIds>
<subscriptionId>
<value>31012000019042</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>testSub</accountId>
<resetDayOfMonth>1</resetDayOfMonth>
<resetDayOfWeek>SUNDAY</resetDayOfWeek>
<resetHourOfDay>0</resetHourOfDay>
<meteredServices/>
<subscribers>
<subscriber>
<userId>testSub</userId>
<accountId>testSub</accountId>
<subscriptionIds>
<subscriptionId>
<value>9785082345</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>9785082345@wlan.mnc012.mcc310.3gpp
network.org</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
<ns2:ListAccountsWithFilterResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:account>
<accountId>silverUsers</accountId>
<meteredServices/>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<subscribers>
<subscriber>
<userId>subEvPro</userId>
<accountId>silverUsers</accountId>
<subscriptionIds>
<subscriptionId>
<value>1234567890</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>1234567890@3gppnetwork.org</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</subscriber>
</subscribers>
</ns2:account>
</ns2:ListAccountsWithFilterResult>
<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.
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
also the day the monthly-based limits will be reset. Type: integer
(1 of 3)
9-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
resetDayOfWeek Used for weekly resets, which can occur on any day of the week Values:
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
parameter to the time of day that you want the reset.
• TUESDAY
• WEDNESDAY
• THURSDAY
• FRIDAY
• SATURDAY
Type: enum
resetHourOfDay ResetHourOfDay must be configured for any reset, whether a Values: 0-24
day of the week or month. The reset time can be configured as Type: enum
follows:
• 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 3)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
Type: string
(3 of 3)
9.3 ListAFSessionSummary
9-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
Parameter
• version
Indicates the values that are allowed in the schema.
Request code
Code 9-3 shows a request code example for the ListAFSessionSummary command.
Request fields
Table 9-3 lists the fields required for the ListAFSessionSummary command.
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<response:ListAFSessionSummaryResponse
xmlns:response="http://www.alcatellucent.com/dsc/reporting/readOnly/
dsc51">
<ns2:ListAFSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>af1</sessionId>
<lastUpdatedTime>2013-02-06
05:58:46</lastUpdatedTime>
<userId>ML3User1</userId>
<sessionBindingIdentifier>
<ipAddress>101.94.2.1</ipAddress>
<calledStationId>apn19402</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>nai3@3gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>0300091</value>
<type>END_USER_E164</type>
</subscriptionId>
<subscriptionId>
<value>33012000091</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes/>
<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</maxRequestedBand
widthDL>
<maxRequestedBandwidthUL>1000</maxRequestedBand
widthUL>
<subComponentFlowDescriptions>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit in ip from
101.94.2.1 to 8.8.8.11</flowDescription1>
<flowDescription2>permit out ip from
8.8.8.11 to 101.94.2.1</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afS
ignallingProtocol>
</subComponentFlowDescription>
9-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</subComponentFlowDescriptions>
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
</ns2:session>
</ns2:ListAFSessionSummaryResult>
<ns2:ListAFSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>af2</sessionId>
<lastUpdatedTime>2013-02-06
05:58:48</lastUpdatedTime>
<userId>ML3User2</userId>
<sessionBindingIdentifier>
<ipAddress>101.94.2.1</ipAddress>
<calledStationId>apn19402</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>32012000091</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>nai2@3gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>0200091</value>
<type>END_USER_E164</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes/>
<ipCanSessionId>gxsess2</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</maxRequestedBand
widthDL>
<maxRequestedBandwidthUL>1000</maxRequestedBand
widthUL>
<subComponentFlowDescriptions>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit in ip from
101.94.2.1 to 8.8.8.11</flowDescription1>
<flowDescription2>permit out ip from
8.8.8.11 to 101.94.2.1</flowDescription2>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<afSignallingProtocol>NO_INFORMATION</afS
ignallingProtocol>
</subComponentFlowDescription>
</subComponentFlowDescriptions>
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
</ns2:session>
</ns2:ListAFSessionSummaryResult>
<ns2:ListAFSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>af3</sessionId>
<lastUpdatedTime>2013-02-06
05:58:49</lastUpdatedTime>
<userId>ML2User1</userId>
<sessionBindingIdentifier>
<ipAddress>101.94.2.1</ipAddress>
<calledStationId>apn19402</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>nai1@2gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>31012000191</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes/>
<ipCanSessionId>gxsess3</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</maxRequestedBand
widthDL>
<maxRequestedBandwidthUL>1000</maxRequestedBand
widthUL>
<subComponentFlowDescriptions>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit in ip from
101.94.2.1 to 8.8.8.11</flowDescription1>
<flowDescription2>permit out ip from
8.8.8.11 to 101.94.2.1</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afS
ignallingProtocol>
9-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</subComponentFlowDescription>
</subComponentFlowDescriptions>
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
</ns2:session>
</ns2:ListAFSessionSummaryResult>
<ns2:ListAFSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>af4</sessionId>
<lastUpdatedTime>2013-02-06
05:58:51</lastUpdatedTime>
<userId>ML2User4</userId>
<sessionBindingIdentifier>
<ipAddress>101.94.2.1</ipAddress>
<calledStationId>apn19402</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>nai4@2gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
<subscriptionId>
<value>31012000491</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes/>
<ipCanSessionId>gxsess4</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</maxRequestedBand
widthDL>
<maxRequestedBandwidthUL>1000</maxRequestedBand
widthUL>
<subComponentFlowDescriptions>
<subComponentFlowDescription>
<flowNumber>1</flowNumber>
<flowUsage>NO_INFORMATION</flowUsage>
<flowDescription1>permit in ip from
101.94.2.1 to 8.8.8.11</flowDescription1>
<flowDescription2>permit out ip from
8.8.8.11 to 101.94.2.1</flowDescription2>
<afSignallingProtocol>NO_INFORMATION</afS
ignallingProtocol>
</subComponentFlowDescription>
</subComponentFlowDescriptions>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<reservationPriority>7</reservationPriority>
<rrBandwidth>1000</rrBandwidth>
<rsBandwidth>1000</rsBandwidth>
</serviceFlow>
</serviceFlows>
</ns2:session>
</ns2:ListAFSessionSummaryResult>
<ResponseSummary
xmlns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51">
<resultSize>4</resultSize>
<operationStatus>SUCCESS</operationStatus>
</ResponseSummary>
</response:ListAFSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-4 lists the fields required for the ListAFSessionSummary command.
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of session. Type: string
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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
(1 of 7)
9-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
sessionBinding Identifies the parameters with which the session was created —
identifier on the PCRF.
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 E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
value Values: Valid values as allowed by the
The identifier of the subscription. type; for example,
sip:9251234567@example.com.
Type: string
type Values:
The type of identifier that is carried by the associated value. • END_USER_E164
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].
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.
(2 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a single entry
based on:
• name
• value
value
Defines the value of the item using:
• type
• value
type Values:
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 256, 000 characters. • NUMBER
IP_ADDRESS • DECIMAL
Contains a single IP address in any of the accepted formats for Type: Enum
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
(3 of 7)
9-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
(4 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
Type: enum
mediaComponentNumber Values: any unsigned 32 bit number
Contains the ordinal number of the media component. 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
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
afApplicationId Values:
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
(5 of 7)
9-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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
maxRequestedBandwidthUlSource Values:
The source of the requested maximum bit rate uplink • REQUEST
bandwidth. • PDF
Type: string
subComponentFlowDescriptions —
SubComponentFlowDescriptions consists of:
• flowNumber
• flowUsage
• flowDescription1
• flowDescription2
• afSignallingProtocol
flowUsage Values:
Provides information about the usage of IP Flows • NO_INFORMATION
• RTCP
• AF_SIGNALLING
Type: enum
reservationPriority Values: 1 to 15
Provides the relative priority for a session. Type: integer
(6 of 7)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
operationalStatus Values:
The status of the operation. • SUCCESS
• FAILURE
Type: string
(7 of 7)
9.4 ListIPCANSessionSummary
Parameter
• version
Indicates the values that are allowed in the schema.
Request code
Code 9-5 shows a request code example for the ListIPCANSessionSummary
command.
9-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
Request fields
Table 9-5 lists the fields required for the ListIPCANSessionSummary command.
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-6 shows the response code for the ListIPCANSessionSummary command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes/>
<AuthorizedApnMaximumBitrateDL>8000000</AuthorizedApn
MaximumBitrateDL>
<AuthorizedApnMaximumBitrateUL>8000005</AuthorizedApn
MaximumBitrateUL>
<AdjustedApnMaximumBitrateDL>8000000</AdjustedApnMaxi
mumBitrateDL>
<AdjustedApnMaximumBitrateUL>8000005</AdjustedApnMaxi
mumBitrateUL>
<defaultEPSBearerQoS>
<defaultBearerQCI>QCI_7</defaultBearerQCI>
<allocationRetentionPriority>
<priorityLevel>1</priorityLevel>
<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>
<sessionId>afsess1</sessionId>
</afSessions>
</ns2:session>
</ns2:ListIPCANSessionSummaryResult>
<ns2:ListIPCANSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>pgsess2</sessionId>
<lastUpdatedTime>2013-02-06
05:57:55</lastUpdatedTime>
<userId>testSub</userId>
<sessionBindingIdentifier>
<ipv6Prefix>2001:db8:85a3:0:0:0:0:0/64</ipv6Prefix
>
<calledStationId>test_apn</calledStationId>
<subscriptionIds>
<subscriptionId>
<value>9785082345</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>9785082345@wlan.mnc012.mcc310.3gppnet
work.org</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes/>
<AuthorizedApnMaximumBitrateDL>8000000</AuthorizedApn
MaximumBitrateDL>
9-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<AuthorizedApnMaximumBitrateUL>8000005</AuthorizedApn
MaximumBitrateUL>
<AdjustedApnMaximumBitrateDL>8000000</AdjustedApnMaxi
mumBitrateDL>
<AdjustedApnMaximumBitrateUL>8000005</AdjustedApnMaxi
mumBitrateUL>
<defaultEPSBearerQoS>
<defaultBearerQCI>QCI_7</defaultBearerQCI>
<allocationRetentionPriority>
<priorityLevel>1</priorityLevel>
<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
xmlns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51">
<resultSize>2</resultSize>
<operationStatus>SUCCESS</operationStatus>
</ResponseSummary>
</response:ListIPCANSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-6 lists the fields required for the ListIPCANSessionSummary command.
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of session. Type: string
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
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
(1 of 9)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
sessionBinding Identifies the parameters with which the session was created —
identifier 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
subscriptionIds —
Contains a list of subscription ids for 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 E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
(2 of 9)
9-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
value —
Defines the value of the item using:
• type
• data
(3 of 9)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-29
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
(4 of 9)
9-30 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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
• preEmptionCapability
• preEmptionVulnerability
priorityLevel Values: 1 to 15
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
resource limitations.
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
preEmptionVulnerability Values:
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
(5 of 9)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-31
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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)
9-32 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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:
A subscriber account is queried before permission to use the • DISABLE_ONLINE
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 the billing • DISABLE_OFFLINE
domain after the resource usage occurred. • ENABLE_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:
Defines the parameters that are metered for offline 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.
(7 of 9)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-33
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
(8 of 9)
9-34 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
operationalStatus Values:
The status of the operation. • SUCCESS
• FAILURE
Type: string
(9 of 9)
9.5 ListNASREQSessionSummary
Parameter
• version
Indicates the values that are allowed in the schema.
Request code
Code 9-7 shows a request code example for the listNASREQSessions command.
<ns:additionalResponseField>NASSESSION_NASCOASTATUS</ns:additionalRe
sponseField>
</ns:additionalResponseFields>
</ns:parameters>
</ns:ListNASREQSessionSummaryRequest>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-35
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</soapenv:Body>
</soapenv:Envelope>
Request fields
Tables 9-7 and 9-8 lists the fields required for the ListNASREQSessionSummary
command.
version Indicates the values that are allowed in the schema. Values: dsc51 Optional
Type: string
Default: empty
Response code
Code 9-8 shows the response code for the ListNASREQSessionSummary command.
9-36 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</vendorSpecificAttributes>
<sessionState>CREATED</sessionState>
</ns2:session>
</ns2:ListNASREQSessionSummaryResult>
<ns2:ListNASREQSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>NASREQSession-22:0d:72:bf:00:70</sessionId
>
<lastUpdatedTime>2012-11-29
12:48:37</lastUpdatedTime>
<userId>user70</userId>
<sessionBindingIdentifier>
<subscriptionIds>
<subscriptionId>
<value>user70</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<vendorSpecificAttributes>
<vendorSpecificAttribute>
<name>ALUTIMETRA.ALC-Client-Hardware-Addr</name
>
<value>
<type>STRING</type>
<data>22:0d:72:bf:00:70</data>
</value>
</vendorSpecificAttribute>
</vendorSpecificAttributes>
<sessionState>CREATED</sessionState>
</ns2:session>
</ns2:ListNASREQSessionSummaryResult>
<ResponseSummary
xmlns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51">
<resultSize>2</resultSize>
<operationStatus>SUCCESS</operationStatus>
</ResponseSummary>
</response:ListNASREQSessionSummaryResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-8 lists the fields required for the ListNASREQSessionSummary command.
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of session. Type: string
(1 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-37
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
sessionBinding Identifies the parameters with which the session was created —
identifier on the PCRF.
subscriptionIds —
Contains a list of subscription ids for 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 E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
type Values:
The type of identifier that is carried by the associated value. • END_USER_E164
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].
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.
(2 of 4)
9-38 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
vendorSpecificAttribute —
Defines the vendorSpecificAttribute used for a single entry
based on:
• name
• value
value —
Defines the value of the item using:
• type
• value
type Values:
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 256,000 characters. • NUMBER
IP_ADDRESS • DECIMAL
Contains a single IP address in any of the accepted formats for Type: Enum
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
(3 of 4)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-39
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
operationalStatus Values:
The status of the operation. • SUCCESS
• 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
Indicates the values that are allowed in the schema.
Request code
Code 9-9 shows a request code example for the ListSubscribersCrossedThreshold
command.
9-40 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
</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.
Response code
Code 9-10 shows the response code for the ListSubscribersCrossedThreshold
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-41
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<type>END_USER_PRIVATE</type>
</subscriptionId>
</subscriptionIds>
</ns2:subscriber>
</ns2:ListSubscribersCrossedThresholdResult>
<ns2:ListSubscribersCrossedThresholdResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:subscriber>
<userId>ML2_3User</userId>
<subscriptionIds>
<subscriptionId>
<value>32012000091</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>nai2@3gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</ns2:subscriber>
</ns2:ListSubscribersCrossedThresholdResult>
<ns2:ListSubscribersCrossedThresholdResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:subscriber>
<userId>ML3User</userId>
<subscriptionIds>
<subscriptionId>
<value>0300091</value>
<type>END_USER_E164</type>
</subscriptionId>
<subscriptionId>
<value>33012000091</value>
<type>END_USER_IMSI</type>
</subscriptionId>
<subscriptionId>
<value>nai3@3gppnetwork.com</value>
<type>END_USER_NAI</type>
</subscriptionId>
</subscriptionIds>
</ns2:subscriber>
</ns2:ListSubscribersCrossedThresholdResult>
<ResponseSummary
xmlns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51">
<resultSize>3</resultSize>
<operationStatus>SUCCESS</operationStatus>
</ResponseSummary>
</response:ListSubscribersCrossedThresholdResponse>
</env:Body>
</env:Envelope>
Response fields
Table 9-10 lists the fields required for the ListSubscribersCrossedThreshold
command.
9-42 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
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 E164 or IMSI expected in the message.
Each subscriptionId identifies the subscription based on:
• value
• type
value Values: Valid values as allowed
The identifier of the subscription. by the type; for example,
sip:9251234567@example.com.
Type: string
type Values:
The type of identifier that is carried by the associated value. • END_USER_E164
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].
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.
operationalStatus Values:
The status of the operation. • SUCCESS
• FAILURE
Type: string
9.7 ListSYSessionSummary
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-43
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
Parameter
• version
Indicates the values that are allowed in the schema.
Request code
Code 9-11 shows a request code example for the ListSYSessionSummary command.
Request fields
Table 9-11lists the fields required for the ListSYSessionSummary command.
version Indicates the values that are allowed in the schema. Values: dsc51 Optional
Type: string
Default: empty
Response code
Code 9-12 shows the response code for the ListSYSessionSummary command.
9-44 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
<response:ListSYSessionSummaryResponse
xmlns:response="http://www.alcatellucent.com/dsc/reporting/readOnly/
dsc51">
<ns2:ListSYSessionSummaryResult
xmlns:ns2="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51
">
<ns2:session>
<sessionId>tpapps.realm;1360148337;1;SySession</sessi
onId>
<lastUpdatedTime>2013-02-06
05:58:57</lastUpdatedTime>
<userId>peter</userId>
<sessionBindingIdentifier>
<subscriptionIds>
<subscriptionId>
<value>404059638527413</value>
<type>END_USER_IMSI</type>
</subscriptionId>
</subscriptionIds>
</sessionBindingIdentifier>
<policyCounters>
<policyCounter>
<id>bronzeService</id>
<status>red</status>
<serviceParameters>
<serviceParameter>
<name>servicename0</name>
<value>servicevalue0</value>
</serviceParameter>
</serviceParameters>
</policyCounter>
<policyCounter>
<id>goldService</id>
<status>green0</status>
<serviceParameters>
<serviceParameter>
<name>servicename</name>
<value>servicevalue</value>
</serviceParameter>
</serviceParameters>
</policyCounter>
</policyCounters>
<ipcanSessions>
<sessionId>gxsess1</sessionId>
</ipcanSessions>
</ns2:session>
</ns2:ListSYSessionSummaryResult>
<ResponseSummary
xmlns="http://www.alcatellucent.com/dsc/reporting/readOnly/dsc51">
<resultSize>1</resultSize>
<operationStatus>SUCCESS</operationStatus>
</ResponseSummary>
</response:ListSYSessionSummaryResponse>
</env:Body>
</env:Envelope>
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-45
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
Response fields
Table 9-12 lists the fields required for the ListSYSessionSummary command.
sessionId A unique number that the server assigns to a user for the Values: valid session id
duration of 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
userId The unique identifier or name for the subscriber. Values: 1 to 32 characters
Type: string
sessionBinding Identifies the parameters with which the session was created —
identifier on the PCRF.
(1 of 2)
9-46 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
operationalStatus Values:
The status of the operation. • SUCCESS
• FAILURE
Type: string
(2 of 2)
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 9-47
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
9 — Streaming reporting API
9-48 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — 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
addressed to the PCRF.
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.
10-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:com="http://www.alcatellucent.com/dsc/provisioningapi/51/commo
n"
xmlns:sys="http://www.alcatellucent.com/dsc/provisioningapi/system/5
1/systemConfiguration">
<soapenv:Header>
<com:header>
<com:clientAppId>?</com:clientAppId>
<com:requestId>?</com:requestId>
</com:header>
</soapenv:Header>
<soapenv:Body>
<sys:exportPcrfSystemConfiguration>
<!--Zero or more repetitions:-->
<sys:systemConfiguration>DEFAULT</sys:systemConfiguration>
</sys:exportPcrfSystemConfiguration>
</soapenv:Body>
</soapenv:Envelope>
Request fields
Table 10-1 lists the fields required for the exportPcrfSystemConfiguration
command.
Type: enum
Default: DEFAULT
Response code
Code 10-2 shows the response code for the exportPcrfSystemConfiguration
command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
10-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
},
{
"ApplicationID": 16777238,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Access request",
"Scenario": 7,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting stop",
"Scenario": 10,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "UE-initiated dedicated bearer",
"Scenario": 3,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting interim",
"Scenario": 9,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777217,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting start",
"Scenario": 8,
"DefaultLevel": "MAJOR",
"SheddingLevel": "MAJOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "UE-initiated dedicated bearer",
"Scenario": 3,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777217,
"Description": "Notification",
"Scenario": 5,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Handover",
"Scenario": 4,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
10-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
}
]
},
"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,
"OriginHost": "fireball.realm",
"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": {
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"SystemPreferences": [
{
"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-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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)",
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-9
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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": {
"SystemPreferences": [
{
"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
}
]
},
"OverloadProtection": {
"PollInterval": 2,
"LowCPUThreshold": 70,
"HighCPUThreshold": 80,
"ResourceCPUThreshold": 90
}
},
"OSSI": {"SystemPreferences": [{
"Name": "OSSI SECURE",
"Value": "false"
}]}
}</systemConfiguration>
</exportPcrfSystemConfigurationResponse>
</env:Body>
</env:Envelope>
10-10 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
Response fields
Table 10-2 lists the fields required for the exportPcrfSystemConfiguration
command.
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.
Response code
Code 10-4 shows the response code for the exportSystemConfiguration command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-11
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
10-12 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting interim",
"Scenario": 9,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting start",
"Scenario": 8,
"DefaultLevel": "MAJOR",
"SheddingLevel": "MAJOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777217,
"Description": "Notification",
"Scenario": 5,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Access request",
"Scenario": 7,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-13
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "UE-initiated dedicated bearer",
"Scenario": 3,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
10-14 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
{
"ApplicationID": 16777238,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Re-Auth-Request",
"Scenario": 11,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting stop",
"Scenario": 10,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777217,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Unknown",
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-15
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Handover",
"Scenario": 4,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
}
]
},
"SystemPreferences": [
{
"Name": "Geo-Redundant Auto Failback",
"Value": "true"
},
{
"Name": "Disable Origin State-Id Validation",
"Value": "false"
},
{
"Name": "Geo-Redundant Activity Switch Delay",
"Value": "30"
}
],
"Peers": [{
"Active": true,
"OriginHost": "fireball.realm",
"Address": "138.120.54.52",
"Port": 3868,
"Protocol": "TCP",
"TLS": false,
"Role": "PCRF",
10-16 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-17
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"RoamingPartners": []
}},
"RestfulAPI": {"SystemPreferences": [{
"Name": "RESTful API QoSFlow Session Cleanup Interval
(mins)",
"Value": "5"
}]},
"Policy": {
"SystemPreferences": [{
"Name": "Configuration Distribution OSSI Timeout (milli
secs)",
"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": 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
},
{
"Name": "Read-only",
10-18 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"Create": false,
"Read": true,
"Update": false,
"Delete": false,
"Execute": false
}
]
},
"SystemPreferences": [
{
"Name": "Statistics Sampling Interval in ms",
"Value": "900000"
},
{
"Name": "Statistics Rate Calculation Enabled",
"Value": "false"
},
{
"Name": "Overload Protection Escalation Interval",
"Value": "30"
}
],
"OverloadProtection": {
"PollInterval": 2,
"LowCPUThreshold": 70,
"HighCPUThreshold": 80,
"ResourceCPUThreshold": 90
}
},
"OSSI": {"SystemPreferences": [{
"Name": "OSSI SECURE",
"Value": "false"
}]}
}</systemConfiguration>
</exportSystemConfigurationResponse>
</env:Body>
</env:Envelope>
Response fields
Table 10-3 lists the fields required for the exportSystemConfiguration command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-19
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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.
10-20 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-21
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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-22 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
{
"Name": "AF Session Inactivity Duration (seconds)",
"Value": "259200"
},
{
"Name": "NASREQ Non-Started Session Inactivity
Duration (seconds)",
"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)",
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-23
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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-24 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-25
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"HighCPUThreshold": 80,
"ResourceCPUThreshold": 90
},
"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
},
{
"Name": "Read-only",
"Create": false,
"Read": true,
"Update": false,
"Delete": false
}
]
},
"ExternalSystems": []
},
"Notification": {
"SystemPreferences": [],
"NotificationConfig": {
"SmsServers": [],
"EmailServers": [],
"WebServers": [],
"XmppServers": [],
"RestWebServers": []
}
},
"OSSI": {"SystemPreferences": [{
"Name": "OSSI SECURE",
"Value": "true"
}]},
"GUI": {"SystemPreferences": [
{
"Name": "GUI Session Inactivity Timeout (mins)",
"Value": "60"
},
{
"Name": "External SPR Local Write Override",
"Value": "false"
}
]},
"Diameter": {
"Peers": [
10-26 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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"
}
],
"OverloadProtection": {
"LowThreshold": 100,
"HighThreshold": 1000,
"ResoureceThreshold": 100000,
"LatencyLowThreshold": 40,
"LatencyHighThreshold": 50,
"LatencyResoureceThreshold": 100,
"Learning": false,
"ReconnectInterval": 1,
"DiameterRequestTimeout": 2990,
"SheddingConfigs": [
{
"ApplicationID": 16777266,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777217,
"Description": "Notification",
"Scenario": 5,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-27
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Handover",
"Scenario": 4,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
10-28 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"ApplicationID": 1,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "UE-initiated dedicated bearer",
"Scenario": 3,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777266,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Access request",
"Scenario": 7,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Emergency",
"Scenario": 6,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777217,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting interim",
"Scenario": 9,
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-29
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Session establishment",
"Scenario": 1,
"DefaultLevel": "CRITICAL",
"SheddingLevel": "CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "Session termination",
"Scenario": 2,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777238,
"Description": "UE-initiated dedicated bearer",
"Scenario": 3,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 16777236,
"Description": "Unknown",
"Scenario": 0,
"DefaultLevel": "MINOR",
"SheddingLevel": "MINOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting stop",
"Scenario": 10,
"DefaultLevel": "RESOURCE_CRITICAL",
"SheddingLevel": "RESOURCE_CRITICAL",
"ResultCodeVendorID": 0,
10-30 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Accounting start",
"Scenario": 8,
"DefaultLevel": "MAJOR",
"SheddingLevel": "MAJOR",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
},
{
"ApplicationID": 1,
"Description": "Re-Auth-Request",
"Scenario": 11,
"DefaultLevel": "NEVER",
"SheddingLevel": "NEVER",
"ResultCodeVendorID": 0,
"ResultCodeValue": 3004
}
]
},
"Routes": [],
"SystemPreferences": [
{
"Name": "Geo-Redundant Auto Failback",
"Value": "true"
},
{
"Name": "RFC-3588: Non-Compliant Origin-State-Id
Value",
"Value": "1"
},
{
"Name": "RFC-3588: Use Compliant Origin-State-Id",
"Value": "true"
},
{
"Name": "Disable Origin State-Id Validation",
"Value": "false"
},
{
"Name": "Geo-Redundant Activity Switch Delay",
"Value": "30"
}
]
},
"SNMP": {"SystemPreferences": [
{
"Name": "SNMP Agent Description",
"Value": "DSC_5_1_I1249 5780 Dynamic Services Controller
UNKNOWN Platform"
},
{
"Name": "SNMP Agent Community",
"Value": "marchrd"
},
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-31
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
{
"Name": "SNMP Agent OID",
"Value": "1.3.6.1.4.1.637.69.5.4.1.2"
}
]},
"RestfulAPI": {"SystemPreferences": [{
"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": {
"RadiusHostClusters": [],
"NASProfiles": [],
"NASClusters": []
},
"SPR": {
"SystemPreferences": [
{
"Name": "SPR Server Audit Interval (seconds)",
"Value": "300"
},
{
"Name": "SPR External Update Tries",
"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-32 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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.
version Indicates the values that are allowed in the schema. Values: dsc51 Optional
Type: string
Default: empty
Response code
Code 10-4 shows the response code for the importSystemConfiguration command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 10-33
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
10 — System API
10-34 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
11 — Ud Notification API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 11-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
11 — 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.
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.
11-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
11 — Ud Notification API
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 11-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
11 — Ud Notification API
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.
Request fields
Table 11-3 lists the fields required for the notification command.
11-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
11 — Ud Notification API
Response code
Code 11-2 shows the response code for the notification command.
Response fields
Table 11-4 lists the fields required for the notification command.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 11-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
11 — Ud Notification API
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.
11-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 12-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
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.
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
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
12-2 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
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.
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.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 12-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
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.
12-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
<settings>
<afApplicationId>mytvsd</afApplicationId>
<mediaType>VIDEO</mediaType>
<protocol>6</protocol>
<subscriptionIdType>END_USER_NAI</subscriptionIdType>
<notificationURL>http://www.acmetv.com/rxnotify</notificationURL>
</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.
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>.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 12-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
<protocol>6</protocol>
<subscriptionIdType>END_USER_NAI</subscriptionIdType>
<notificationURL>http://www.acmetv.com/rxnotify</notificationURL>
</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
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.
12-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 12-7
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
12 — RESTFul API reference
<simpleAVP name="Flow-Description"
value="permit out ip from 3.4.5.6 to 1.2.3.4"/>
</groupedAVP>
<!-- A second Media Sub Component -->
<groupedAVP name="Media-Sub-Component">
<simpleAVP name="Flow-Number" value="2"/>
<simpleAVP name="Max-Requested-Bandwidth-UL" value="300"/>
<simpleAVP name="Flow-Description"
value="permit in ip from 1.2.3.4 to any"/>
</groupedAVP>
</groupedAVP>
<!-- Value is the hex value of "myBill" -->
<simpleAVP name="Af-Charging-Identifier" value="6d7942696c6c"
conversion="hex"/>
<simpleAVP name="SIP-Forking-Indication" value="0"/>
<!-- Value in integer format -->
<simpleAVP name="Specific-Action" value="0"/>
<simpleAVP name="Specific-Action" value="3"/>
<groupedAVP name="Subscription-Id">
<simpleAVP name="Subscription-Id-Type" value="0"/>
<!-- Value specified as string, but still a conversion provided
-->
<simpleAVP name="Subscription-Id-Data"
value="mySubscriptionIdData"
conversion="ascii"/>
</groupedAVP>
<simpleAVP name="Reservation-Priority" value="7"/>
<!-- Value is the hex value of "10.1.1.1" -->
<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>
12-8 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
A. Differences in the API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 A-1
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
A. Differences in the API
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
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
A. Differences in the API
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.
See Table 1-2 for list of the new operation introduced in 5.1.
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.
See Table 1-2 for list of the new operation introduced in 5.1.
This section describes the differences between the 5.0 and 5.1 API.
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 A-3
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
A. Differences in the API
A-4 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
A. Differences in the API
Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4 May 2013 A-5
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
A. Differences in the API
A-6 May 2013 Alcatel-Lucent 5780 Dynamic Services Controller, Release 5.1 R4
3HE 07632 AAAD TQZZA Edition 01
API Reference Manual
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.