UPCC V300R005C01 SOAP Interface Instructions

UPCC
V300R005C01
SOAP Interface Instructions
Issue
01
Date
2012-08-30
HUAWEI TECHNOLOGIES CO., LTD.
Copyright Huawei Technologies Co., Ltd. 2012. All rights reserved.

No part of this document may be reproduced or transmitted in any form or by any means
without prior written consent of Huawei Technologies Co., Ltd.
Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their
respective holders.
Notice
The purchased products, services and features are stipulated by the contract made between
Huawei and the customer. All or part of the products, services and features described in this
document may not be within the purchase scope or the usage scope. Unless otherwise specified
in the contract, all statements, information, and recommendations in this document are provided
"AS IS" without warranties, guarantees or representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been
made in the preparation of this document to ensure accuracy of the contents, but all statements,
information, and recommendations in this document do not constitute a warranty of any kind,
express or implied.
Huawei Technologies Co., Ltd.

Address:
Huawei Industrial Base

Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website:
http://www.huawei.com
Email:
support@huawei.com
Revision Record
Date
Description
Author
Version
2011-07-21
Add activate and deactivate service

interface and samples for fixed broadband
user.
Wangjuhui
V300R005C00
Add parameter of subscriber and

description for fixed broadband user.
2011-7-28
Update according to review comments.
Wangjuhui
V300R005C00
2011-8-2
Update according to review
Wangjuhui
V300R005C00
2011-8-24
Delete usrPassword of subscriber.
Wangjuhui
V300R005C00
2011-8-29
Update Sample file
Wangqing
V300R005C00
2011-09-23
Modify subscriber identifys length and

subscriber network type
Xuezhen
V300R005C00
2011-09-27
Modify usrStates range and

usrBillCycleDates range
Wangqing
V300R005C00
2011-10-14
Add usrCustomerAttr of SPccSubscriber
Wangqing
V300R005C00
2011-11-21
Add Data Type Definition 2.2 description
WangJuhui
V300R005C00
2012-1-20
Add srvValidPeriod parameter for

SSubscribedService.
Jiangzhihua
V300R005C10
Extend usrBillCycleDate parameter range

to 31.
Add interface resetSubscriberQuota.
Add one error code 90378 for
rechargeSubscriberQuota command.
2012-2-23
Update according DTS2012022102723 and

DTS2012022204562
Jiangzhihua
V300R005C10
2012-3-11
Baseline for UPCC V300R005C01 from

V300R005C10
Yubin/3906
7
V300R005C01
2012-3-20
Add usrExAttr1~10 of SPccSubscriber
Wangqing/5
4499
V300R005C01
Issue 01 (2012-08-30)
Huawei Proprietary and Confidential

Copyright Huawei Technologies Co., Ltd
Date
Description
Author
Version
2012-3-28
Add usrSMSMSISDN of SPccSubscriber
Xubin/3820
8
V300R005C01
Add usrSMSReceiveFlag of
SPccSubscriber
Add usrLanguage of SPccSubscriber
Add usrIMSI of SPccSubscriber
Add TermInd of SSubscribedService
Add TermInd of SServicePackage
Add TermInd in
unSubscribeServiceRequest
Add TermInd in
unSubscribeServicePackageRequest
2012-5-11
Update according to CR20120509042
Yangming/6
6961
V300R005C01
2012-06-01
Yangming/6
6961
V300R005C01
2012-06-15
Add usrSecondIdentifier of SPccSubscriber
Xubin/3820
8
V300R005C01
Add error code 90379 and 90380 for

addSubscriber command and
updateSubscriber command
2012-06-27
Modify the max length of

usrSecondIdentifier from 16 to 20
Xubin/3820
8
V300R005C01
2012-06-29
Update according DTS2012062000821
Jiangguilan/
67049
V300R005C01
2012-07-05
Jiangguilan/
67049
V300R005C01
2012-07-09
Jiangguilan/
67049
V300R005C01
2012-07-10
Add note for the TermInd of

SSubscribedService and SServicePackage
Xubin/3820
8
V300R005C01
2012-07-12
Add error code 98311 to 98315 according

to DTS2012071200383
Xubin/3820
8
V300R005C01
2012-07-13
Update according to DTS2012071202475
Xubin/3820
8
V300R005C01
Jiangguilan/
67049
V300R005C01
Xubin/2241
92
V300R005C01
Add interface:
2012-07-19
subscribeServicePacket,
unSubscribeServicePacket,
getSubscriberAllServicePacket
according CR20120717042
/DTS2012070401202:
2012-07-23
Add srvStatus of SSubscribedService

[
Issue 01 (2012-08-30)

Date
Description
Author
Version
2012-07-23
Add parameters of service for

addSubscriber and updateSubscriber
interface according CR20120717042 /
DTS2012061104379
Jiangguilan/
67049
V300R005C01
2012-07-26
Jiangguilan/
67049
V300R005C01
2012-07-26
Jiangguilan/
67049
V300R005C01
2012-07-31
Add Subscribed_SPR_INST and Subscribed_Sy in

SubscribedType according to DTS2012072803821
Xubin/2241
92
V300R005C01
2012-08-09
Jiangguilan/
67049
V300R005C01
2012-10-22
yangming/6
6961
V300R005C01
2012-10-25
yangming/6
6961
V300R005C01
2012-10-26
yangming/6
6961
V300R005C01
Issue 01 (2012-08-30)

Figure list
Con
1 SOAP Overview..........................................................................1-3
1.1 SOAP Interface Description...........................................................................................................................1-3
1.1.1 Concept of the SOAP Protocol..............................................................................................................1-3
1.1.2 SOAP Interfaces....................................................................................................................................1-3
1.1.3 Get WSDL for this SOAP Interfaces.....................................................................................................1-3
1.1.4 Performance of SOAP Interface............................................................................................................1-3
1.1.5 Notice....................................................................................................................................................1-3
1.2 Networking Structure of the UPCC................................................................................................................1-4
1.2.1 Networking............................................................................................................................................1-4
1.2.2 SOAP Implementation..........................................................................................................................1-4
2 SOAP-Related Service Processes.................................................2-1

2.1 Data Model Introduction................................................................................................................................2-1
2.2 Data Type Definition......................................................................................................................................2-2
2.2.1 Data Type Definition.............................................................................................................................2-2
2.3 Object Description..........................................................................................................................................2-2
2.3.1 SPccSubscriber......................................................................................................................................2-2
2.3.2 SSubscribedService...............................................................................................................................2-5
2.3.3 SServicePackage...................................................................................................................................2-8
2.3.4 SSubscriberQuota................................................................................................................................2-10
2.3.5 SSubscriberAccount............................................................................................................................2-11
2.3.6 SSubscriberRechargedQuota...............................................................................................................2-12
2.3.7 SSubscriberAccumulation...................................................................................................................2-12
2.3.8 SSubscriberAccumulationUsageInfo..................................................................................................2-13
2.3.9 SSubscriberClearAccumulation..........................................................................................................2-13
2.3.10 SSubscriberRechargedService..........................................................................................................2-14
2.3.11 SSubscriberCustomLevel..................................................................................................................2-14
2.3.12 SSubscriberAlias...............................................................................................................................2-14
3 UPCC SOAP Interfaces................................................................3-1

[
Issue 01 (2012-08-30)

Figure list
3.1 Query Subscriber's Basic Information............................................................................................................3-1
3.2 Query Subscriber's All Services.....................................................................................................................3-1
3.3 Query Subscriber's All ServicePackages........................................................................................................3-2
3.4 Query Subscriber's All Quotas........................................................................................................................3-2
3.5 Query Subscriber's Specific Quota.................................................................................................................3-2
3.6 Query Subscriber's Account Info....................................................................................................................3-3
3.7 Query Subscriber's All Info............................................................................................................................3-3
3.8 Add Subscriber...............................................................................................................................................3-4
3.9 Update Subscriber..........................................................................................................................................3-4
3.10 Delete Subscriber..........................................................................................................................................3-5
3.11 Subscribe Service..........................................................................................................................................3-5
3.12 Update Subscribed Service...........................................................................................................................3-6
3.13 Unsubscribe Service.....................................................................................................................................3-6
3.14 Subscribe ServicePackage............................................................................................................................3-7
3.15 Update Subscribed ServicePackage.............................................................................................................3-7
3.16 Unsubscribe ServicePackage........................................................................................................................3-7
3.17 Update Subscriber's Account........................................................................................................................3-8
3.18 Recharge Subscriber's Quota........................................................................................................................3-8
3.19 Update Subscribers Quota...........................................................................................................................3-9
3.20 Subscribe Accumulation.............................................................................................................................3-10
3.21 Unsubscribe Accumulation.........................................................................................................................3-10
3.22 Clear Accumulated Information.................................................................................................................3-11
3.23 Query Subscribers Accumulation..............................................................................................................3-11
3.24 Recharge Subscriber's Service....................................................................................................................3-12
3.25 Update Subscriber's Custom Level.............................................................................................................3-12
3.26 Query Subscriber's Custom Level..............................................................................................................3-13
3.27 Reset Subscriber's Quota............................................................................................................................3-13
3.28 Add Subscriber Alias..................................................................................................................................3-14
3.29 Update Subscriber Alias.............................................................................................................................3-14
3.30 Delete Subscriber Alias..............................................................................................................................3-15
3.31 Query Subscriber's Alias...............................................................................................................................3-1
3.32 Subscribe ServicePacket...............................................................................................................................3-1
3.33 Unsubscribe ServicePacket..........................................................................................................................3-1
3.34 Query Subscriber's All ServicePackets.........................................................................................................3-2
4 Exception Handling....................................................................4-1
4.1 Mechanism for Handling SOAP Interface Abnormity...................................................................................4-1
4.1.1 Handling Service Flow Abnormity.......................................................................................................4-1
4.1.2 Handling Service Data Abnormity........................................................................................................4-1
4.2 Error Codes for the UPCC SOAP Interface...................................................................................................4-1
5 WSDL........................................................................................ 5-1
5.1 The WSDL File...............................................................................................................................................5-1
[
Issue 01 (2012-08-30)

Figure list
5.2 Samples...........................................................................................................................................................5-1
6 Loading Key Store......................................................................6-1

6.1 The Method of Loading Key Store.................................................................................................................6-1
Issue 01 (2012-08-30)

Figure list
YFigure 1-1 UPCC Networking..........................................................................................................................1-4

Figure 1-2 SOAP Implementation.......................................................................................................................1-4
Figure 2-1 Data Model of UPCC for Provisioning System.................................................................................2-1
Issue 01 (2012-08-30)

UPCC
5 WSDL
Table list
YTable 2-1 SPccSubscriber.................................................................................................................................2-2

Table 2-2 SSubscribedService.............................................................................................................................2-5
Table 2-3 SServicePackage..................................................................................................................................2-7
Table 2-4 SSubscriberQuota................................................................................................................................2-9
Table 2-5 SSubscriberAccount...........................................................................................................................2-10
Table 2-6 SSubscriberRechargedQuota.............................................................................................................2-12
Table 2-7 SSubscriberAccumulation.................................................................................................................2-12
Table 2-8 SSubscriberAccumulationUsageInfo.................................................................................................2-13
Table 2-9 SSubscriberClearAccumulation.........................................................................................................2-13
Table 2-10 SSubscriberRechargedService.........................................................................................................2-13
Table 2-11 SSubscriberCustomLevel.................................................................................................................2-13
Table 2-12 SSubscriberAlias..............................................................................................................................2-14
Table 3-1 Description of messages used by the getSubscriber interface.............................................................3-1
Table 3-2 Description of messages used by the getSubscriberAllService interface............................................3-1
Table 3-3 Description of messages used by the getSubscriberAllServicePackage interface...............................3-2
Table 3-4 Description of messages used by the getSubscriberAllQuota interface..............................................3-2
Table 3-5 Description of messages used by the getSubscriberSpecQuota interface............................................3-3
Table 3-6 Description of messages used by the getSubscriberAccount interface................................................3-3
Table 3-7 Description of messages used by the getSubscriberAllInf interface...................................................3-4
Table 3-8 Description of messages used by the addSubscriber interface............................................................3-4
Table 3-9 Description of messages used by the updateSubscriber interface.......................................................3-5
Table 3-10 Description of messages used by the deleteSubscriber interface......................................................3-5
Table 3-11 Description of messages used by the subscribeService interface......................................................3-5
[
Issue 01 (2012-08-30)

UPCC
5 WSDL
Table 3-12 Description of messages used by the updateSubSubscription interface............................................3-6

Table 3-13 Description of messages used by the unSubscribeService interface.................................................3-6
Table 3-14 Description of messages used by the subscribeServicePackage interface.........................................3-7
Table 3-15 Description of messages used by the UpdateSubscribedServicePackage interface..........................3-7
Table 3-16 Description of messages used by the unSubscribeServicePackage interface....................................3-8
Table 3-17 Description of messages used by the updateSubscriberAccount interface........................................3-8
Table 3-18 Description of messages used by the rechargeSubscriberQuota interface........................................3-9
Table 3-19 Description of messages used by the updateSubscriberQuota interface..........................................3-10
Table 3-20 Description of messages used by the subscribeAccumulation interface........................................3-10
Table 3-21 Description of messages used by the unSubscribeAccumulation interface....................................3-11
Table 3-22 Description of messages used by the clearAccumulation interface................................................3-11
Table 3-23 Description of messages used by the getSubscriberAccumulation interface..................................3-12
Table 3-24 Description of messages used by the rechargeSubscriberService interface....................................3-12
Table 3-25 Description of messages used by the updateSubscriberCustomLevel interface..............................3-13
Table 3-26 Description of messages used by the getSubscriberCustomLevel interface....................................3-13
Table 3-27 Description of messages used by the resetSubscriberQuota interface.............................................3-14
Table 3-28 Description of messages used by the addSubscriberAlias interface................................................3-14
Table 3-29 Description of messages used by the updateSubscriberAlias interface...........................................3-15
Table 3-30 Description of messages used by the deleteSubscriberAlias interface............................................3-15
Table 3-31 Description of messages used by the getSubscriberAlias..................................................................3-1
Table 3-32 Description of messages used by the subscribeServicePacket interface...........................................3-1
Table 3-33 Description of messages used by the unSubscribeServicePacket interface.......................................3-2
Table 3-34 Description of messages used by the getSubscriberAllServicePacket interface...............................3-2
Table 4-1 Error codes for the UPCC SOAP interface..........................................................................................4-2
Issue 01 (2012-08-30)

UPCC
5 WSDL
SOAP Overview
1.1 SOAP Interface Description

1.1.1 Concept of the SOAP Protocol
SOAP is a protocol for exchanging messages over computer networks. It provides a

simple and basic messaging framework. SOAP is used to exchange XML-based
messages that are structured and sorted in a decentralized and distributed environment.
SOAP consists of the following four parts:
Envelop: It defines the framework for presenting the message contents and how to
deal with messages.
Encoding rules: They define how to express the application-defined data types.
Representation: It defines the convention on presenting remote procedure calls and

responses.
Binding convention: It defines the binding convention on how to use an underlying

protocol to exchange messages.
1.1.2 SOAP Interfaces

The UPCC uses the SOAP interface through HTTP or HTTPS. The UPCC SOAP interface
adopts the RPC pattern. By default, a connection is in Keep-Alive mode and the transmission
port number of the UPCC SOAP interface is 8080(can be configured by ADD PORT
command). The connection is always up unless it is closed by the Provisioning system.
When remotely calling the SOAP service, the terminal is usually identified by its IP address
and the port number, or by the host name and the port number.
For example, the terminal can send messages to UPCC from the following URL:
http://xxx.xxx.xxx.xxx:8080/axis/services/ScfPccSoapServiceEndpointPort
1.1.3 Get WSDL for this SOAP Interfaces

The attached WSDL in chapter 5.1 is the only valid one, and DO NOT try to get a WSDL
from any other way.
1.1.4 Performance of SOAP Interface

Huawei UPCC supports maximum 200 TPS for SOAP interface.
1.1.5 Notice
For input, the Provisioning System may only provide the required attributes and others
will be set default by the UPCC. The length of fields of string type is expressed by byte.
[
Issue 01 (2012-08-30)

UPCC
5 WSDL
For output, the UPCC will always return all attributes in its storage whether value is
default or not, the Provisioning System may only take care of attributes those can be
recognized and just ignore all the others. Any attributes those the Provisioning System
doesn't recognize existing in the response shouldn't cause any abnormal faults or errors.
This interface support SOAP 1.1 or SOAP 1.2, but only support HTTP 1.1, and the
message format must comply with XML 1.0 criterion.
SOAP commands will be automatically converted to MML commands for execution in

the UPCC. For details on execution records of MML commands, see LST LOG.
1.2 Networking Structure of the UPCC

1.2.1 Networking
The UPCC supports SOAP and allows the Provisioning System to be connected directly,
which makes the networking flexible. Figure 1.2.1.I.1.1.1 shows a common networking.
Figure 1.2.1.I.1.1.1 UPCC Networking
1.2.2 SOAP Implementation

The connection between PCRF and Provisioning system is based on HTTPS protocol.
Provisioning system sends request message to PCRF and PCRF sends response message to
Provisioning system. Figure 1.2.2.I.1.1.1 shows SOAP implementation.
Issue 01 (2012-08-30)

UPCC
5 WSDL
Figure 1.2.2.I.1.1.1 SOAP Implementation
Issue 01 (2012-08-30)

SOAP-Related Service Processes

The UPCC SOAP interfaces are designed to serve service processes. The service processes
introduced in this chapter work particularly for Provision system developers, however, can
use any interface according to their own needs.
2.1 Data Model Introduction

Figure 2.1.1.I.1.1.1 shows the data model of UPCC for Provisioning System.
UPCC only provides operations related to subscriber in this SOAP interface, any peer devices
(such like provisioning system or portal, etc.) should store the global information like service
information in its own database.
Figure 2.1.1.I.1.1.1 Data Model of UPCC for Provisioning System
Issue 01 (2012-08-30)

2.2 Data Type Definition

2.2.1 Data Type Definition
Data Type
Value or Value Range
String
The value cannot contain two or more consecutive spaces, or the characters form feed
(\f), line feed(\n), carriage return(\r), horizontal tab(\t), vertical tab(\v), or the symbols , ;
=
Integer
The value ranges from -2147483648 to 2147483647.
Datetime
The value is in YYYYMMDDhhmmss format, ranging:from 19700101000000 to

20371231235959.
2.3 Object Description
The attribute's name defined here (such as srvName, usrIdentifier, usrCategory e.g.) are not case
sensitive, and all attributes names in query response from UPCC are capitalized, so the Provisioning
system must implemented not to be case sensitive.
For the purpose of better compatibility, the Provisioning system must ignore any attributes which is
not defined as below or not cared for service logic in any query response with no error occurs (e.g.
getSubscriberResponse may return attribute not defined in this specification).
In the modification command, any attributes which is defined as "Read only" will be ignored.
MBB stands for Mobile Broadband, FBB stands for Fixed Broadband.
2.3.1 SPccSubscriber
Table 2.3.1.I.1.1.1.1 SPccSubscriber
Name
usrIdentifier
oldusrIdentif
ier
usrMSISDN
Meaning
Subscriber's identifier,
i.e. the IMSI, MSISDN
or internal primary key
of IT system.
Old subscriber's
identifier, i.e. the IMSI,
MSISDN.
Subscriber's MSISDN
number for notification
Opti
onal
Type
String
Range
Default
Value
Read
only
Comm
ent
Length:1~255
Note1
String
Length:1~255
NULL
Note2
String
Length:1~20
NULL
Note3
Issue 01 (2012-08-30)

usrState
subscriber's status.
Integer
1:Normal
1:Normal
Note4
2:Fro
zen
65:SubStatusA
66:SubStatusB
67: SubStatusC
68: SubStatusD
69: SubStatusE
70:
SubS
tatus
F
usrHomeSrv
Zone
usrPaidType
Home zone the

subscriber belongs to.
String
Length:1~64
NULL
Paid type of the

subscriber.
Integer
0:prepaid
214748364
6:NULL
Note12
1:postpaid
2:prepaid
2147483646:NUL
L
usrCategory
usrStation
usrMasterId
entifier
usrContact
Method
Category of the
subscriber.
String
Length:1~12
NULL
Station of the
subscriber, which
indicate the subscriber
is master or slave.
Integer
1: Master
1: Master
Identifier of the master

subscriber which this
subscriber belongs to.
Only applicable for the
Slave subscriber.
String
Length:1~255
NULL
Note5
The notification method

for this subscriber.
Integer
1: SMS
1: SMS
Note6
NULL
Note7
2: Slave
2: E-Mail
3: SMS&E-Mail
128: None
usrEmailAd
dress
E-Mail address of the

subscriber.
String
Length:1~64
Issue 01 (2012-08-30)

usrBillCycle
Date
The Bill Cycle Day of

the subscriber.
Integer
1~31
-1: NULL
Note8
97: 2 days before

month end
98: 1 day before
month end
99: Last day of
the month
-1:
NUL
L
usrSubTermi
nalType
The Subscribed
Terminal Type of the
subscriber.
String
Length:1~32
NULL
1byte
usrCreateTy
pe
Create Type of the

subscriber.
Integer
0: Provisioning
Create
1:Dynamic Create
4 byte:
0: permanently
save
usrMaxOffli
neDays
Max Offline Days.
Integer
1~30: if the
subscriber offline
days exceed this
value, the
subscriber will be
deleted
The format shall

be:
yyyymmddhhmm
ss
usrLatestOff
lineTime
Latest Offline Time.
Datetim
e
From
19700101000000
To
20371231235959
-1
-1:NULL(means
never online)
0: Mobile
Broadband user
usrSubNetT
ype
Type of subscriber,
fixed broadband user or
mobile broadband user.
Integer
usrCustomer
Attr
Customer Attribute.
Integer
usrExAttr1
Extended attribute 1.
usrExAttr2
usrExAttr3
usrExAttr4
Note9
0
0~65535
Integer
0~254
NULL
Integer
0~254
Integer
0~254
Integer
1: Fixed
Broadband user
0~254
NULL
NULL
NULL
Issue 01 (2012-08-30)

usrExAttr5
Integer
0~254
usrExAttr6
Integer
0~254
usrExAttr7
Integer
0~254
usrExAttr8
Integer
0~254
usrExAttr9
Integer
0~254
usrExAttr10
Integer
0~254
usrSMSMSI
SDN
Subscriber's
SMS_MSISDN number
for notification.
String
Length:1~15
usrSMSRec
eiveFlag
Subscriber's SMS
receive flag for
MSISDN and
SMS_MSISDN.
usrLanguage
The language of
notification
(SMS&Email).
Integer
usrIMSI
Subscriber's IMSI.
String
Length:1~15
Second Subscriber ID.
String
Length:1~20
usrSecondId
entifier
usrDesc
NULL
NULL
NULL
NULL
NULL
NULL
NULL
Integer
0: All
1: None
2: MSISDN Only
3: SMSMSISDN
Only
0:Language1
1:Language2
2:Language3
3:Language4
255:NULL
N
0: All
N
NULL
NULL
NULL
Note10
Description of this
Y
String
Length:0~32
NULL
N
Note11
subscriber.
Note1: The format (such as the country code, length) of its value shall be same as what UPCC gets from the Gx
interface.
Note2: If the oldusrIdentifier and usrIdentifier are taken simultaneously, the old usrIdentifer which is stored in the
database shall be changed into the new usrIdentifier, and all the other attribute including service subscription, service
package subscription, quota, and account will not be affected.
Note3: It is used for SMS notification which may different from the usrIdentifier.
Note4: Normal means the subscriber can access network and Frozen means this subscriber is forbidden to access
network.
Note5: For a subscriber whose Station is "Slave" there must have a usrMasterIdentifier, and the subscriber identified by
usrMasterIdentifier shall be an existing one; For a subscriber whose Station is "Master", the usrMasterIdentifier must be
set to blank or no usrMasterIdentifier indicated.
Note6: The value "128: None" means no notification will be sent for this subscriber.
Note7: The validation of e-mail address shall be assured by the Provisioning System.
Note8: A subscriber will not be able to use services whose usage of quota or account is reset by subscriber's bill day if
no explicit usrBillCycleDate is specified.
Note9: This parameter MUST be carried and set value to 1 when provisioning system adding a fixed broadband user,
otherwise the subscriber will be treated as a mobile broadband user by default.
Note10: The usrSecondIdentifier cannot be inputted if subscriber ID dual index function is turned off. And it must be
inputted if subscriber ID dual index function is turned on in addSubscriber command.
Note11: This parameter is reserved for future use.
Note12: The value "2: prepaid" is reserved for compatibility, it means that the subscribers paid type is prepaid, the
same as "0: prepaid".
Issue 01 (2012-08-30)

2.3.2 SSubscribedService
Table 2.3.2.I.1.1.1.1 SSubscribedService
Name
Meaning
srvName
Service name .
srvpkgName
Optio
nal
N
S
er
vi
ce
P
ac
k
Y
a
g
e
n
a
m
e.
Type
Range
String
Length:1~32
String
Length:1~32
srvUsageState
Usage Status.
Integer
srvSubscribe
Date
The date on which the

subscriber is provided
with the service.
Datetime
srvOverdueDa
te

service expires.
Datetime
1: Normal
2: Level1
3: Level2
4: Level3
5: Level4
6: Exhaust
7: Level5
8: Level6
9: Level7
10: Level8
11: Level9
12: Level10
The format
shall be:
YYYYMMD
Dhhmmss
From
19700101000
000 To
20371231235
959
-1:NULL
The format
shall be:
YYYYMMD
Dhhmmss
From
19700101000
000 To
20371231235
959
-1:NULL
Default
Value
Read
only
Comm
ent
NULL
Note1
1:Normal
Note2,
Note8
-1:NULL
Note3,
Note8
-1:NULL
Note4,
Note8
Issue 01 (2012-08-30)

srvStartDateTi
me

service takes effect.
Datetime
srvEndDateTi
me

service expires.
Datetime
srvRoamingT
ype
Roaming type.
Integer
SubscribedTy
pe
Subscribed type.
Integer
srvValidPerio
d
Valid period.
Integer
TermInd
Termination
of service.
srvStatus
Service status.
identifier
Integer
Integer
The format
shall be:
YYYYMMD
Dhhmmss
From
19700101000
000 To
20371231235
959
-1:NULL
means never
limit
The format
shall be:
YYYYMMD
Dhhmmss
From
19700101000
000 To
20371231235
959
-1:NULL
means never
expire until
removed
explicitly
0: Roaming
1: Local
-1:NULL
0: Subscribed
1:
DynGrp_Basi
cService
2:
DynGrp_Non
ExistSub
3:
DynGrp_Non
Subscription
5:
Subscribed_S
PR_INST
6:
Subscribed_S
y
7:
Subscribed_K
eepUntilQuot
aNextResetDa
te
1~180
-1: NULL
1:Immediate
termination
2:Valid
till
expiry date
3: Valid till
expiry
date
and
allow
quota
accumulated
0: Normal
1: Frozen
-1:NULL
Note5,
Note8
-1:NULL
Note6,
Note8
-1:NULL
Note8
-1: NULL
Note7,
Note11
1:
Immediate
terminatio
n
Note9,
Note11
Note11
Issue 01 (2012-08-30)

srvActivation
Status
Activation status.
1:Active
2:Default
Integer
2:Default
Note10,
Note11
Note1: This parameter is used to specify the service package that the service belongs to.
Note2: This parameter is used to notify the quota usage status by the external system (such as OCS).
Note3: The specified time must be earlier than (or the same as) the srvStartDateTime.
Note4: The specified time must be later than the srvStartDateTime. This parameter is not recommended. Please use
the srvEndDateTime instead.
Note5: When the subscriber is prepaid and subscribes a monthly service, this parameter is used to calculate the next
reset time of quota, we do not consider the srvStartDateTime is null. If this parameter is modified to -1, the Web UI will
be showed as NULL and the next reset time will be cleared.
Note6: The specified time must be later than the system time and the srvStartDateTime. If this parameter is
modified to -1, the Web UI will be showed as NULL and the service will never be expired. If the subscriber subscribed a
new service, all subscribed services before will be checked one by one and deleted if it expires.
Note7: If this parameter is modified to -1 for Update Subscribed Service command, the Web UI will be showed as
NULL.
Note8: If the service belongs to a package, the parameter cannot be changed by SOAP command.
Note9: TermInd is only used for Unsubscribe Service command to indicate how to unsubscribe the recurring service.
Immediate termination means unsubscribe the service at once. Valid till expiry date means the service still can be used
by the subscriber until the latest recurring date. Valid till expiry date and allow quota accumulated means the service
expires at the nearest quota reset time and Subscribed Type of the service changes to
Subscribed_KeepUntilQuotaNextResetDate after the command is executed. If Subscribed Type of the service is
Subscribed_KeepUntilQuotaNextResetDate when Status of one quota is changed to Exhaust, the UPCC withdraws the
service and deletes quotas and account associated with the service.
Note10:This parameter is reserved for future use.
Note11: This parameter is not supported if services are provisioned when add a subscriber or update a subscriber .
2.3.3 SServicePackage
Table 2.3.3.I.1.1.1.1 SServicePackage
Name
Meaning
Optio
nal
Type
Range
Default
Value
Read
only
Comm
ent
srvpkgName
ServicePackage name.
String
Length:1~32
-1:NULL
Note1
The
format
shall be:
YYYYMMD
Dhhmmss
srvpkgSubscr
ibeDate

subscriber is provided
with the service
package.
From
19700101000
000
To
20371231235
959
Datetime
-1:NULL
means never
limit
Issue 01 (2012-08-30)

The
format
shall be:
YYYYMMD
Dhhmmss
srvpkgOverd
ueDate

service package expires.
From
19700101000
000
To
20371231235
959
Datetime
-1:NULL
Note2
-1:NULL
Note3
-1:NULL
Note4
-1:NULL
Note5
1:
Immediat
e
terminati
on
Note6
-1:NULL
means never
limit
The
format
shall be:
YYYYMMD
Dhhmmss
srvpkgStartD
ateTime

service package takes
effect.
From
19700101000
000
To
20371231235
959
Datetime
-1:NULL
means never
limit
The
format
shall be:
YYYYMMD
Dhhmmss
srvpkgEndDa
teTime

service package expires.
From
19700101000
000
To
20371231235
959
Datetime
-1:NULL
means never
limit
0:Roaming
srvpkgRoami
ngType
Roaming type.
Integer
1: Local
-1:NULL
TermInd
Termination identifier
of service package.
1:Immediate
termination
2:Valid
till
expiry date
Integer
Issue 01 (2012-08-30)

Note1: The specified time must be earlier than (or the same as) the srvpkgStartDateTime. This parameter takes
effect on all services of the service package.
Note2: The specified time must be later than the srvpkgStartDateTime. This parameter is not recommended. Please
use the srvpkgEndDateTime instead. The specified time must be later than the system time.
Note3: This parameter takes effect on all services of the service package. When the subscriber is prepaid and subscribed
a monthly service, this parameter is used to calculate the quota's next reset time, we do not consider the
srvpkgStartDateTime is null. If this parameter is modified to -1, the Web UI will be showed as NULL, and the next reset
time will be cleared.
Note4: The specified time must be later than the system time and the srvpkgStartDateTime. If this parameter is
modified to -1, the Web UI will be showed as NULL, the servicepackage will never be expired.
This parameter takes effect on all services of the service package. When the subscriber is subscribed a new service
package, all subscribed services before will be checked one by one and deleted if it expires.
Note5: If this parameter is modified to -1, the Web UI will be showed as NULL.
Note6: TermInd is only used for Unsubscribe ServicePackage command to indicate how to unsubscribe the recurring
service package. Immediate termination means unsubscribe the service package at once. Valid till expiry date means the
service package still can be used by the subscriber until the latest recurring date.
2.3.4 SSubscriberQuota
Table 2.3.4.I.1.1.1.1 SSubscriberQuota
Name
Meaning
qtaName
Name of the quota.

The associated service
name of this quota.
Initial value of the
quota.
The balance of this
quota.
The consumed value on
this quota.
srvName
qtaValue
qtaBalance
qtaConsump
tion
qtaClass
qtaStatus
Quota class.
Quota status.
Optio
nal
Type
Range
Defaul
t value
Read
only
Comm
ent
String
Length:1~32
String
Length:1~32
Integer
1~2147483645
Integer
0~2147483645
Integer
0~2147483645
Note1
Integer
0: Volume
1: Online
Duration
2: Duration
Integer
0: Normal
1: Level1
2: Level2
3: Level3
4: Level4
5: Exhaust
6: Level5
7: Level6
8: Level7
9: Level8
10: Level9
11: Level10
Note2/N
ote3
Issue 01 (2012-08-30)

10
The format shall

be:
YYYYMMDDh
hmmss
From
1970010100000
qtaRstDat The next reset date time
Datetim
Note4/N
Y
0 To
N
for this quota.
e
ote3
eTime
2037123123595
9
-1:NULL means
never expire
until removed
explicitly
Note1: The qtaConsumption is the used value of this quota, and its value may be bigger than the qtaValue.
Note2: Only the status of the volume quota accumulated by Pre-Sy can be changed .
Note3: When you query the quota over the SOAP interface, the quota status and the next reset time are displayed.
Note4: Only if the quota is accumulated by Pre-Sy and the billing cycle mode is set by Pre-Sy, the next reset date time
of the quota can be changed.
2.3.5 SSubscriberAccount
Table 2.3.5.I.1.1.1.1 SSubscriberAccount
Name
Meaning
Option
al
Type
Range
Defaul
t value
Read
only
Comm
ent
actValue
Initial value of the

account.
Float(3
2 bits)
0~10000000.00
Note1
actBalance
The balance of this

account.
Float(3
2 bits)
0~10000000.00
Note2
actConsumpti
on
The consumed value of

this account.
Float(3
2 bits)
0~10000000.00
Note:3
0: Normal
1: Level1
2: Level2
3: Level3
4: Level4
actStatus
The status of this

account.
5: Exhaust
Integer
6: Level5
7: Level6
8: Level7
9: Level8
10: Level9
11: Level10
0: Normal
64: PrivilegeA
actPrivilege
The privilege of this

account.
Integer
65: PrivilegeB
66: PrivilegeC
128: Unrestricted
Issue 01 (2012-08-30)

11
Format should be:
YYYYMMDDhh
mmss
actExpireDat
e
Expire date of this

account.
Dateti
me
From
19700101000000
To
20371231235959
Note4
Note5
-1:NULL
actPersonaliz
edValue
Personalized initial
value of the account.
Float(3
2 bits)
0~10000000.00
Note1: The actValue is the initialized value of each billing cycle for this subscriber, and it depends on the definition of
this account.
Note2: The actBalance is the remainder value of this account.
Note3: The actConsumption is the consumed value of this account, and its value may be bigger than the actValue.
Note4: After this date the account's value, balance, status, privilege, and consumption will be reset. An example is, set
"ExpireDate" to next financial month of the subscriber.
Note5: When actPersonalizedValue defined and actPersonalizedValue > 0.001, actPersonalizedValue will be used as
initial value of this account.When actPersonalizedValue undefined or actPersonalizedValue < 0.001, actValue will be
used as initial value of this account.
2.3.6 SSubscriberRechargedQuota
Table 2.3.6.I.1.1.1.1 SSubscriberRechargedQuota
Name
Meaning
Option
al
Type
Range
Default
value
Read
only
Comm
ent
qtaName
The Identifier
of the quota ,
String
Length:1~32
rechargedVal
ue
The value to
be recharged,
Integer
1~2147483645
Note1
qtaClass
Quota class,
N
Note1: The unit of this field is KB.
Integer
0: Volume
2.3.7 SSubscriberAccumulation
Table 2.3.7.I.1.1.1.1 SSubscriberAccumulation
Name
accName
accClass
accType
accUsage
CheckInterva
l
Meaning
Name of the
accumulation.
Accumulation
class.
Accumulation
type.
Used value of
the
accumulation.
Check Interval
(Minute).
Option
al
Type
Range
Default
value
Read
only
Comm
ent
String
Length:1~32
Integer
Integer
0: Volume
1:Duration
0:Period
1:Session
Integer
0~2147483645
Note1
Integer
0~1440
Note2
Issue 01 (2012-08-30)

12
WindowLeng
th
CurrentlyCyc
le
accStatus
Length of the
sliding
window.
Number of the
current cycle.
Accumulation
status.
Integer
0~7
Note3
Integer
0~7
Note1
Integer
0: Light Level
1:Heavy Level
Note1
Note4
Format should be:

NextResetDat
eTime
Next reset
time.
YYYYMMDDhhmmss
Y
Datetime
From 19700101000000
To 20371231235959
-1:NULL
Note1: If Accumulation Type is set to Session, this parameter is invalid, the value always is 0.
Note2: Specifies the interval between two consecutive accumulation status checks in a session. If Accumulation Type is set to
Period, this parameter is invalid, the value always is 0.
Note3: Specifies the number of periods contained in a sliding window for an accumulation. If Accumulation Type is set to
Session, this parameter is invalid, the value always is 0.
Note4: -1 is Invalid value. If Accumulation Type is set to Session, the value of this parameter should be -1.
2.3.8 SSubscriberAccumulationUsageInfo
Table 2.3.8.I.1.1.1.1 SSubscriberAccumulationUsageInfo
Name
Meaning
Option
al
Type
Range
Default
value
Read
only
Comm
ent
UsageValue
Used value of
the
accumulation.
Integer
0~2147483645
Format should be:

CreateTime
Create
accumulation
usage time.
yyyymmddhhmmss
Y
Datetime
From 19700101000000
To 20371231235959
-1:NULL
2.3.9 SSubscriberClearAccumulation
Table 2.3.9.I.1.1.1.1 SSubscriberClearAccumulation
Name
Meaning
Option
al
Type
Range
Default
value
Read
only
Comm
ent
accName
Name of the
accumulation.
String
Length:1~32
accClearType
Accumulation
clear type.
Integer
0: Current
1: History
2: All
2.3.10 SSubscriberRechargedService
Table 2.3.10.I.1.1.1.1 SSubscriberRechargedService
Name
Meaning
Option
al
Type
Range
Default
value
Read
only
Comm
ent
srvName
Service name.
String
Length:1~32
Note1
Issue 01 (2012-08-30)

13
rechargedVal
ue
The value to
be recharged.
Integer
1~2147483645
qtaClass
Quota class.
N
Integer
0: Volume
Note1:The service should associate one and only quota of volume.
Note2: The unit of this field is KB.
Note2
Default
value
Read
only
Comm
ent
2.3.11 SSubscriberCustomLevel
Table 2.3.11.I.1.1.1.1 SSubscriberCustomLevel
Name
Meaning
Option
al
Type
levelType
Level type.
Integer
qtaactName
Quota/Acco
unt Name.
String
Length:1~32
customLev
el1
Custom
Level 1.
Integer
0~500000
customLev
el2
Custom
Level 2.
Integer
0~500000
customLev
el3
Custom
Level 3.
Integer
0~500000
Default
value
Read
only
Comm
ent
-1:NULL
Range
1:Quota
2: Account
2.3.12 SSubscriberAlias
Table 2.3.12.I.1.1.1.1 SSubscriberAlias
Name
Meaning
Option
al
Type
Range
0: MSISDN
1: IMSI
AliasType
Alias type.
Integer
2: SIPURI
3: NAI
4: USERPRIVATE
AliasValue
AliasExpire
Date
Alias value.
Alias expire
date.
String
Datetime
Length:1~255
The format shall be:
YYYYMMDDhhmmss
From 19700101000000
To 20371231235959
-1:NULL
Issue 01 (2012-08-30)

14
UPCC SOAP Interfaces
3.1 Query Subscriber's Basic Information

Introduction
Get subscriber's basic information.
Message Description
Table 3.1.1.I.1.1.1.1 Description of messages used by the getSubscriber interface
Message
Description
getSubscriberRequest
getSubscriberResponse
Input parameter:
1. usrIdentifier, i.e. the IMSI or MSISDN, please refer to
"SPccSubscriber".
Output parameter:
1. Refer to "SPccSubscriber".
3.2 Query Subscriber's All Services

Introduction
Get subscriber's all services.
Message Description
Table 3.2.1.I.1.1.1.1 Description of messages used by the getSubscriberAllService interface
Message
getSubscriberAllServiceRequest
getSubscriberAllServiceResponse
Description
Input parameter:
"SPccSubscriber".
Output parameter:
1. Refer to "SSubscribedService".
[
Issue 01 (2012-08-30)

3.3 Query Subscriber's All ServicePackages

Introduction
Get subscriber's all service packages.
Message Description
Table 3.3.1.I.1.1.1.1 Description of messages used by the getSubscriberAllServicePackage
interface
Message
Description
Input parameter:
1. usrIdentifier, i.e. the IMSI or MSISDN, please
refer to "SPccSubscriber".
Output parameter:
1. Refer to "SServicePackage".
getSubscriberAllServicePackageRequest
getSubscriberAllServicePackageResponse
3.4 Query Subscriber's All Quotas

Introduction
Get subscriber's all quotas.
Message Description
Table 3.4.1.I.1.1.1.1 Description of messages used by the getSubscriberAllQuota interface
Message
Description
Input parameter:
"SPccSubscriber".
Output parameter:
getSubscriberAllQuotaResponse
1. Refer to "SSubscriberQuota".
Note1:If subscriber is slave and has no quota, querying quota for slave subscriber will return success.
Note2:If a quota is shared by multiple services, the getSubscriberSpecQuotaResponse massage includes the
information of multiple quotas and each quota has a service name.
getSubscriberAllQuotaRequest
3.5 Query Subscriber's Specific Quota

Introduction
Get subscriber's specific quota.
Issue 01 (2012-08-30)

Message Description
Table 3.5.1.I.1.1.1.1 Description of messages used by the getSubscriberSpecQuota interface
Message
Description
Input parameter:
getSubscriberSpecQuotaRequest
"SPccSubscriber".
2. qtaName, i.e. the name of the specific quota, refer to
"SSubscriberQuota".
Output parameter:
getSubscriberSpecQuotaResponse
Note1:In the getSubscriberSpecQuotaRequest, only one SSubscriberQuota object (i.e. qtaName) can be
contained.
Note2:If a quota is shared by multiple services, the getSubscriberSpecQuotaResponse massage includes the
information of multiple quotas and each quota has a service name.
3.6 Query Subscriber's Account Info

Introduction
Get subscriber's account information.
Message Description
Table 3.6.1.I.1.1.1.1 Description of messages used by the getSubscriberAccount interface
Message
Description
Input parameter:
"SPccSubscriber".
Output parameter:
getSubscriberAccountResponse
1. Refer to "SSubscriberAccount".
Note1:If subscriber is slave and has no account, querying account for slave subscriber will return success.
getSubscriberAccountRequest
3.7 Query Subscriber's All Info

Introduction
Get subscriber's all information.
Issue 01 (2012-08-30)

Message Description
Table 3.7.1.I.1.1.1.1 Description of messages used by the getSubscriberAllInf interface
Message
Description
Input parameter:
"SPccSubscriber".
Output parameter:
1. Refer to "SPccSubscriber" .
3. Refer to "SSubscribedService".
5. Refer to "SSubscriberAccount".
getSubscriberAllInfRequest
getSubscriberAllInfResponse
3.8 Add Subscriber

Introduction
Add a subscriber.
Message Description
Table 3.8.1.I.1.1.1.1 Description of messages used by the addSubscriber interface
Message
Description
addSubscriberRequest
addSubscriberResponse
Input parameter:
1. Subscriber info. Refer to "SPccSubscriber".
2. parameters of service, refer to "SSubscribedService".
Output parameter:
1. Result code.
Note1: The operator can add subscriber's basic information in this operation.
Note2: This interface also supports to subscribe services when add a subscriber, but this is only for
compatibility, please use the subscribeService interface instead of addSubscriber to subscribe services for a
subscriber.
3.9 Update Subscriber

Introduction
Update a subscriber.
Issue 01 (2012-08-30)

Message Description
Table 3.9.1.I.1.1.1.1 Description of messages used by the updateSubscriber interface
Message
Description
Input parameter:
1. Subscriber info. Refer to "SPccSubscriber".
Output parameter:
updateSubscriberResponse
1. Result code.
Note1: Operator can modify subscriber's basic information.
Note2: This interface also supports to subscribe or unsubscribe or update services, but this is only for
compatibility, please use the subscribeService or unSubscribeService or updateSubSubscription interface
instead of updateSubscriber to subscribe or unSubscribe or update services for a subscriber.
updateSubscriberRequest
3.10 Delete Subscriber

Introduction
Delete a subscriber.
Message Description
Table 3.10.1.I.1.1.1.1 Description of messages used by the deleteSubscriber interface
Message
Description
Input parameter:
"SPccSubscriber".
Output parameter:
delSubscriberResponse
1. Result code.
Note1: The subscription, quota, and account will be deleted when the subscriber is deleted.
Note2: When deleting a nonexistent subscriber, UPCC will return success.
delSubscriberRequest
3.11 Subscribe Service

Introduction
Subscribe the service for a subscriber.
Message Description
Table 3.11.1.I.1.1.1.1 Description of messages used by the subscribeService interface
Message
Description
subscribeServiceRequest
Input parameter:
"SPccSubscriber".
[
Issue 01 (2012-08-30)

2. parameters of service , refer to "SSubscribedService".

Output parameter:
subscribeServiceResponse
1. Result code.
Note1: This interface only supports to subscribe one service each time.
3.12 Update Subscribed Service

Introduction
Configure subscribed service.
Message Description
Table 3.12.1.I.1.1.1.1 Description of messages used by the updateSubSubscription interface
Message
Description
Input parameter:
"SPccSubscriber".
Output parameter:
1. Result code.
updateSubSubscriptionRequest
updateSubSubscriptionResponse
Note1: This interface only supports to update one subscribed service each time.
3.13 Unsubscribe Service

Introduction
Unsubscribe service.
Message Description
Table 3.13.1.I.1.1.1.1 Description of messages used by the unSubscribeService interface
Message
Description
Input parameter:
unSubscribeServiceRequest
"SPccSubscriber".
2. srvName, refer to "SSubscribedService".
3. TermInd, refer to SSubscribedService
Output parameter:
unSubscribeServiceResponse
1. Result code.
Note1: This interface only supports to unsubscribe one service each time.
Note2: When unsubscribing not existing subscriber's service, UPCC will return success.
Note3: The associated quotas and account will be deleted when the service is unsubscribed.
Issue 01 (2012-08-30)

3.14 Subscribe ServicePackage

Introduction
Subscribe a service package for a subscriber.
Message Description
Table 3.14.1.I.1.1.1.1 Description of messages used by the subscribeServicePackage interface
Message
Description
Input parameter:
subscribeServicePackageRequest
"SPccSubscriber".
2. parameters of service package, refer to "SServicePackage".
Output parameter:
subscribeServicePackageResponse
1. Result code.
Note1: This interface only supports to subscribe one service package each time.
3.15 Update Subscribed ServicePackage

Introduction
Update subscribed service package, e.g. srvpkgEndDateTime.
Message Description
Table 3.15.1.I.1.1.1.1 Description of messages used by the UpdateSubscribedServicePackage
interface
Message
Description
Input parameter:
updateSubscribedServicePackageRequest
"SPccSubscriber".
2. parameters of service package, refer to
"SServicePackage".
Output parameter:
updateSubscribedServicePackageResponse
1. Result code.
Note1: This interface only supports to update one service package each time.
3.16 Unsubscribe ServicePackage

Introduction
Unsubscribe service package.
Issue 01 (2012-08-30)

Message Description
Table 3.16.1.I.1.1.1.1 Description of messages used by the unSubscribeServicePackage interface
Message
Description
Input parameter:
1. usrIdentifier, i.e. the IMSI or MSISDN, please refer
unSubscribeServicePackageRequest
to"SPccSubscriber".
2. parameters of service package, refer to "SServicePackage".
Output parameter:
unSubscribeServicePackageResponse
1. Result code.
Note1: This interface only supports to unsubscribe one service package each time.
Note2: When unsubscribing not existing in the subscriber's service package, UPCC will return success.
Note3: The associated services, quotas, and account will be deleted when the service package is
unsubscribed.
3.17 Update Subscriber's Account

Introduction
Update account information of given subscriber, e.g. account status.
Message Description
Table 3.17.1.I.1.1.1.1 Description of messages used by the updateSubscriberAccount interface
Message
Description
Input parameter:
updateSubscriberAccountRequest
updateSubscriberAccountResponse
usrIdentifier, i.e. the IMSI or MSISDN, please refer to

"SPccSubscriber".
Subscriber's account info, refer to
"SSubscriberAccount".
Output parameter:
Result code.
Note1: At least one attribute of SSubscriberAccount should be specified which is to be changed, otherwise
UPCC will return resultCode 8201(Illegal parameter).
3.18 Recharge Subscriber's Quota

Introduction
Recharge quota to the given subscriber.
Issue 01 (2012-08-30)

Message Description
Table 3.18.1.I.1.1.1.1 Description of messages used by the rechargeSubscriberQuota interface
Message
Description
Input parameter:
rechargeSubscriberQuotaRequest
rechargeSubscriberQuotaResponse
usrIdentifier, i.e. the IMSI or MSISDN, please

Subscriber's recharge info, refer to
"SSubscriberRechargedQuota".
Output parameter:
Result code.
Notes:
Now the interface just supports the recharging function for the volume based quota.
After the quota is recharged, the quota usage will be reset accordingly.
After an quota is recharged, the sum of the remaining quota and the consumed quota may differ from the
subscribed quota.
For example, the quota information associated with a subscriber is as follows before the quota is
recharged:
Remaining quota: 0 KB
Consumed quota: 100 KB
Subscribed quota: 100 KB
After the subscriber has recharged the quota for 20 KB data volume usage, the quota information
associated with the subscriber is as follows:
Remaining quota: 20 KB
Consumed quota: 100 KB
Subscribed quota: 100 KB
The UPCC does not allow you to query the recharged quota information, such as the recharge amount
and how many times the quota has been recharged. After the quota is recharged for extra data volume
usage, only the remaining quota can be queried.
3.19 Update Subscribers Quota

Introduction
Update quota information (e.g. total value) of given subscriber. This is usually used for
customer maintain.
Issue 01 (2012-08-30)

Message Description
Table 3.19.1.I.1.1.1.1 Description of messages used by the updateSubscriberQuota interface
Message
Description
Input parameter:
updateSubscriberQuotaRequest
usrIdentifier(e.g. the IMSI or MSISDN), please refer to

SPccSubscriber.
qtaName (i.e. name of the quota will be updated) and
attributes will be updated, refer to SSubscriberQuota.
Output parameter:
updateSubscriberQuotaResponse
Result code.
Note1: It is recommended to use the rechargeSubscriberQuota for extra quota add on instead of using the
updateSubscriberQuota.
Note2: If the value of quote is modified, the qtaBalance = qtaValue qtaConsumption.
3.20 Subscribe Accumulation

Introduction
Subscribe accumulation.
Message Description
Table 3.20.1.I.1.1.1.1 Description of messages used by the subscribeAccumulation interface
Message
Description
Input parameter:
subscribeAccumulationRequest
subscribeAccumulationResponse

SPccSubscriber.
accName , refer to SSubscriberAccumulation.
Output parameter:
Result code.
Note1: This interface only supports to subscribe one accumulation each time.
3.21 Unsubscribe Accumulation

Introduction
Unsubscribe accumulation.
Issue 01 (2012-08-30)

10
Message Description
Table 3.21.1.I.1.1.1.1 Description of messages used by the unSubscribeAccumulation interface
Message
Description
Input parameter:
unSubscribeAccumulationRequest

SPccSubscriber.
accName, refer to SSubscriberAccumulation.
Output parameter:
unSubscribeAccumulationResponse
Result code.
Note1: This interface only supports to unsubscribe one accumulation each time.
3.22 Clear Accumulated Information

Introduction
Clear accumulated information.
Message Description
Table 3.22.1.I.1.1.1.1 Description of messages used by the clearAccumulation interface
Message
Description
Input parameter:
clearAccumulationRequest
clearAccumulationResponse

SPccSubscriber.
accName, refer to SSubscriberClearAccumulation.
accClearType, refer to SSubscriberClearAccumulation.
Output parameter:
Result code.
Note1: This interface only supports to clear one accumulation each time.
3.23 Query Subscribers Accumulation

Introduction
Get subscribers accumulations.
Issue 01 (2012-08-30)

11
Message Description
Table 3.23.1.I.1.1.1.1 Description of messages used by the getSubscriberAccumulation interface
Message
Description
Input parameter:
getSubscriberAccumulationRequest

SPccSubscriber.
optional parameters: accName, refer to
SSubscriberAccumulation.
Output parameter:
getSubscriberAccumulationResponse
Refer to SSubscriberAccumulation.
Refer toSSubscriberAccumulationUsageInfo.
3.24 Recharge Subscriber's Service

Introduction
Recharge the associated one and only quota of volume of the service to the given subscriber.
Message Description
Table 3.24.1.I.1.1.1.1 Description of messages used by the rechargeSubscriberService interface
Message
Description
Input parameter:
rechargeSubscriberServiceRequest
rechargeSubscriberServiceResponse

Subscriber's recharge info, refer to
"SSubscriberRechargedService".
Output parameter:
Result code.
Notes1:The given service should associate one and only quota of volume. If the service associates more
than one quota of volume, UPCC will return resultCode 13064 (More than one quota of a specified type
is associated with the service).
Note2:It is recommended to use the rechargeSubscriberQuota for extra quota add on instead of using the
rechargeSubscriberService.
3.25 Update Subscriber's Custom Level

Introduction
Update the custom levels of the quota or account to the given subscriber.
Issue 01 (2012-08-30)

12
Message Description
Table 3.25.1.I.1.1.1.1 Description of messages used by the updateSubscriberCustomLevel
interface
Message
Description
Input param:
usrIdentifier, i.e. the IMSI or MSISDN, please refer
to SPccSubscriber.
updateSubscriberCustomLevelRequest
levelType, qtaactName, refer to

SSubscriberCustomLevel.
optional parameters: customLevel1, customLevel2,

customLevel3, refer to SSubscriberCustomLevel.
Output parameter:
Result code.
Notes1:The customLevel1, customLevel2 and customLevel3 shouldnt be same unless equal to 0.
updateSubscriberCustomLevelResponse
3.26 Query Subscriber's Custom Level

Introduction
Query the custom levels of the quota or account to the given subscriber.
Message Description
Table 3.26.1.I.1.1.1.1 Description of messages used by the getSubscriberCustomLevel interface
Message
Description
Input param:
getSubscriberCustomLevelRequest
getSubscriberCustomLevelResponse

refer to SPccSubscriber.
optional parameters: levelType, qtaactName, refer
to SSubscriberCustomLevel.
Output parameter:
Refer to SSubscriberCustomLevel.
3.27 Reset Subscriber's Quota

Introduction
Reset the specified quota of a subscriber.
Issue 01 (2012-08-30)

13
Message Description
Table 3.27.1.I.1.1.1.1 Description of messages used by the resetSubscriberQuota interface
Message
Description
Input param:
resetSubscriberQuotaRequest

refer to SPccSubscriber.
qtaName, i.e. the name of the specific quota, refer
to "SSubscriberQuota".
Output parameter:
1. Result code.
Note1: This interface only supports to reset one quota of subscriber each time.
resetSubscriberQuotaResponse
3.28 Add Subscriber Alias

Introduction
Add an alias for a subscriber.
Message Description
Table 3.28.1.I.1.1.1.1 Description of messages used by the addSubscriberAlias interface
Message
Description
Input parameter:
addSubscriberAliasRequest
"SPccSubscriber".
2. parameters of alias, refer to "SSubscriberAlias".
Output parameter:
addSubscriberAliasResponse
1. Result code.
Note1: This interface cannt be used now, it is reserved only for compatibility.
3.29 Update Subscriber Alias

Introduction
Update alias information for a subscriber.
Issue 01 (2012-08-30)

14
Message Description
Table 3.29.1.I.1.1.1.1 Description of messages used by the updateSubscriberAlias interface
Message
Description
Input parameter:
updateSubscriberAliasRequest
"SPccSubscriber".
updateSubscriberAliasRespons Output parameter:
e
1. Result code.
3.30 Delete Subscriber Alias

Introduction
Delete alias information for a subscriber.
Message Description
Table 3.30.1.I.1.1.1.1 Description of messages used by the deleteSubscriberAlias interface
Message
delSubscriberAliasRequest
delSubscriberAliasResponse
Description
Input parameter:
"SPccSubscriber".
Output parameter:
1. Result code.
Issue 01 (2012-08-30)

15
3.31 Query Subscriber's Alias

Introduction
Get subscriber's alias information.
Message Description
Table 3.31.1.I.1.1.1.1 Description of messages used by the getSubscriberAlias
Message
Description
Input parameter:
"SPccSubscriber".
Output parameter:
getSubscriberAliasResponse
Refer to "SSubscriberAlias" .
getSubscriberAliasRequest
3.32 Subscribe ServicePacket

Introduction
Subscribe service packet.
Message Description
Table 3.32.1.I.1.1.1.1 Description of messages used by the subscribeServicePacket interface
Message
Description
Input parameter:
subscribeServicePacketRequest
"SPccSubscriber".
2. parameters of service Packet, refer to "SServicePackage".
Output parameter:
subscribeServicePacketResponse
1. Result code.
Note1: This interface cannt be used now, it is reserved only for compatibility and is replaced by the
subscribeServicePackage interface.
3.33 Unsubscribe ServicePacket

Introduction
Unsubscribe a service packet for a subscriber.
Issue 01 (2012-08-30)

Message Description
Table 3.33.1.I.1.1.1.1 Description of messages used by the unSubscribeServicePacket interface
Message
Description
Input parameter:
1. usrIdentifier, i.e. the IMSI or MSISDN, please refer
unSubscribeServicePacketRequest
to"SPccSubscriber".
2. parameters of service Packet, refer to "SServicePackage".
3. TermInd, refer to SServicePackage.
Output parameter:
unSubscribeServicePacketResponse
1. Result code.
unSubscribeServicePackage interface.
3.34 Query Subscriber's All ServicePackets

Introduction
Get subscriber's all service packets.
Message Description
Table 3.34.1.I.1.1.1.1 Description of messages used by the getSubscriberAllServicePacket
interface
Message
Description
Input parameter:
1. usrIdentifier, i.e. the IMSI or MSISDN, please
Output parameter:
getSubscriberAllServicePacketResponse
getSubscriberAllServicePackage interface.
getSubscriberAllServicePacketRequest
Issue 01 (2012-08-30)

Exception Handling
4.1 Mechanism for Handling SOAP Interface

Abnormity
4.1.1 Handling Service Flow Abnormity
Service flow abnormity refers to inconsistence of data on the SOAP interface client and that
on the UPCC PMS and logical errors such as service operation flow error.
For service flow abnormity, the SOAP interface client just displays the reasons for the
abnormity, instead of asking you to handle it as an error.
4.1.2 Handling Service Data Abnormity

Service data abnormity refers to operation result errors such as invalid data, package
transmission error, and package coding/decoding error.
For service data abnormity, you may handle it as an error, that is, carry out protections on the
SOAP interface client according to the returned error code.
4.2 Error Codes for the UPCC SOAP Interface

The error code for the UPCC SOAP interface is the abnormity information returned by the
UPCC when it performs operations related to the SOAP interface. Table 4.2.1.I.1.1.1.1 lists
the error codes for the UPCC SOAP interface and their meaning. The Provisioning system
may choose an appropriate error code according to the actual scenario. Generally, the
provisioning system should only judge if the error code is zero or none-zero.
From UPCC V300R002C06, additional error description is supported on the interface. When
error exists, UPCC will return with "resultCode" and a "paras" identified by key assigned to
be "errorDescription", the "paras" element provide an attribute to describe the error
encountered.
<resultCode>12339</resultCode>
<paras>
Issue 01 (2012-08-30)

<key>errorDescription</key>
<value>The user already exists</value>
</paras>
Table 4.2.1.I.1.1.1.1 Error codes for the UPCC SOAP interface

UPCC
ErrorCode
Error Description
Operation succeeded
1001
Invalid command
1003
Invalid parameter name <parameter>
1004
Invalid parameter value <value> for <parameter>
1009
Parameter missing <parameter list>
1010
Parameter conflict
1111
Maximum limitation exceeded
1117
Database updated but network update failure
1118
Parameter repeated <parameter>
1121
The service response times out
5001
Internal error
5002
Flow control enabled
5004
Session ID invalid or time out
5007
Invalid SOAP message
8194
RMS communication error
8195
The server is abnormal, please try later
8201
Input parameters error
12299
The service is already subscribed
12300
The service is not subscribed
12302
The subscriber does not exist
12303
The given quota does not exist, please check
12304
The service does not exist
12334
Subscribing the service failed, please try later
12339
The user already exists
12343
Failed to query quotas belong to the specific service
Issue 01 (2012-08-30)

UPCC
ErrorCode
Error Description
12351
The number of quotas per subscriber exceeds the maximum

value
12352
The service subscription is restricted by mutex definition
12354
The service is contained in a service package that is already

ordered, please check
12362
ServicePackage does not exist
12422
The quota value does not exist
12478
The ServicePackage has already been ordered
12482
Clearing or resetting the quota of the master subscriber is

prohibited
12500
The number of slave subscriber subject to a master has reached

restriction
12510
The number of services subscribed by the subscriber exceeds

the maximum value
12511
The number of servicepackages subscribed by the subscriber

exceeds the maximum value
12519
The number of MultiServices subscribed exceeds the

maximum value
12524
Can't modify the subscriber's duration session Quota
12600
The given account does not exist, please check
12601
Clearing or resetting the account of the master subscriber is

prohibited
12608
Subscriber should subscribe only one service which is

associated with an account, please check
12626
The subscriber should be frozen if you want to change the

usrIdentifier
12627
The service package does not order, please check
12631
Conflict with the valid date sections of previous subscriptions,

please check
12632
The expiry date cannot be earlier than (or the same as) the
system time, please check
12801
Total value of the quota exceeds restriction
12802
The service is overdue
12803
The service is no in effect
13056
The subscription date cannot be later than (or the same as) the
expiry date
[
Issue 01 (2012-08-30)

UPCC
ErrorCode
Error Description
13057
The start date cannot be later than (or the same as) the expiry
date
13061
This operation is not applicable to the dynamically created

subscriber
13062
Total value of the account exceeds restriction
13063
The service cannot be modified because it is subscribed by a

servicepackage
13064
More than one quota of a specified type is associated with the

service
13065
The service is not associated with the quota of a specified type
13072
Level conflict
20499
The number of subscribers exceeds the upper threshold of

License
90101
The master subscriber does not exist, please check
90102
There are slave subscribers depending on the master subscriber
90103
Lack of Master Subscriber ID
90105
The subscriber corresponding to Master Subscriber ID cannot

be a slave subscriber
90106
The Master Subscriber ID cannot be the same as Subscriber ID
90125
The accumulation does not exist
90368
The number of accumulations subscribed by the subscriber

90369
The accumulation has been ordered
90370
The accumulation is not ordered
90371
The number of session accumulation be subscribed exceeds the

maximum value
90372
Clearing the usage of session accumulation is prohibited
90373
Invalid service usage status
90374
The number of automatic activate BOD services subscribed by

the subscriber exceeds the maximum value
90375
The subscriber's network type corresponding to Master

Subscriber ID cannot be FBB type
90376
The master of FBB can't change into slave
90377
The number of BOD services subscribed by the subscriber

[
Issue 01 (2012-08-30)

UPCC
ErrorCode
Error Description
90378
The quota cannot be recharged because the reset time is earlier

than the recharging time. Recharge the quota after the
subscriber accesses the network again
90379
The second subscriber ID cannot be inputted when subscriber

ID dual index function is turned off
90380
The second subscriber ID is missing when subscriber ID dual

index function is turned on
98311
The quota is not associated with any service
98312
The quota status cannot be modified
98313
Value or Balance for a quota cannot be modified
98314
The quota managed by an external entity cannot be associated

with more than one service
98315
The quota managed by an external entity does not support this

operation
Issue 01 (2012-08-30)

WSDL
5.1 The WSDL File

UPCCProvisioning.
rar
5.2 Samples
Sample.rar
Issue 01 (2012-08-30)

Loading Key Store
6.1 The Method of Loading Key Store

As the integration between the UPCC and Provisioning System is based on https, so the
Provisioning System should install the key store before using the interface provided by
UPCC. Because the UPCC is a SOAP server, so the key store is also provided by UPCC.
client.zip
About the method of installing the key store, please refer to the following example code of
JAVA. If the development language is not JAVA, please contact Huawei technical support
engineers.
//Load Key store
private void loadKeyAndTrustStore()
{
try
{
//System.out.println(Constants.ROOT_PATH + Constants.STORE_FILE);
AdminLogger.error("Certificate file: " + Constants.ROOT_PATH
+ Constants.STORE_FILE);
// System load ssl the file of certificate

// Load Key store
System.setProperty("javax.net.ssl.keyStore", Constants.ROOT_PATH
+ Constants.STORE_FILE);
System.setProperty("javax.net.ssl.keyStorePassword", "123456");
Issue 01 (2012-08-30)

// TrustStore
System.setProperty("javax.net.ssl.trustStore",
Constants.ROOT_PATH + Constants.STORE_FILE);
System.setProperty("javax.net.ssl.trustStorePassword", "123456");
}
catch (Exception ex)
{
AdminLogger.error(ex, "StartupServlet.loadKeyAndTrustStore");
}
Issue 01 (2012-08-30)


UPCC V300R005C01 SOAP Interface Instructions

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

UPCC V300R005C01 SOAP Interface Instructions

Uploaded by

Copyright:

Available Formats

UPCC

HUAWEI TECHNOLOGIES CO., LTD.

Copyright Huawei Technologies Co., Ltd. 2012. All rights reserved.

Trademarks and Permissions

Huawei Technologies Co., Ltd.

Huawei Industrial Base

Add activate and deactivate service

Add parameter of subscriber and

Update according to review comments.

Update according to review

Delete usrPassword of subscriber.

Update Sample file

Modify subscriber identifys length and

Modify usrStates range and

Add usrCustomerAttr of SPccSubscriber

Add Data Type Definition 2.2 description

Add srvValidPeriod parameter for

Extend usrBillCycleDate parameter range

Update according DTS2012022102723 and

Baseline for UPCC V300R005C01 from

Add usrExAttr1~10 of SPccSubscriber

Huawei Proprietary and Confidential

Add usrSMSMSISDN of SPccSubscriber

Update according to CR20120509042

Update according to CR20120522079

Add usrSecondIdentifier of SPccSubscriber

Add error code 90379 and 90380 for

Modify the max length of

Update according DTS2012062000821

Update according DTS2012061104379

Update according DTS2012070401202

Add note for the TermInd of

Add error code 98311 to 98315 according

Update according to DTS2012071202475

Add srvStatus of SSubscribedService

Huawei Proprietary and Confidential

Add parameters of service for

Update according to CR20120529059

Update according to CR20120703033

Add Subscribed_SPR_INST and Subscribed_Sy in

Update according to DTS2012080106866

Update according to DTS2012101908131

Update according to DTS2012102308436

Update according to DTS2012101706545

Huawei Proprietary and Confidential

2 SOAP-Related Service Processes.................................................2-1

3 UPCC SOAP Interfaces................................................................3-1

Huawei Proprietary and Confidential

Huawei Proprietary and Confidential

6 Loading Key Store......................................................................6-1

Huawei Proprietary and Confidential

YFigure 1-1 UPCC Networking..........................................................................................................................1-4

Huawei Proprietary and Confidential

YTable 2-1 SPccSubscriber.................................................................................................................................2-2

Huawei Proprietary and Confidential

Table 3-12 Description of messages used by the updateSubSubscription interface............................................3-6

Huawei Proprietary and Confidential

1.1 SOAP Interface Description

SOAP is a protocol for exchanging messages over computer networks. It provides a

SOAP consists of the following four parts:

Representation: It defines the convention on presenting remote procedure calls and

Binding convention: It defines the binding convention on how to use an underlying

1.1.2 SOAP Interfaces

1.1.3 Get WSDL for this SOAP Interfaces