HSS9860 V900R008C50 PGW SOAP Interface Description (HLR)

HSS9860 V900R008C30 PGW SOAP Interface
Description(HLR)
Huawei Technologies Co., Ltd.
Issue 01 (2013-11-15) Huawei Proprietary and Confidential 1

Copyright Huawei Technologies Co.,
Ltd..
HSS9860
PGW SOAP Interface Description(HLR) Contents INTERNAL OPEN
October 17Contents
1 Revision Record.............................................................................................................................3
1.1 Related Terms....................................................................................................................................................4
2 Overview.........................................................................................................................................5
3 Network Connection.....................................................................................................................6
4 HTTP Session Management........................................................................................................8
4.1 HTTP Session Management...............................................................................................................................8
4.1.1 Login Command.......................................................................................................................................9
4.1.2 Service Command...................................................................................................................................10
4.1.3 Session Maintenance..............................................................................................................................11
4.1.4 Logout Command...................................................................................................................................12
4.2 Command Response Time...............................................................................................................................13
5 Interface Design...........................................................................................................................14
5.1 SOAP Request Message...................................................................................................................................14
5.2 SOAP Response Message................................................................................................................................15
6 Command Syntax........................................................................................................................17
7 WSDL Files.....................................................................................................................................18
8 Key Parameters.............................................................................................................................19

Ltd..
HSS9860 Revision RecordRevision
PGW SOAP Interface Description(HLR) Record INTERNAL OPEN
1 Revision Record
Date Version Description
2013-08-27 HSS9860V900R008C20 Update Version

Ltd..
HSS9860 Revision RecordRevision
PGW SOAP Interface Description(HLR) Record INTERNAL OPEN
1.1 Related Terms

Term Description
Provisioning The provisioning system interface refers to the commands provided by Huawei HLR. These
system interface commands can be used to define or delete subscribers, or query or modify subscription
details.
Provisioning The provisioning system is the billing system that the third-party software manufacturers
system supply for mobile carriers. The provisioning system must send session requests to the PGW
actively to set up a session. After a session is set up, the provisioning system must send
handshake messages to maintain the session. In addition, it manages the service data of the
AAA subscribers defined in the HLR through the provisioning system interface supported by
Huawei HLR.
Web LMT The Web LMT is a graphical user interface provided by Huawei HLR for interaction with
operators. The Web LMT adopts Internet Explorer to manage and maintain the data of the
AAA subscribers in the HLR. Certain operations, such as defining a subscription template
and setting the service data, must be performed on the Web LMT.
PGW The PGW provides services for the provisioning system and the Web LMT. It processes the
commands sent from the provisioning system or the Web LMT and sends the command
processing results to the provisioning system or the Web LMT.
SOAP Simple Object Access Protocol (SOAP) is defined for exchanging information in a
distributed environment. It uses Extensible Markup Language (XML) as its message format.
It sends XML using HTTP, and thus the SOAP request and response messages can be
properly bound with the HTTP request and response messages.
WSDL Web Services Description Language (WSDL) is an XML-based language used to describe
Web services. The WSDL files in the HLR describe the Web service interfaces associated
with SOAP and HTTP.
URL Uniform Resource Locator (URL) is a subset of the Uniform Resource Identifier (URI) that
specifies where an identified resource is available and the mechanism for retrieving it.

Ltd..
HSS9860
PGW SOAP Interface Description(HLR) OverviewOverview INTERNAL OPEN
2 Overview
Huawei HLR (HSS9860) provides the provisioning system interface, which allows a third-
party application software system to directly manage the subscriber data stored in it.
The provisioning system interface supported by Huawei HLR can be MML interface or SOAP
interface. This document describes the SOAP interface only.
The specific format of the SOAP messages is described in a set of WSDL files.

Ltd..
HSS9860 Network ConnectionNetwork
PGW SOAP Interface Description(HLR) Connection INTERNAL OPEN
3 Network Connection
The PGW provides the SOAP interface for the provisioning system to access using HTTP.
The PGW supports both persistent and temporary connections.
The PGW does not support session authentication for temporary connections. Therefore, the right
check function needs to be disabled on the PGW.
The performance of temporary connections is worse than that of persistent connections because a
large number of messages for establishing and releasing connections are generated. Therefore,
persistent connections are recommended.
The PGW provides a configurable IP address and port. The provisioning system must send
session requests to the PGW based on the IP address and port number. The PGW supports
control based on the number of connections. A maximum of 70 connections are allowed
between the provisioning system and the PGW.
The provisioning system uses the POST method to send requests to the PGW and waits for
responses from the PGW, as shown in the following figure.

Ltd..
HSS9860
For the same SOAP connection, the provisioning system is not allowed to send new requests
before receiving responses from the PGW or the timer expires. For example, the message
flow shown in the following figure is not allowed.

Ltd..
HSS9860 HTTP Session ManagementHT
PGW SOAP Interface Description(HLR) TP Session Management INTERNAL OPEN
4 HTTP Session Management
4.1 HTTP Session Management

The PGW supports session management only for persistent connections. After a session
between the provisioning system and the PGW is established, the provisioning system needs
to send handshake messages to the PGW periodically to maintain the session. If the PGW
does not receive a handshake or service message about the session within a specified period
(50 seconds by default), the PGW disconnects the session connection. After the connection is
disconnected, the provisioning system sends an LGI request again to establish a new session.
The provisioning system can send a LGO request to deregister the session. After the session is
deregistered, the PGW deletes information about the session and redirects to the requested IP
address. The following figure shows the specific flow:

Ltd..
HSS9860
Content in the following messages is only for your reference.
4.1.1 Login Command

The provisioning system connects to the PGW by sending an HTTP message, which
contains the IP address and port number of the PGW. The HTTP message for requesting
the connection to the PGW is in the following format:
POST / HTTP/1.1
Content-Type: text/xml;charset=UTF-8
SOAPAction: "Notification"
User-Agent: Jakarta Commons-HttpClient/3.1
Host: 169.10.20.100:8001
Content-Length: 201
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<LGI>
<OPNAME>user</OPNAME>
<PWD>password</PWD>
</LGI>
</soapenv:Body>
</soapenv:Envelope>
In the preceding example, LGI indicates the command name, admin indicates the
operator name used to log in to the PGW, and sysadmin indicates the operator password.
After the connection to the PGW is set up, the PGW returns a positive HTTP response,
which contains the location header, to instruct the provisioning system to send the
subsequent requests to a new address. The provisioning system must support the HTTP
redirection function so that it can send subsequent service instructions in SOAP format to
the redirected address.
The positive HTTP response indicating that the connection to the PGW is set up in the
following format:
HTTP/1.1 307 Temporary Redirect
Location: http://169.10.20.100:8001/00500000
Server: Huawei web server
Content-Type: text/xml; charset="utf-8"
Content-Length: 407
<?xml version="1.0"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SOAP-ENV:Body>
<LGIResponse>
<Result>
<ResultCode>0</ResultCode>
<ResultDesc>Operation is successful</ResultDesc>
</Result>
</LGIResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Ltd..
HSS9860
If the authentication fails, the PGW returns a 200 response. ResultCode and ResultDesc
in the message describe the reason why the authentication fails.
HTTP/1.1 200 OK
Content-Length: 375
<SOAP-ENV:Body>
<LGIResponse>
<Result>
<ResultDesc>Password doesn't match</ResultDesc>
</Result>
</LGIResponse>
</SOAP-ENV:Body>
4.1.2 Service Command

1. After the provisioning system logs in to the PGW successfully, the provisioning system sends a request
to the redirected IP address. For example, the redirected IP address is
http://169.10.20.100:8001/00500000, the message format is as follows:
POST /00500000 HTTP/1.1
Host: 169.10.20.100:8001
Content-Length: 427
<soapenv:Body>
<ADD_KI>
<HLRSN>1</HLRSN>
<IMSI>863456789102228</IMSI>
<OPERTYPE>ADD</OPERTYPE>
<KIVALUE>11111111111111111111111111111111</KIVALUE>
<CARDTYPE>SIM</CARDTYPE>
<ALG>COMP128_1</ALG>
</ADD_KI>
</soapenv:Body>
</soapenv:Envelope>
Content in soapenv:Body is only for your reference.
2. If the sessionID sent by the provisioning system is correct and the command is successfully executed,
the PGW returns a success response. The response format is as follows:

Ltd..
HSS9860
HTTP/1.1 200 OK
Content-Length: 425
<SOAP-ENV:Body>
<ADD_KIResponse>
<Result>
<ResultDesc>SUCCESS0001:Operation is successful</ResultDesc>
</Result>
</ADD_KIResponse>
</SOAP-ENV:Body>
If the request message does not carry the sessionID or the sessionID is invalid, the PGW returns a
response with error code 5004.
HTTP/1.1 200 OK
Content-Length: 423
<SOAP-ENV:Body>
<ADD_KIResponse>
<Result>
<ResultDesc>Session ID invalid or time out</ResultDesc>
</Result>
</ADD_KIResponse>
</SOAP-ENV:Body>
4.1.3 Session Maintenance

Session
After a session between the provisioning system and the PGW is established, the
provisioning system needs to send handshake messages to the PGW periodically to
maintain the session. If the PGW does not receive a handshake or service message about
the session within a specified period (50 seconds by default), the PGW disconnects the
session connection. After the connection is disconnected, the provisioning system sends
an LGI request again to establish a new session.
Session Request
The HTTP message for requesting the maintaining session between the provisioning
system and the PGW is in the following format:

Ltd..
HSS9860
POST /00500000 HTTP/1.1

Host: 169.10.20.100:8001
Content-Length: 0
Session Response
The positive HTTP response indicating that the maintaining session between the
provisioning system and the PGW is in the following format:
HTTP/1.1 200 OK
Content-Length: 0
4.1.4 Logout Command

The HTTP logout message is in the following format:
POST /00500000 HTTP/1.1
Host: 169.10.20.100:8001
Content-Length: 157
<soapenv:Body>
<LGO>
</LGO>
</soapenv:Body>
</soapenv:Envelope>
Here, LGO indicates the command name.

After the logout succeeds, the PGW returns a positive response and ends the session.
The positive HTTP logout response is in the following format:
Location: http://169.10.20.100:8001
Content-Length: 368
<SOAP-ENV:Body>
<LGOResponse>
<Result>
<ResultDesc>Operation is successful</ResultDesc>
</Result>
</LGOResponse>
</SOAP-ENV:Body>

Ltd..
HSS9860
If the request message does not carry the sessionID or the sessionID is invalid, the PGW
returns a response with error code 5004.
Location: http://169.10.20.100:8001
Content-Length: 378
<SOAP-ENV:Body>
<LGOResponse>
<Result>
<ResultDesc>Session ID invalid or time out</ResultDesc>
</Result>
</LGOResponse>
</SOAP-ENV:Body>
4.2 Command Response Time

After receiving a SOAP request from the provisioning system, the PGW returns a response to
the provisioning system within a specified period (50 seconds by default), no matter whether
the command is successfully executed.
The provisioning system considers that the request fails if it does not receive a response from
the PGW within 50 seconds, and ignores the response received afterwards.

Ltd..
HSS9860 Interface DesignInterface
PGW SOAP Interface Description(HLR) Design INTERNAL OPEN
5 Interface Design
5.1 SOAP Request Message

The format of the SOAP request message is as follows:
<?xml version="1.0" ?>
<SOAP-ENV:Body>
<CmdCode>
<Param1>XXXX</Param1>
<Param2>YYYY</Param2>
...
</CmdCode>
</SOAP-ENV:Body>
In the preceding format, CmdCode indicates the command name, Param1 and Param2
indicate parameters, and XXXX and YYYY indicate parameter values.
The invalid SOAP request refers to the message that does not comply with the XML
syntax or whose format is invalid. For example:
<Group>
<Param></Param>
</Group>
Processing of the escape characters (", ', >, <, and &) contained in parameter values
During message resolution, the character entities contained in the SOAP message are
converted to the corresponding characters. For details, see the following table.
Character Entity Character
< <
> >
" "
& &

Ltd..
HSS9860
' '
Here, the characters < and & must be converted, and whether the
characters ", ', and > are converted is determined according to
the actual requirement.
Assume that the SOAP message contains the following information:

<ISD> PLMN-SS-1&PLMN-SS-2 </ISD>
The SOAP protocol stack resolves the information as follows:

ParamName = ISD
OrigValue = PLMN-SS-1&PLMN-SS-2
5.2 SOAP Response Message

The format of the SOAP response message is as follows:
<?xml version="1.0" ?>
<SOAP-ENV:Body>
<CmdCodeResponse>
<Result>
<ResultCode>...</ResultCode>
<ResultDesc>...</ResultDesc>
<ResultData>
...
</ResultData >
</Result>
</CmdCodeResponse>
</SOAP-ENV:Body>
In the preceding format, the <ResultData> node displays the data requested by the operator.
Under the <ResultData> node, four types of nodes are available:
Parameter type
For example, the following is a <Parameter> node.
<ISDN>111111111111111</ISDN>
This type of node must contain simple elements, which can not contain any attribute.
Group type
For example, the following is a <Group> node named Hello:
<Group Name="Hello">
...
</Group>
The node of the parameter type can be independent of the <Group> node or stored
under the <Group> node as a group of data.

Ltd..
HSS9860
The <Group> node corresponds to the <Group> node under the <Report> node in the
XML configuration file.
The Name attribute of the <Group> node is optional. If the Name attribute is not
defined, it indicates that the group does not have a name.
The <Group> node is of a compound type. Each <Group> node contains a group of
data, which can be one or multiple nodes of the parameter type or <Group> nodes.
Table type
For example, the following is a <Table1> node that contains two <Item> nodes but does
not have a name:
<Table1>
<Item>
<HDUNAME>1</HDUNAME>
<HDUIP>172.18.100.6</HDUIP>
<Connection_State>Open</Connection_State>
<Status>Active</Status>
</Item>
<Item>
<HDUIP>172.19.100.6</HDUIP>
<Status>Standby</Status>
</Item>
</Table1>
The <Table1> node represents a data set presented in tabular form.

The Name attribute of the <Table1> node is optional. If the Name attribute is not
defined, it indicates that the table does not have a name.
The <Table1> node corresponds to the <HorizontalDisplay> node under the
<Report> node in the XML configuration file.
Item type
For example, the following is an <Item> node:
<Item>
<HDUIP>172.18.100.6</HDUIP>
<Status>Active</Status>
</Item>
Each <Item> node represents a row of data in the table.

The specific format of each response message is described in the WSDL files.

Ltd..
HSS9860 Command SyntaxCommand
PGW SOAP Interface Description(HLR) Syntax INTERNAL OPEN
6 Command Syntax
The command syntax of the AAA business hall interface is as follows:

There are six types of parameters, including the numeral, the Boolean, the string, the
enumeration, the date type and the time type. The values of different types of parameters are
in different forms:
String
The value of the parameter is a string consisting of the characters from A to Z, from a to
z, from 0 to 9, or other characters in the formats that the WINDOWS operating system
supports.
Numeral
The value of the parameter is an Arabic number consisting of the digits from 0 to 9
Boolean
The value of the parameter can be TRUE or FALSE.
Enumeration type
The values of the parameter are enumerated names or values. ( In command line, the
enumerated name and enumerated value can be interchangeable.)
Date type
The value of the parameter is in the YYYY-MM-DD format, Put zeros in front of the
month and the day if the month and the day are one-digit numbers.
Time type
The value of the parameter is in HH:MM:SS or HH:MM. Put zeros in front of the hour,
the minute and the second if they are one-digit numbers.
The format of the date and time must be YYYY-MM-DD HH:MM:SS.

Ltd..
HSS9860
PGW SOAP Interface Description(HLR) WSDL FilesWSDL Files INTERNAL OPEN
7 WSDL Files
The WSDL describes the format of SOAP request and response messages. A set of WSDL
files is provided to describe the format of SOAP messages that are exchanged between the
HSS9860 and the provisioning system. Figure 1.1 shows the relation between the WSDL files.
Figure 1.1 Relation between the WSDL files
The HSS9860.wsdl file is associated with multiple files whose names are in
WCDMA_XXXXX.wsdl format. Each WCDMA_XXXXX.wsdl file describes the format of
a SOAP request/response message pair. The HlrTypeBase.xsd file describes the parameter
types. It is referenced by all the WCDMA_XXXXX.wsdl files.
HSS9860.rar
Appendix:< >

Ltd..
HSS9860 Key ParametersKey
PGW SOAP Interface Description(HLR) Parameters INTERNAL OPEN
8 Key Parameters
Pay attention to the following points when accessing the PGW through the SOAP interface:
The PGW provides an HTTP access port (port 8001 by default) externally. Ports for each
service type can be added based on site requirements.
The provisioning system must send handshake messages to the PGW within a specified
period (50 seconds by default). If the PGW does not receive a handshake or service
message about the session within the specified period, the PGW disconnects the session
connection. After the connection is disconnected, the provisioning system sends an LGI
request again to establish a new session. If the provisioning system receives a response
with error code 5004 from the PGW, the provisioning system needs to send an LGI
request again to establish a new session.
If the provisioning system sends a command to the PGW but does not receive any
response in the specified period (50 seconds by default), it concludes that the execution
of the command fails.
The PGW supports a maximum of 100 connections to the provisioning system over the
SOAP interface by default. The maximum number of connections is configurable.
The provisioning system must send requests to the PGW in serial mode; that is, the
provisioning system is not allowed to send another request before the PGW returns a
response to the previous request or the timer expires.

Ltd..

HSS9860 V900R008C50 PGW SOAP Interface Description (HLR)

Încărcat de

Informații document

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

HSS9860 V900R008C50 PGW SOAP Interface Description (HLR)

Încărcat de

Drepturi de autor:

Formate disponibile

HSS9860 V900R008C30 PGW SOAP Interface

Huawei Technologies Co., Ltd.

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 1

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 2

Date Version Description

2013-08-27 HSS9860V900R008C20 Update Version

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 3

1.1 Related Terms

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 4

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 5

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 6

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 7

4 HTTP Session Management

4.1 HTTP Session Management

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 8

Content in the following messages is only for your reference.

4.1.1 Login Command

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 9

4.1.2 Service Command

Content in soapenv:Body is only for your reference.

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 10

4.1.3 Session Maintenance

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 11

POST /00500000 HTTP/1.1

4.1.4 Logout Command

Here, LGO indicates the command name.

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 12

4.2 Command Response Time

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 13

5.1 SOAP Request Message

Character Entity Character

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 14

Assume that the SOAP message contains the following information:

The SOAP protocol stack resolves the information as follows:

5.2 SOAP Response Message

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 15

The <Table1> node represents a data set presented in tabular form.

Each <Item> node represents a row of data in the table.

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 16

The command syntax of the AAA business hall interface is as follows:

The format of the date and time must be YYYY-MM-DD HH:MM:SS.

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 17

Figure 1.1 Relation between the WSDL files

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 18

Issue 01 (2013-11-15) Huawei Proprietary and Confidential 19

S-ar putea să vă placă și