-
Notifications
You must be signed in to change notification settings - Fork 3
/
CBPInterface_Request1.wsdl
334 lines (334 loc) · 21.5 KB
/
CBPInterface_Request1.wsdl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<?xml version="1.0" encoding="UTF-8"?>
<wsdl:definitions targetNamespace="http://api-v1.gen.mm.vodafone.com/mminterface/request"
xmlns:wsa="http://www.w3.org/2005/08/addressing/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
xmlns:head_xsd="http://www.huawei.com.cn/schema/common/v2_1"
xmlns:tns="http://api-v1.gen.mm.vodafone.com/mminterface/request" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:req="http://api-v1.gen.mm.vodafone.com/mminterface/request">
<wsdl:types>
<xs:schema xmlns:req="http://api-v1.gen.mm.vodafone.com/mminterface/request" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://api-v1.gen.mm.vodafone.com/mminterface/request" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:simpleType name="IdentityType">
<xs:restriction base="xs:integer">
<xs:enumeration value="1000" id="Customer"/>
<xs:enumeration value="2000" id="SPOperator"/>
<xs:enumeration value="3000" id="OrganizationOperator"/>
<xs:enumeration value="5000" id="Organization"/>
<xs:enumeration value="6000" id="Till"/>
<xs:enumeration value="8000" id="SP"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="IdentifierType">
<xs:restriction base="xs:integer">
<xs:enumeration value="1" id="MSISDN"/>
<xs:enumeration value="2" id="TillNumber"/>
<xs:enumeration value="3" id="SPShortCode"/>
<xs:enumeration value="4" id="OrganizationShortCode"/>
<xs:enumeration value="5" id="IdentityID"/>
<xs:enumeration value="6" id="O2CLink"/>
<xs:enumeration value="9" id="SPOperatorCode"/>
<xs:enumeration value="10" id="POSNumber"/>
<xs:enumeration value="11" id="OrganizationOperatorUserName"/>
<xs:enumeration value="12" id="OrganizationOperatorCode"/>
<xs:enumeration value="13" id="VoucherCode"/>
<xs:enumeration value="14" id="SPOperatorUserName"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ParameterType">
<xs:sequence>
<xs:element name="Key" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates a parameter name.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Value" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates a parameter value.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Request">
<xs:sequence>
<xs:element name="Transaction">
<xs:complexType>
<xs:sequence>
<xs:element name="CommandID">
<xs:annotation>
<xs:documentation>The unique identifier of transaction/business operation.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="64"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="LanguageCode" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>It is reserved.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="OriginatorConversationID">
<xs:annotation>
<xs:documentation>The unique identifier of the request message generated by third party. It is used to identify a request between the third party and MM.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="128"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="ConversationID" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The unique identifier generated by MM for a previous request message. It is used to support communication multi-times between the third party and MM for one operation/transaction.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Remark" minOccurs="0">
<xs:annotation>
<xs:documentation>The remark information about this operation.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="255"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="EncryptedParameters" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>It is used to carry the value for the element Parameters which are encrypted.
The value for this parameter should be a CDATA.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Parameters" minOccurs="0">
<xs:annotation>
<xs:documentation>It is used to carry specific parameters for specific transaction or business operation.
If the element EncryptedParameters presents, this parameter should not present.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Parameter" maxOccurs="unbounded">
<xs:complexType>
<xs:complexContent>
<xs:extension base="req:ParameterType"/>
</xs:complexContent>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ReferenceData" minOccurs="0">
<xs:annotation>
<xs:documentation>It is used carry some reference data that MM need not analyze but need to record it into transaction log.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="ReferenceItem" type="req:ParameterType" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Timestamp" type="xs:string">
<xs:annotation>
<xs:documentation>The timestamp generated by the third party. MM just logs it . </xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Identity">
<xs:annotation>
<xs:documentation>This section is used to specify all identities involved in the request</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Caller">
<xs:annotation>
<xs:documentation>It indicates the third party which initiates the request</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="CallerType" type="xs:integer">
<xs:annotation>
<xs:documentation>Indicates the type of the caller:
2-APICaller
3-Other(Reserved)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ThirdPartyID">
<xs:annotation>
<xs:documentation>The unique identifier of a third party system defined in MM. It indicates the third party which initiates the request.</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:maxLength value="20"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Password" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>This security credential of the ThirdPartyID defined in MM. If the password feature for third party is used in MM, then this parameter must be presented in the request message.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="CheckSum" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Currently it is unused. It is reserved for API security .</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ResultURL" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>It indicates the destination URL where MM should send the result message to. If the third party needs MM to send the result, this parameter must be presented in the request message.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="Initiator">
<xs:annotation>
<xs:documentation>It indicates the identity who makes the request</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="IdentifierType" type="req:IdentifierType">
<xs:annotation>
<xs:documentation>It indicates the identifier type of the initiator. The value of this parameter must be a valid identifier type supported by MM.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Identifier" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates the identifier of the initiator. Its value must match the inputted value of the parameter IdentifierType.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="SecurityCredential" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates the security credential of the initiator. Its value must match the inputted value of the parameter IdentifierType.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ShortCode" minOccurs="0">
<xs:annotation>
<xs:documentation>When the initiator is an organization operator, this parameter must be present in the request to indicate which organization the operator belongs to.
If the initiator is not an organization operator, this parameter should not be present.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="PrimaryParty" minOccurs="0">
<xs:annotation>
<xs:documentation>If business operation/action, this element is not present; if transaction, this can be either the debit party or the credit party according to the transaction type.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="IdentifierType" type="req:IdentifierType">
<xs:annotation>
<xs:documentation>It indicates the identifier type of the primary party. The value of this parameter must be a valid identifier type supported by MM and must match the inputted value of the parameter IdentityType.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Identifier" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates the identifier of the primary party. Its value must match the inputted value of the parameter IdentifierType.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ShortCode" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>It is reservedd</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="ReceiverParty" minOccurs="0">
<xs:annotation>
<xs:documentation>If business operation/action, this is the affected party; if transaction, it is the opposite party to the PrimaryParty</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="IdentifierType" type="req:IdentifierType">
<xs:annotation>
<xs:documentation>It indicates the identifier type of the recipient party. The value of this parameter must be a valid identifier type supported by MM.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Identifier" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates the identifier of the recipient party. Its value must match the inputted value of the parameter IdentifierType.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ShortCode" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>When the receiver party is an organization operator or a Till, this parameter must be present in the request to indicate which organization the receiver party belongs to.
If the receiver party is not an organization operator or a Till, this parameter should not be present.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="AccessDevice" minOccurs="0">
<xs:annotation>
<xs:documentation>It indicates the access device which the initiator uses to initiate the request.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="IdentifierType" type="req:IdentifierType">
<xs:annotation>
<xs:documentation>It indicates the identifier type of the access device.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Identifier" type="xs:string">
<xs:annotation>
<xs:documentation>It indicates the identifier of the access device. Its value must match the inputted value of parameter IdentifierType</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="KeyOwner" type="xs:integer">
<xs:annotation>
<xs:documentation>It indicates which Key is used to encrypt the elements Initator.SecurityCredential and the EncryptedParameters.
Its value are enumerated as follows:
1:the API Caller's Key
2:the Initiator's Key
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="request" type="req:Request"/>
</xs:schema>
</wsdl:types>
<wsdl:message name="RequestMessage">
<wsdl:part name="RequestMsg" element="tns:RequestMsg">
</wsdl:part>
</wsdl:message>
<wsdl:message name="ResponseMessage">
<wsdl:part name="ResponseMsg" element="tns:ResponseMsg">
</wsdl:part>
</wsdl:message>
<wsdl:message name="RequestSOAPHeaderMessage">
<wsdl:part name="RequestSOAPHeader" element="head_xsd:RequestSOAPHeader"/>
</wsdl:message>
<wsdl:portType name="RequestMgrPortType">
<wsdl:operation name="GenericAPIRequest">
<wsdl:input message="tns:RequestMessage">
</wsdl:input>
<wsdl:output message="tns:ResponseMessage">
</wsdl:output>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="RequestBinding" type="tns:RequestMgrPortType">
<soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="GenericAPIRequest">
<soap:operation soapAction="" style="document"/>
<wsdl:input>
<soap:header message="tns:RequestSOAPHeaderMessage" part="RequestSOAPHeader" use="literal"/>
<soap:body use="literal" />
</wsdl:input>
<wsdl:output>
<soap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="RequestMgrService">
<wsdl:port name="RequestMgrServicePort" binding="tns:RequestBinding">
<soap:address location="http://api-v1.gen.mm.vodafone.com/mminterface/request" />
</wsdl:port>
</wsdl:service>
</wsdl:definitions>