SDP Solution

API Reference (DataSync,

SOAP)

Issue 01

Date 2014-01-04

HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2014. 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: [email protected]

Issue 01 (2014-01-04) Huawei Proprietary and Confidential i

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) Contents

Contents

1 Overview.........................................................................................................................................1
1.1 API Functions....................................................................................................................................................1
1.2 Level of Requirement for Parameters................................................................................................................1
1.3 Request Format..................................................................................................................................................2
1.4 Response Format................................................................................................................................................3
1.5 Namespace.........................................................................................................................................................4
1.6 SOAPAction.......................................................................................................................................................4

2 Interface for Subscription Relationship Synchronization....................................................5

2.1 Process...............................................................................................................................................................5
2.2 SyncOrderRelation.............................................................................................................................................6
2.2.1 API Function.............................................................................................................................................6
2.2.2 Request URI.............................................................................................................................................6
2.2.3 Request.....................................................................................................................................................6
2.2.4 Response.................................................................................................................................................18
2.2.5 Error Codes.............................................................................................................................................18

3 API Error Responses...................................................................................................................20

3.1 Service Error Response....................................................................................................................................20
3.2 Policy Error Response.....................................................................................................................................21

Issue 01 (2014-01-04) Huawei Proprietary and Confidential ii

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Overview

1 Overview

1.1 API Functions

The SDP provides data synchronization capability application programming interfaces (APIs)
for third-party applications (App for short) to connect to it and use its data synchronization
capability to synchronize subscription relationships. App is generally developed by various
partners of the SDP.

Partners are the enterprises and individuals who sign a contract and cooperate with carriers in utilizing
the SDP. Partners include SPs, CPs, Developers, and Enterprises. In this document, partners are mainly
the SPs, Developers, and Enterprises who use APIs for secondary development.

Table 1-1 describes functions of DataSync capability APIs provided by the SDP.

Table 1-1 Functions of DataSync capability APIs

Function Description API

Subscripti The SDP (functioning as the client) invokes an API SyncOrderRelation

on to synchronize subscription relationships to the App
relationshi (functioning as the server).
p Partners must code the App based on the API field
synchroniz requirements so that the App can correctly parse and
ation respond to requests received from the SDP. The App
must send a response to the SDP within 30 seconds.

1.2 Level of Requirement for Parameters

The App must develop APIs based on the level of requirement for each parameter.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 1

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Overview

Table 1-2 Level of requirement for parameters

Type Description

Mandatory A parameter is always mandatory in a request.

Parameters with the Mandatory requirement are used for access
authentication or service processing. If a parameter with the Mandatory
requirement is left empty in a request, access authentication or service
processing fails and the request fails.
Conditional A parameter is mandatory or optional in specified conditions.
Parameters with the Conditional requirement are used for access
authentication or service processing in specified conditions. If the
specified conditions is met but a parameter with the Conditional
requirement is left empty in a request, access authentication or service
processing fails and the request fails.
Optional A parameter is always optional.
Parameters with the Optional requirement are not used for service
processing.

1.3 Request Format

The SDP provides the SOAP request in the following format:
<soapenv:Envelope>
<soapenv:Header>
<parameter>…</parameter>
…
</soapenv:Header>
<soapenv:Body>
<parameter>…</parameter>
…
</soapenv:Body>
</soapenv:Envelope>

Table 1-3 Request format

Element Description

<soapenv:Envel Root element in a request, which specifies the namespace.

ope>
<soapenv:Heade Request header.
r> Parameters in this element are defined by the SDP and are mainly
information to be processed by the SDP services, including access
authentication parameters.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 2

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Overview

Element Description

<soapenv:Body> Request body.

Parameters in this element comply with the SOAP protocol.

When Apps invoke SDP APIs, requests cannot contain the following XML characters: & > < ' "
If the preceding characters are really required, you must add escape characters before such characters.
Otherwise, SDP APIs will fail to be invoked.

1.4 Response Format

Success Response Format
The SDP provides the SOAP API success responses in the following format:
<soapenv:Envelope>
<soapenv:Body>
<parameter>…</parameter>
…
</soapenv:Body>
</soapenv:Envelope>

Table 1-1 Success response format

Element Description

<soapenv:Envel Root element in a success response, which specifies the namespace.

ope>
<soapenv:Body> Success response body.
Parameters in this element comply with the SOAP protocol.

Error Response Format

The SDP provides the SOAP API error responses in the following format:
<soapenv:Envelope>
<soapenv:Body>
<soapenv:Fault>
<parameter>…</parameter>
…

<detail>
<parameter>…</parameter>
…
</detail>
</soapenv:Fault>

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 3

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Overview

</soapenv:Body>
</soapenv:Envelope>

Table 1-1 Error response format

Element Description

<soapenv:Envel Root element in an error response, which specifies the namespace.

ope>
<soapenv:Body> Error response body, contains the <soapenv:Fault> and <detail>
elements. This element specifies the error code and error details.
<soapenv:Fault> Error code and description.
For details about error responses, see 3 API Error Responses.
<detail> Error details, which are the same as the <soapenv:Fault> element
information.

1.5 Namespace
Partners must follow the specified namespaces of data types when developing DataSync
capability APIs.
 Table 1-6 describes the namespaces of DataSync capability APIs.
 The namespace of data types used by the DataSync capability APIs is
http://www.csapi.org/schema/parlayx/data/v1_0.

Table 1-2 Namespaces of DataSync capability APIs

Namespace API

http://www.csapi.org/wsdl/ SyncOrderRelation
parlayx/data/sync/v1_0

1.6 SOAPAction
Leave the SOAPAction parameter empty.
The following is an example of the SOAPAction parameter setting in an HTTP header:
SOAPAction: ""

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 4

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

2 Interface for Subscription Relationship

Synchronization

2.1 Process
When a user subscription relationship is generated or modified on the SDP, the SDP uses the
SyncOrderRelation interface to synchronize the subscription relationship to App.
The SDP uses the SyncOrderRelation interface to synchronize subscription relationships
when:
 A user subscribes to a product on the portal or using an SMS message.
 The carrier subscribes to or unsubscribes from a product for a user.
 Automatic renewal of subscription to a product fails.
 A user unsubscribes from a product on the portal or using an SMS message.
Figure 2-1 shows the process of synchronizing a subscription relationship.

Figure 1-2 Process of synchronizing a subscription relationship to a third party

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 5

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

2.2 SyncOrderRelation
2.2.1 API Function
The SDP (functioning as the client) invokes an API to synchronize subscription relationships
to the App (functioning as the server).
Partners must code the App based on the API field requirements so that the App can correctly
parse and respond to requests received from the SDP. The App must send a response to the
SDP within 30 seconds.

2.2.2 Request URI

The request URI is the destination URI of SyncOrderRelation messages sent by the SDP to
the App. The URI is defined by the App.

2.2.3 Request
The SDP functions as the client and sends a SyncOrderRelationRequest message to the App.

Example
 Subscription example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:syncOrderRelation
xmlns:ns1="http://www.csapi.org/schema/parlayx/data/sync/v1_0/local">
<ns1:userID>
<ID>8619800000001</ID>
<type>0</type>
</ns1:userID>
<ns1:spID>001100</ns1:spID>
<ns1:productID>1000000423</ns1:productID>
<ns1:serviceID>0011002000001100</ns1:serviceID>
<ns1:serviceList>0011002000001100</ns1:serviceList>
<ns1:updateType>1</ns1:updateType>
<ns1:updateTime>20130723082551</ns1:updateTime>
<ns1:updateDesc>Addition</ns1:updateDesc>
<ns1:effectiveTime>20130723082551</ns1:effectiveTime>
<ns1:expiryTime>20361231160000</ns1:expiryTime>
<ns1:extensionInfo>
<item>
<key>accessCode</key>
<value>20086</value>
</item>
<item>
<key>chargeMode</key>
<value>0</value>
</item>
<item>
<key>MDSPSUBEXPMODE</key>
<value>1</value>
</item>

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 6

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

<item>
<key>objectType</key>
<value>1</value>
</item>
<item>
<key>isFreePeriod</key>
<value>false</value>
</item>
<item>
<key>payType</key>
<value>0</value>
</item>
<item>
<key>transactionID</key>
<value>504016000001307231624304170004</value>
</item>
<item>
<key>orderKey</key>
<value>999000000000000194</value>
</item>
<item>
<key>keyword</key>
<value>sub</value>
</item>
<item>
<key>cycleEndTime</key>
<value>20130822160000</value>
</item>
<item>
<key>durationOfGracePeriod</key>
<value>-1</value>
</item>
<item>
<key>serviceAvailability</key>
<value>0</value>
</item>
<item>
<key>channelID</key>
<value>1</value>
</item>
<item>
<key>TraceUniqueID</key>
<value>504016000001307231624304170005</value>
</item>
<item>
<key>operCode</key>
<value>zh</value>
</item>
<item>
<key>rentSuccess</key>
<value>true</value>
</item>
<item>
<key>try</key>
<value>false</value>

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 7

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

</item>
<item>
<key>shortMessage</key>
<value>Hello world.</value>
</item>
</ns1:extensionInfo>
</ns1:syncOrderRelation>
</soapenv:Body>
</soapenv:Envelope>

 Unsubscription example:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:syncOrderRelation
xmlns:ns1="http://www.csapi.org/schema/parlayx/data/sync/v1_0/local">
<ns1:userID>
<ID>8619800000001</ID>
<type>0</type>
</ns1:userID>
<ns1:spID>001100</ns1:spID>
<ns1:productID>1000000423</ns1:productID>
<ns1:serviceID>0011002000001100</ns1:serviceID>
<ns1:serviceList>0011002000001100</ns1:serviceList>
<ns1:updateType>2</ns1:updateType>
<ns1:updateTime>20130723094953</ns1:updateTime>
<ns1:updateDesc>Deletion</ns1:updateDesc>
<ns1:effectiveTime>20130723082551</ns1:effectiveTime>
<ns1:expiryTime>20130723094952</ns1:expiryTime>
<ns1:extensionInfo>
<item>
<key>updateReason</key>
<value>1</value>
</item>
<item>
<key>payType</key>
<value>0</value>
</item>
<item>
<key>transactionID</key>
<value>504016000001307231748315161003</value>
</item>
<item>
<key>orderKey</key>
<value>999000000000000194</value>
</item>
<item>
<key>MDSPSUBEXPMODE</key>
<value>1</value>
</item>
<item>
<key>objectType</key>
<value>1</value>
</item>
<item>

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 8

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

<key>chargeMode</key>
<value>0</value>
</item>
<item>
<key>accessCode</key>
<value>20086</value>
</item>
<item>
<key>keyword</key>
<value>unsub</value>
</item>
<item>
<key>channelID</key>
<value>1</value>
</item>
<item>
<key>TraceUniqueID</key>
<value>504016000001307231748315161006</value>
</item>
<item>
<key>rentSuccess</key>
<value>true</value>
</item>
<item>
<key>try</key>
<value>false</value>
</item>
<item>
<key>shortMessage</key>
<value>Hello world.</value>
</item>
</ns1:extensionInfo>
</ns1:syncOrderRelation>
</soapenv:Body>
</soapenv:Envelope>

Message Header Parameters

None.

Message Body Parameters

Table 2-1 describes parameters in a syncOrderRelationRequest message body.

Table 1-1 Parameters in a SyncOrderRelationRequest message body

Paramete Type Length Level of Description
r Require
ment

userID UserID - Mandatory User ID and user type.

For details, see UserID.
spID String 21 Mandatory ID of the partner to which the product
belongs.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 9

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Paramete Type Length Level of Description

r Require
ment

The ID is automatically allocated by the

SDP to the SP after successful
registration.
To obtain the ID, use the registered
account to log in to the SDP
management portal and query the
account information, or obtain it from
the notification email after successful
registration.
[Example]
000201
productID String 21 Mandatory Product ID.
The ID is automatically allocated by the
SDP when a third party or the carrier
releases a subscribable product.
[Example]
1000000201
serviceID String 21 Mandatory ID of the service to which the product
belongs.
The ID is automatically allocated by the
SDP when a third party releases a
service.
NOTE
When the product is a bundle product, the
value is the Bundle ID.
[Example]
0003042000001075
serviceList String 1024 Optional List of subservice IDs.
The value varies according to the
product type.
 If the product is a bundle product, the
value is IDs of subservices in the
bundle. Separate multiple subservice
IDs by vertical bars (|).
 If the product is a non-bundle product,
the value is the same as the
serviceID value.
[Example]
0003042000001075|0003042000001076
updateTyp int 2 Mandatory Operation type.
e  1: Add
 2: Delete

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 10

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Paramete Type Length Level of Description

r Require
ment
 3: Update
[Example]
1
updateTim String 14 Mandatory Time when the subscription relationship
e is updated (UTC time).
[Format]
yyyyMMddHHmmss
[Example]
20130227000000
updateDes String 255 Optional Description about the update of the
c subscription relationship.
When the extensionInfo field contains
the UpdateReason field, the
UpdateReason field specifies the
subscription relationship update reason.
 UpdateReason =2
− 7698: The
product is automatically
unsubscribed from at the end of
the grace period.
− 7699: The
product is automatically
unsubscribed from at the end of
the suspension period.
 UpdateReason =3
− 7330: The
user account balance is
insufficient.
− 7333: An
internal charging error occurs on
the SDP.
− 7271: The
SDP does not have sufficient
charging information to perform
rating.
− 7999:
Other errors occur.
[Example]
Add a new subscription.
effectiveTi String 14 Optional Time when the subscription relationship
me takes effect (UTC time).
[Format]

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 11

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Paramete Type Length Level of Description

r Require
ment

yyyyMMddHHmmss
[Example]
20130227000000
expiryTim String 14 Optional Time when the subscription relationship
e expires (UTC time).
[Format]
yyyyMMddHHmmss
[Example]
20130327000000
extensionI NamedP - Optional Extended information.
nfo arameter For the NamedParameterList
List information, see Table 2-3.
For the extended fields transmitted by
NamedParameterList, see Table 2-5.

Table 1-2 UserID parameters

Paramete Type Lengt Level of Description
r h Requireme
nt

ID String 30 Mandatory User ID.

If the user is a mobile phone user, this
value is a mobile number containing the
country code.
[Example]
8613012312123
type int 2 Mandatory User type.
 0: mobile phone user.
 10: user fake ID
 11: email user
 18: Internet user (added user type in
the Saudi Arabia Mobily office).
[Example]
0

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 12

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Table 1-3 NamedParameterList parameters

Paramet Type Length Level of Description
er Requirem
ent

item NamedP - Optional Data type corresponding to the extended

arameter field, which consists of key and value.
[0...unbo For the NamedParameters information,
unded ] see Table 2-3.

Table 1-4 NamedParameter parameters

Paramete Type Length Level of Description
r Requirem
ent

key String - Mandatory ID of the extended field.

The value is specified by the SDP.
[Example]
try
value String - Mandatory Value of the key.
[Example]
true

Table 1-5 Extended parameters transmitted in extensionInfo

Key Value

Paramet Type Length Description

er

accessCo String 30 Product access code. The SDP obtains the value during
de subscription relationship synchronization.
When a third party releases a subscribable product on
the SDP management portal, the third party sets product
access code if the product can be subscribed to by SMS
message.
[Example]
1
chargeM int 4 Charging period of the product.
ode The value is set when a third party releases a
subscribable product on the SDP management portal.
 0: month
 10: multiday
 13: multimonth

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 13

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Key Value

Paramet Type Length Description

er
 18: day
 19: week
 20: multiweek
[Example]
0
MDSPS String 1 Expiration mode of a subscription relationship upon
UBEXP unsubscription.
MODE  1: expires immediately
 2: expires next week
[Example]
1
objectTy String 1 Type of the pricing object.
pe  1: Service
 2: Content
 3: Category
 4: Package
[Example]
1
isFreePer boolean - Indicates whether the subscription is repeated during the
iod period free of charge.
 true: yes
 false: no
payType int4 - Payment type.
 0: postpaid user
 1: prepaid user
[Example]
0
transacti String - Transaction ID.
onID The ID is automatically generated by the SDP and is
used only to trace messages during the SDP
commissioning. The SP ignores this parameter.
[Example]
100001200101110623021721000011
orderKey String 20 Subscription relationship key that uniquely identifies a
subscription record.
For services that do not support automatic renewal, each
subscription generates a subscription relationship record

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 14

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Key Value

Paramet Type Length Description

er

and generates a new key.

[Example]
999000000000000194
keyword String 100 Subscription and unsubscription command words.
When a third party releases a subscribable product on
the SDP management portal, the third party sets the
subscription and unsubscription command words if the
product can be subscribed to by SMS message.
If multiple command words are set, the SDP writes any
of them to the request during subscription relationship
synchronization.
[Example]
sub
cycleEnd String 14 End time of the bill cycle (UTC time).
Time [Format]
yyyyMMddHHmmss
[Example]
20130227000000
duration String 4 Grace period of the product.
OfGrace NOTE
Period  This parameter is displayed only when updateType is set to 1
and updateType is set to 3.
 If the grace period is not set, set this parameter to -1.
[Unit]
Day
[Example]
5
updateRe int 4 Update reason.
ason When updateType is set to 2, the possible reasons are as
follows:
 1: A user unsubscribes from a product.
 2: Rental fails to be collected upon subscription
renewal.
 3: Unsubscription is triggered when the charging fails
upon the first subscription.
 4: Unsubscription is triggered when the service status
is abnormal.
 5: Unsubscription is triggered when the user status is
abnormal.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 15

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Key Value

Paramet Type Length Description

er

[Example]
1
serviceA String 10 Indicates whether users can use the service in the grace
vailabilit period.
y  0: yes
 1: no
NOTE
 This parameter is displayed only when updateType is set to 1
and updateType is set to 3.
 If the grace period is not set, set this parameter to -1.
[Example]
0
channelI Int 4 Operation channel.
D  1: web
 2: SMS
 3: USSD
 4: IVR
 5: CC (CRM)
 6: PDA
 7: XHTML (WAP 2) (This value is used in the SDP
baseline version.)
 10: Promotion (This value is used for requests sent by
the Promotion.)
 21: ODP
 99: Other
 100: SP website
 101: UE(User Equipment)
 102: MDSP CC Portal
 105: PCClient
 110: IVR Call Out
 111: SDP Web Tool (CS)
 112: SDP Web Tool (Admin)
 113: SDP Web Tool (CP)
 115: MMS
 120: channel of unsubscription caused by user
deregistration
 124: channel of unsubscription caused by the blacklist
 125: SP website (added channel type in the MTN
project, which is used for subscription on the SP

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 16

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Key Value

Paramet Type Length Description

er

website.)
[Example]
1
TraceUni String 30 Transaction ID.
queID The ID is automatically generated by the SDP and is
used only to trace messages during the SDP
commissioning. The SP ignores this parameter.
[Example]
100001200101110623021721000011
operCod String 40 Operation code.
e This parameter specifies the subscription language type.
 zh
 en
The parameter is automatically set based on the language
selected by the user during subscription on the portal.
[Example]
zh
rentSucc boolean N/A Indicates whether the monthly rental is successfully
ess deducted.
 true: yes
 false: no
This parameter is valid only when updateType is set to
3.
[Example]
true
try boolean N/A Indicates whether the product is in the trial user period.
 true: yes
 false: no
A trial use period can be set when an SP releases a
subscribable product supporting automatic subscription
renewal.
[Example]
true
shortMes String 512 Content of the SMS message or the product command
sage word.
[Example]
Hello world.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 17

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

2.2.4 Response
The App functions as the server, processes SyncOrderRelation messages received from the
SDP, and sends SyncOrderRelationResponse messages to the SDP.
This topic provides a success response example and describes parameters in the response. If a
request fails, the App sends an error response that contains an error code. For details about
error responses, see API Error Responses.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:loc="http://www.csapi.org/schema/parlayx/data/sync/v1_0/local">
<soapenv:Header/>
<soapenv:Body>
<loc:syncOrderRelationResponse>
<loc:result>0</loc:result>
<loc:resultDescription>OK</loc:resultDescription>
</loc:syncOrderRelationResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 2-6 describes parameters in a SyncOrderRelationResponse message body.

Table 1-1 Parameters in a SyncOrderRelationResponse message body

Parameter Type Level of Description
Requirement

result String Mandatory  0: The request succeeds.

 Other values: The request is
abnormal. For the error codes,
see 2.2.5 Error Codes.
resultDescr String Mandatory Description of the subscription
iption relationship synchronization result.
extensionIn NamedParameter Optional Extended parameter.
fo List No extended information.

2.2.5 Error Codes

Table 2-7 describes SyncOrderRelation error codes that the App may return upon an
exception.

Table 1-2 SyncOrderRelation error codes

Error Cause
Code Description

1211 The field format is incorrect or the The Format value is incorrect or in

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 18

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 Interface for Subscription Relationship Synchronization

Error Cause
Code Description

value is invalid. an incorrect format in the body of the

subscription relationship
synchronization request.
2030 The subscription relationship already The subscription relationship already
exists. exists in the SP system.
2031 The subscription relationship does The subscription relationship does
not exist. not exist in the SP system.
2032 The service does not exist. The service to which the product
belongs does not exist.
2033 The service is unavailable. The service to which the product
belongs is in an abnormal status.
2034 The service is unavailable. The service to which the product
belongs cannot be subscribed to.
2500 An internal system error occurred. An internal error occurs in the SP
system.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 19

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 API Error Responses

3 API Error Responses

3.1 Service Error Response

A service error is caused by service operation exceptions irrelevant to policies. When a
service error occurs, the server sends a service error response to the client. This topic provides
a service error response example and describes parameters in the response.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<soapenv:Fault>
<faultcode>SVC0001</faultcode>
<faultstring>Waiting for response timed out, message type is
OutwardGetLocReq</faultstring>
<detail>
<ns1:ServiceException
xmlns:ns1="http://www.csapi.org/schema/parlayx/common/v2_1">
<messageId>SVC0001</messageId>
<text>Waiting for response timed out, message type is
OutwardGetLocReq.</text>
<variables>OutwardGetLocReq</variables>
</ns1:ServiceException>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>

Parameter Description
Table 3-1 describes parameters in a service error response.

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 20

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 API Error Responses

Table 1-1 Parameters in a service error response

Param Type Level of Description
eter Require
ment

faultco xsd:string Mandato Result code.

de ry [Format]
SVCABCD
In the format, SVC identifies a service error response,
and ABCD is a number ranging from 0001 to 9999.
[Example]
SVC0001
faultstri xsd:string Mandato Error description.
ng ry The value can contain the variable %# in definition.
When sending a response, the server replaces the
variable %# with the value of variables.
[Example]
Waiting for response timed out, message type is
OutwardGetLocReq.
messag xsd:string Mandato The value is the same as that of faultcode.
eId ry
text xsd:string Mandato The value is the same as that of faultstring.
ry
variabl xsd:string Optional Value of the variable defined in the value of
es [0..unbou faultstring.
nded] [Example]
OutwardGetLocReq

3.2 Policy Error Response

A policy error is caused by service level agreement (SLA) violation. When a policy error
occurs, the server sends a policy error response to the client. This topic provides a policy error
response example and describes parameters in the response.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<soapenv:Fault>
<faultcode>POL0006</faultcode>
<faultstring>GroupAddr is not supported</faultstring>
<detail>
<ns1:PolicyException

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 21

Copyright © Huawei
Technologies Co., Ltd.
SDP Solution
API Reference (DataSync, SOAP) 1 API Error Responses

xmlns:ns1="http://www.csapi.org/schema/parlayx/common/v2_1">
<messageId>POL0006</messageId>
<text>GroupAddr is not supported</text>
<variables>GroupAddr</variables>
</ns1:PolicyException>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>

Parameter Description
Table 3-2 describes parameters in a policy error response.

Table 1-1 Parameters in a policy error response

Param Type Level of Description
eter Require
ment

faultco xsd:string Mandato Result code.

de ry [Format]
POLABCD
In the format, POL identifies a policy error response,
and ABCD is a number ranging from 0001 to 9999.
[Example]
POL0006
faultstri xsd:string Mandato Error description.
ng ry The value can contain the variable %# in definition.
When sending a response, the server replaces the
variable %# with the value of variables.
[Example]
GroupAddr is not supported
messag xsd:string Mandato The value is the same as that of faultcode.
eId ry
text xsd:string Mandato The value is the same as that of faultstring.
ry
variabl xsd:string Conditio Value of the variable defined in the value of
es [0..unbou nal faultstring.
nded] [Example]
GroupAddr

Issue 01 (2014-01-04) Huawei Proprietary and Confidential 22

Copyright © Huawei
Technologies Co., Ltd.