mms-client 1.0.5__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mms_client/__init__.py +0 -0
- mms_client/client.py +14 -0
- mms_client/py.typed +0 -0
- mms_client/schemas/wsdl/mi-web-service-jbms.wsdl +276 -0
- mms_client/schemas/wsdl/omi-web-service.wsdl +262 -0
- mms_client/schemas/xsd/mi-market.xsd +2395 -0
- mms_client/schemas/xsd/mi-outbnd-reports.xsd +1489 -0
- mms_client/schemas/xsd/mi-report.xsd +379 -0
- mms_client/schemas/xsd/mpr.xsd +1817 -0
- mms_client/schemas/xsd/omi.xsd +793 -0
- mms_client/security/__init__.py +0 -0
- mms_client/security/certs.py +44 -0
- mms_client/security/crypto.py +57 -0
- mms_client/services/__init__.py +0 -0
- mms_client/services/base.py +591 -0
- mms_client/services/market.py +107 -0
- mms_client/services/omi.py +13 -0
- mms_client/services/registration.py +13 -0
- mms_client/services/report.py +13 -0
- mms_client/types/__init__.py +0 -0
- mms_client/types/base.py +272 -0
- mms_client/types/enums.py +18 -0
- mms_client/types/fields.py +153 -0
- mms_client/types/market.py +61 -0
- mms_client/types/offer.py +163 -0
- mms_client/types/transport.py +130 -0
- mms_client/utils/__init__.py +0 -0
- mms_client/utils/errors.py +66 -0
- mms_client/utils/serialization.py +513 -0
- mms_client/utils/web.py +220 -0
- mms_client-1.0.5.dist-info/LICENSE +24 -0
- mms_client-1.0.5.dist-info/METADATA +202 -0
- mms_client-1.0.5.dist-info/RECORD +34 -0
- mms_client-1.0.5.dist-info/WHEEL +4 -0
mms_client/__init__.py
ADDED
|
File without changes
|
mms_client/client.py
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
"""Contains the client layer for communicating with the MMS server."""
|
|
2
|
+
|
|
3
|
+
from mms_client.services.base import BaseClient
|
|
4
|
+
from mms_client.services.market import MarketClientMixin
|
|
5
|
+
from mms_client.services.omi import OMIClientMixin
|
|
6
|
+
from mms_client.services.registration import RegistrationClientMixin
|
|
7
|
+
from mms_client.services.report import ReportClientMixin
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class MmsClient(BaseClient, MarketClientMixin, RegistrationClientMixin, ReportClientMixin, OMIClientMixin):
|
|
11
|
+
"""User client for the MMS server.
|
|
12
|
+
|
|
13
|
+
This class is used to communicate with the MMS server.
|
|
14
|
+
"""
|
mms_client/py.typed
ADDED
|
File without changes
|
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<wsdl:definitions
|
|
3
|
+
name="MiWebService"
|
|
4
|
+
targetNamespace="urn:abb.com:project/mms"
|
|
5
|
+
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
|
|
6
|
+
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
|
|
7
|
+
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
8
|
+
xmlns:xmime="http://www.w3.org/2005/05/xmlmime"
|
|
9
|
+
xmlns:types="urn:abb.com:project/mms/types"
|
|
10
|
+
xmlns:tns="urn:abb.com:project/mms">
|
|
11
|
+
|
|
12
|
+
<wsdl:documentation>
|
|
13
|
+
This is the WSDL for MI based web service.
|
|
14
|
+
History:
|
|
15
|
+
001 01-NOV-2019 RN Initial version.
|
|
16
|
+
002 02-FEB-2020 RM Modified to support Attachment downloads
|
|
17
|
+
ResponseAttInfo and AttachmentType elements updated.
|
|
18
|
+
003 17-MAR-2021 RN Increase max attachment count to 40
|
|
19
|
+
|
|
20
|
+
</wsdl:documentation>
|
|
21
|
+
|
|
22
|
+
<!-- Types -->
|
|
23
|
+
<wsdl:types>
|
|
24
|
+
<xsd:schema targetNamespace="urn:abb.com:project/mms/types"
|
|
25
|
+
xmlns:types="urn:abb.com:project/mms/types">
|
|
26
|
+
|
|
27
|
+
<!-- Request Type -->
|
|
28
|
+
<xsd:simpleType name="RequestType">
|
|
29
|
+
<xsd:annotation>
|
|
30
|
+
<xsd:documentation>
|
|
31
|
+
Identifies the request type. Valid values are:
|
|
32
|
+
|
|
33
|
+
mp.info:
|
|
34
|
+
Market participant outbound information requests
|
|
35
|
+
To be used when querying Market Status, Market Messages or
|
|
36
|
+
the Market Participant Activity Log
|
|
37
|
+
|
|
38
|
+
mp.market:
|
|
39
|
+
Market participant market data requests (submit, query)
|
|
40
|
+
|
|
41
|
+
mp.registration:
|
|
42
|
+
Market participant registration requests
|
|
43
|
+
|
|
44
|
+
mp.report:
|
|
45
|
+
Market participant report requests (report list, report download)
|
|
46
|
+
</xsd:documentation>
|
|
47
|
+
</xsd:annotation>
|
|
48
|
+
<xsd:restriction base="xsd:string">
|
|
49
|
+
<xsd:enumeration value="mp.info" />
|
|
50
|
+
<xsd:enumeration value="mp.market" />
|
|
51
|
+
<xsd:enumeration value="mp.registration" />
|
|
52
|
+
<xsd:enumeration value="mp.report" />
|
|
53
|
+
</xsd:restriction>
|
|
54
|
+
</xsd:simpleType>
|
|
55
|
+
|
|
56
|
+
<xsd:simpleType name="RequestDataType">
|
|
57
|
+
<xsd:annotation>
|
|
58
|
+
<xsd:documentation>
|
|
59
|
+
Identifies the inbound request data type.
|
|
60
|
+
NOTE: JSON is not supported. For future use.
|
|
61
|
+
</xsd:documentation>
|
|
62
|
+
</xsd:annotation>
|
|
63
|
+
<xsd:restriction base="xsd:string">
|
|
64
|
+
<xsd:enumeration value="XML" />
|
|
65
|
+
<xsd:enumeration value="JSON" />
|
|
66
|
+
</xsd:restriction>
|
|
67
|
+
</xsd:simpleType>
|
|
68
|
+
|
|
69
|
+
<!-- Request Digital Signature -->
|
|
70
|
+
<xsd:simpleType name="RequestSignature">
|
|
71
|
+
<xsd:annotation>
|
|
72
|
+
<xsd:documentation>
|
|
73
|
+
Base64 SHA2 hash RSA encrypted digital signature of canonicalized
|
|
74
|
+
XML input file
|
|
75
|
+
http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments
|
|
76
|
+
</xsd:documentation>
|
|
77
|
+
</xsd:annotation>
|
|
78
|
+
<xsd:restriction base="xsd:string">
|
|
79
|
+
<xsd:minLength value="1" />
|
|
80
|
+
<xsd:maxLength value="2048" />
|
|
81
|
+
</xsd:restriction>
|
|
82
|
+
</xsd:simpleType>
|
|
83
|
+
|
|
84
|
+
<!-- Attachment Digital Signature -->
|
|
85
|
+
<xsd:simpleType name="AttachmentSignature">
|
|
86
|
+
<xsd:annotation>
|
|
87
|
+
<xsd:documentation>
|
|
88
|
+
Base64 SHA2 hash RSA encrypted digital signature of non-canonicalized
|
|
89
|
+
attachment file
|
|
90
|
+
</xsd:documentation>
|
|
91
|
+
</xsd:annotation>
|
|
92
|
+
<xsd:restriction base="xsd:string">
|
|
93
|
+
<xsd:minLength value="1" />
|
|
94
|
+
<xsd:maxLength value="2048" />
|
|
95
|
+
</xsd:restriction>
|
|
96
|
+
</xsd:simpleType>
|
|
97
|
+
|
|
98
|
+
<!-- Attachment -->
|
|
99
|
+
<xsd:complexType name="AttachmentType">
|
|
100
|
+
<xsd:sequence>
|
|
101
|
+
<xsd:element name="binaryData" type="xsd:base64Binary"
|
|
102
|
+
minOccurs="0" maxOccurs="1" />
|
|
103
|
+
<xsd:element name="signature" type="types:AttachmentSignature"
|
|
104
|
+
minOccurs="0" maxOccurs="1" />
|
|
105
|
+
<xsd:element name="name" type="xsd:string"
|
|
106
|
+
minOccurs="0" maxOccurs="1" />
|
|
107
|
+
</xsd:sequence>
|
|
108
|
+
</xsd:complexType>
|
|
109
|
+
|
|
110
|
+
<xsd:simpleType name="ResponseDataType">
|
|
111
|
+
<xsd:annotation>
|
|
112
|
+
<xsd:documentation>
|
|
113
|
+
Identifies the outbound response data type.
|
|
114
|
+
NOTE: JSON is not supported. For future use.
|
|
115
|
+
</xsd:documentation>
|
|
116
|
+
</xsd:annotation>
|
|
117
|
+
<xsd:restriction base="xsd:string">
|
|
118
|
+
<xsd:enumeration value="XML" />
|
|
119
|
+
<xsd:enumeration value="HTML" />
|
|
120
|
+
<xsd:enumeration value="CSV" />
|
|
121
|
+
<xsd:enumeration value="JSON" />
|
|
122
|
+
<xsd:enumeration value="TXT" />
|
|
123
|
+
</xsd:restriction>
|
|
124
|
+
</xsd:simpleType>
|
|
125
|
+
|
|
126
|
+
<!-- Input request for Soap Attachment -->
|
|
127
|
+
<xsd:element name="RequestAttInfo">
|
|
128
|
+
<xsd:annotation>
|
|
129
|
+
<xsd:documentation>
|
|
130
|
+
Web Service Request Parameters:
|
|
131
|
+
-------------------------------
|
|
132
|
+
requestType : The type of request.
|
|
133
|
+
adminRole : Indicates, if the request is submitted
|
|
134
|
+
by the ISO administrator.
|
|
135
|
+
requestDataCompressed : Indicates if the inbound request is
|
|
136
|
+
compressed.
|
|
137
|
+
requestDataType : Indicate the type of request
|
|
138
|
+
(XML).
|
|
139
|
+
sendRequestDataOnSuccess : Include request data in the response
|
|
140
|
+
even if it is successful.
|
|
141
|
+
sendResponseDataCompressed : Compress the response payload.
|
|
142
|
+
requestSignature : The digital signature of the
|
|
143
|
+
request payload.
|
|
144
|
+
requestData : The actual request payload.
|
|
145
|
+
|
|
146
|
+
NOTE : requestDataCompressed,
|
|
147
|
+
sendResponseDataCompressed, and
|
|
148
|
+
requestDataType="JSON" are for
|
|
149
|
+
potential future use.
|
|
150
|
+
</xsd:documentation>
|
|
151
|
+
</xsd:annotation>
|
|
152
|
+
<xsd:complexType>
|
|
153
|
+
<xsd:sequence>
|
|
154
|
+
<!-- Request Params -->
|
|
155
|
+
<xsd:element name="requestType"
|
|
156
|
+
type="types:RequestType" minOccurs="1" maxOccurs="1" />
|
|
157
|
+
<xsd:element name="adminRole"
|
|
158
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="false" />
|
|
159
|
+
<xsd:element name="requestDataCompressed"
|
|
160
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="false" />
|
|
161
|
+
<xsd:element name="requestDataType"
|
|
162
|
+
type="types:RequestDataType" minOccurs="1" maxOccurs="1"
|
|
163
|
+
default="XML" />
|
|
164
|
+
<xsd:element name="sendRequestDataOnSuccess"
|
|
165
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="true" />
|
|
166
|
+
<xsd:element name="sendResponseDataCompressed"
|
|
167
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="false" />
|
|
168
|
+
<xsd:element name="requestSignature"
|
|
169
|
+
type="types:RequestSignature" minOccurs="0" maxOccurs="1" />
|
|
170
|
+
<xsd:element name="requestData"
|
|
171
|
+
type="xsd:base64Binary" minOccurs="1" maxOccurs="1" xmime:expectedContentTypes="application/octet-stream" />
|
|
172
|
+
<xsd:element name="attachmentData"
|
|
173
|
+
type="types:AttachmentType" minOccurs="0" maxOccurs="40" />
|
|
174
|
+
|
|
175
|
+
</xsd:sequence>
|
|
176
|
+
</xsd:complexType>
|
|
177
|
+
</xsd:element>
|
|
178
|
+
|
|
179
|
+
<xsd:element name="ResponseAttInfo">
|
|
180
|
+
<xsd:annotation>
|
|
181
|
+
<xsd:documentation>
|
|
182
|
+
Web Service Response:
|
|
183
|
+
---------------------
|
|
184
|
+
success : Indicates if the request is successful.
|
|
185
|
+
warnings : Indicates if there are warnings
|
|
186
|
+
during request processing. Only
|
|
187
|
+
applicable if success is true.
|
|
188
|
+
responseBinary : Indicates if the response is binary data.
|
|
189
|
+
responseCompressed : Indicate if the response is compressed.
|
|
190
|
+
responseDataType : Indicate the response data type,
|
|
191
|
+
XML/HTML/CSV/TXT.
|
|
192
|
+
responseFilename : Filename of the response, if applicable. It
|
|
193
|
+
is set for pre-generated reports.
|
|
194
|
+
responseData : The actual response payload.
|
|
195
|
+
|
|
196
|
+
NOTE : responseCompressed is not supported. It is
|
|
197
|
+
for potential future use.
|
|
198
|
+
</xsd:documentation>
|
|
199
|
+
</xsd:annotation>
|
|
200
|
+
<xsd:complexType>
|
|
201
|
+
<xsd:sequence>
|
|
202
|
+
<xsd:element name="success" type="xsd:boolean"
|
|
203
|
+
minOccurs="1" maxOccurs="1" />
|
|
204
|
+
<xsd:element name="warnings" type="xsd:boolean"
|
|
205
|
+
minOccurs="1" maxOccurs="1" default="false" />
|
|
206
|
+
<xsd:element name="responseBinary" type="xsd:boolean"
|
|
207
|
+
minOccurs="1" maxOccurs="1" default="false" />
|
|
208
|
+
<xsd:element name="responseCompressed" type="xsd:boolean"
|
|
209
|
+
minOccurs="1" maxOccurs="1" default="false" />
|
|
210
|
+
<xsd:element name="responseDataType" type="types:ResponseDataType"
|
|
211
|
+
minOccurs="1" maxOccurs="1" />
|
|
212
|
+
<xsd:element name="responseFilename" type="xsd:string"
|
|
213
|
+
minOccurs="0" maxOccurs="1" />
|
|
214
|
+
<xsd:element name="responseData" type="xsd:base64Binary"
|
|
215
|
+
minOccurs="0" maxOccurs="1" xmime:expectedContentTypes="application/octet-stream" />
|
|
216
|
+
<xsd:element name="attachmentData"
|
|
217
|
+
type="types:AttachmentType" minOccurs="0" maxOccurs="40" />
|
|
218
|
+
</xsd:sequence>
|
|
219
|
+
</xsd:complexType>
|
|
220
|
+
</xsd:element>
|
|
221
|
+
|
|
222
|
+
<xsd:element name="AttachmentInfo" type="types:AttachmentType">
|
|
223
|
+
<xsd:annotation>
|
|
224
|
+
<xsd:documentation>
|
|
225
|
+
Attachment Response definition.
|
|
226
|
+
</xsd:documentation>
|
|
227
|
+
</xsd:annotation>
|
|
228
|
+
</xsd:element>
|
|
229
|
+
|
|
230
|
+
</xsd:schema>
|
|
231
|
+
</wsdl:types>
|
|
232
|
+
|
|
233
|
+
<!-- Messages -->
|
|
234
|
+
<wsdl:message name="submitAttachmentRequest">
|
|
235
|
+
<wsdl:part name="RequestInput" element="types:RequestAttInfo" />
|
|
236
|
+
</wsdl:message>
|
|
237
|
+
|
|
238
|
+
<wsdl:message name="retrieveAttachmentResponse">
|
|
239
|
+
<wsdl:part name="ResponseOutput" element="types:ResponseAttInfo" />
|
|
240
|
+
</wsdl:message>
|
|
241
|
+
|
|
242
|
+
<!-- Port Types -->
|
|
243
|
+
<wsdl:portType name="MiWebService">
|
|
244
|
+
|
|
245
|
+
<wsdl:operation name="submitAttachment">
|
|
246
|
+
<wsdl:input message="tns:submitAttachmentRequest" />
|
|
247
|
+
<wsdl:output message="tns:retrieveAttachmentResponse" />
|
|
248
|
+
</wsdl:operation>
|
|
249
|
+
|
|
250
|
+
</wsdl:portType>
|
|
251
|
+
|
|
252
|
+
<!-- Bindings -->
|
|
253
|
+
<wsdl:binding name="MiWebServiceSOAP" type="tns:MiWebService">
|
|
254
|
+
<soap:binding style="document"
|
|
255
|
+
transport="http://schemas.xmlsoap.org/soap/http" />
|
|
256
|
+
|
|
257
|
+
<!-- For soap file attachment based requests -->
|
|
258
|
+
<wsdl:operation name="submitAttachment">
|
|
259
|
+
<soap:operation soapAction="urn:abb.com:project/mms/submitAttachment" />
|
|
260
|
+
<wsdl:input>
|
|
261
|
+
<soap:body use="literal" />
|
|
262
|
+
</wsdl:input>
|
|
263
|
+
<wsdl:output>
|
|
264
|
+
<soap:body use="literal" />
|
|
265
|
+
</wsdl:output>
|
|
266
|
+
</wsdl:operation>
|
|
267
|
+
|
|
268
|
+
</wsdl:binding>
|
|
269
|
+
|
|
270
|
+
<wsdl:service name="MiWebService">
|
|
271
|
+
<wsdl:port name="MiWebService" binding="tns:MiWebServiceSOAP">
|
|
272
|
+
<soap:address location="http://hostname:port/axis2/services/MiWebService" />
|
|
273
|
+
</wsdl:port>
|
|
274
|
+
</wsdl:service>
|
|
275
|
+
|
|
276
|
+
</wsdl:definitions>
|
|
@@ -0,0 +1,262 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<wsdl:definitions
|
|
3
|
+
name="OmiWebService"
|
|
4
|
+
targetNamespace="urn:ws.web.omi.co.jp"
|
|
5
|
+
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
|
|
6
|
+
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
|
|
7
|
+
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
8
|
+
xmlns:xmime="http://www.w3.org/2005/05/xmlmime"
|
|
9
|
+
xmlns:types="urn:types.ws.web.omi.co.jp"
|
|
10
|
+
xmlns:tns="urn:ws.web.omi.co.jp">
|
|
11
|
+
|
|
12
|
+
<wsdl:documentation>
|
|
13
|
+
This is the WSDL for OMI based web service.
|
|
14
|
+
History:
|
|
15
|
+
001 2021-03-29 Initial version.
|
|
16
|
+
|
|
17
|
+
</wsdl:documentation>
|
|
18
|
+
|
|
19
|
+
<!-- Types -->
|
|
20
|
+
<wsdl:types>
|
|
21
|
+
<xsd:schema targetNamespace="urn:types.ws.web.omi.co.jp"
|
|
22
|
+
xmlns:types="urn:types.ws.web.omi.co.jp">
|
|
23
|
+
|
|
24
|
+
<!-- Request Type -->
|
|
25
|
+
<xsd:simpleType name="RequestType">
|
|
26
|
+
<xsd:annotation>
|
|
27
|
+
<xsd:documentation>
|
|
28
|
+
Identifies the request type. Valid values are:
|
|
29
|
+
|
|
30
|
+
mp.omi:
|
|
31
|
+
OMIに関する各種リクエスト
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
</xsd:documentation>
|
|
35
|
+
</xsd:annotation>
|
|
36
|
+
<xsd:restriction base="xsd:string">
|
|
37
|
+
<xsd:enumeration value="mp.omi" />
|
|
38
|
+
|
|
39
|
+
</xsd:restriction>
|
|
40
|
+
</xsd:simpleType>
|
|
41
|
+
|
|
42
|
+
<xsd:simpleType name="RequestDataType">
|
|
43
|
+
<xsd:annotation>
|
|
44
|
+
<xsd:documentation>
|
|
45
|
+
Identifies the inbound request data type.
|
|
46
|
+
NOTE: JSON is not supported. For future use.
|
|
47
|
+
</xsd:documentation>
|
|
48
|
+
</xsd:annotation>
|
|
49
|
+
<xsd:restriction base="xsd:string">
|
|
50
|
+
<xsd:enumeration value="XML" />
|
|
51
|
+
<xsd:enumeration value="JSON" />
|
|
52
|
+
</xsd:restriction>
|
|
53
|
+
</xsd:simpleType>
|
|
54
|
+
|
|
55
|
+
<!-- Request Digital Signature -->
|
|
56
|
+
<xsd:simpleType name="RequestSignature">
|
|
57
|
+
<xsd:annotation>
|
|
58
|
+
<xsd:documentation>
|
|
59
|
+
Base64 SHA2 hash RSA encrypted digital signature of canonicalized
|
|
60
|
+
XML input file
|
|
61
|
+
http://www.w3.org/TR/2001/REC-xml-c14n-20010315#WithComments
|
|
62
|
+
</xsd:documentation>
|
|
63
|
+
</xsd:annotation>
|
|
64
|
+
<xsd:restriction base="xsd:string">
|
|
65
|
+
<xsd:minLength value="1" />
|
|
66
|
+
<xsd:maxLength value="2048" />
|
|
67
|
+
</xsd:restriction>
|
|
68
|
+
</xsd:simpleType>
|
|
69
|
+
|
|
70
|
+
<!-- Attachment Digital Signature -->
|
|
71
|
+
<xsd:simpleType name="AttachmentSignature">
|
|
72
|
+
<xsd:annotation>
|
|
73
|
+
<xsd:documentation>
|
|
74
|
+
Base64 SHA2 hash RSA encrypted digital signature of non-canonicalized
|
|
75
|
+
attachment file
|
|
76
|
+
</xsd:documentation>
|
|
77
|
+
</xsd:annotation>
|
|
78
|
+
<xsd:restriction base="xsd:string">
|
|
79
|
+
<xsd:minLength value="1" />
|
|
80
|
+
<xsd:maxLength value="2048" />
|
|
81
|
+
</xsd:restriction>
|
|
82
|
+
</xsd:simpleType>
|
|
83
|
+
|
|
84
|
+
<!-- Attachment -->
|
|
85
|
+
<xsd:complexType name="AttachmentType">
|
|
86
|
+
<xsd:sequence>
|
|
87
|
+
<xsd:element name="binaryData" type="xsd:base64Binary"
|
|
88
|
+
minOccurs="0" maxOccurs="1" />
|
|
89
|
+
<xsd:element name="signature" type="types:AttachmentSignature"
|
|
90
|
+
minOccurs="0" maxOccurs="1" />
|
|
91
|
+
<xsd:element name="name" type="xsd:string"
|
|
92
|
+
minOccurs="0" maxOccurs="1" />
|
|
93
|
+
</xsd:sequence>
|
|
94
|
+
</xsd:complexType>
|
|
95
|
+
|
|
96
|
+
<xsd:simpleType name="ResponseDataType">
|
|
97
|
+
<xsd:annotation>
|
|
98
|
+
<xsd:documentation>
|
|
99
|
+
Identifies the outbound response data type.
|
|
100
|
+
NOTE: JSON is not supported. For future use.
|
|
101
|
+
</xsd:documentation>
|
|
102
|
+
</xsd:annotation>
|
|
103
|
+
<xsd:restriction base="xsd:string">
|
|
104
|
+
<xsd:enumeration value="XML" />
|
|
105
|
+
<xsd:enumeration value="HTML" />
|
|
106
|
+
<xsd:enumeration value="CSV" />
|
|
107
|
+
<xsd:enumeration value="JSON" />
|
|
108
|
+
<xsd:enumeration value="TXT" />
|
|
109
|
+
</xsd:restriction>
|
|
110
|
+
</xsd:simpleType>
|
|
111
|
+
|
|
112
|
+
<!-- Input request for Soap Attachment -->
|
|
113
|
+
<xsd:element name="RequestAttInfo">
|
|
114
|
+
<xsd:annotation>
|
|
115
|
+
<xsd:documentation>
|
|
116
|
+
Web Service Request Parameters:
|
|
117
|
+
-------------------------------
|
|
118
|
+
requestType : The type of request.
|
|
119
|
+
adminRole : Indicates, if the request is submitted
|
|
120
|
+
by the ISO administrator.
|
|
121
|
+
requestDataCompressed : Indicates if the inbound request is
|
|
122
|
+
compressed.
|
|
123
|
+
requestDataType : Indicate the type of request
|
|
124
|
+
(XML).
|
|
125
|
+
sendRequestDataOnSuccess : Include request data in the response
|
|
126
|
+
even if it is successful.
|
|
127
|
+
sendResponseDataCompressed : Compress the response payload.
|
|
128
|
+
requestSignature : The digital signature of the
|
|
129
|
+
request payload.
|
|
130
|
+
requestData : The actual request payload.
|
|
131
|
+
|
|
132
|
+
NOTE : requestDataCompressed,
|
|
133
|
+
sendResponseDataCompressed, and
|
|
134
|
+
requestDataType="JSON" are for
|
|
135
|
+
potential future use.
|
|
136
|
+
</xsd:documentation>
|
|
137
|
+
</xsd:annotation>
|
|
138
|
+
<xsd:complexType>
|
|
139
|
+
<xsd:sequence>
|
|
140
|
+
<!-- Request Params -->
|
|
141
|
+
<xsd:element name="requestType"
|
|
142
|
+
type="types:RequestType" minOccurs="1" maxOccurs="1" />
|
|
143
|
+
<xsd:element name="adminRole"
|
|
144
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="false" />
|
|
145
|
+
<xsd:element name="requestDataCompressed"
|
|
146
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="false" />
|
|
147
|
+
<xsd:element name="requestDataType"
|
|
148
|
+
type="types:RequestDataType" minOccurs="1" maxOccurs="1"
|
|
149
|
+
default="XML" />
|
|
150
|
+
<xsd:element name="sendRequestDataOnSuccess"
|
|
151
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="true" />
|
|
152
|
+
<xsd:element name="sendResponseDataCompressed"
|
|
153
|
+
type="xsd:boolean" minOccurs="1" maxOccurs="1" default="false" />
|
|
154
|
+
<xsd:element name="requestSignature"
|
|
155
|
+
type="types:RequestSignature" minOccurs="0" maxOccurs="1" />
|
|
156
|
+
<xsd:element name="requestData"
|
|
157
|
+
type="xsd:base64Binary" minOccurs="1" maxOccurs="1" xmime:expectedContentTypes="application/octet-stream" />
|
|
158
|
+
<xsd:element name="attachmentData"
|
|
159
|
+
type="types:AttachmentType" minOccurs="0" maxOccurs="20" />
|
|
160
|
+
|
|
161
|
+
</xsd:sequence>
|
|
162
|
+
</xsd:complexType>
|
|
163
|
+
</xsd:element>
|
|
164
|
+
|
|
165
|
+
<xsd:element name="ResponseAttInfo">
|
|
166
|
+
<xsd:annotation>
|
|
167
|
+
<xsd:documentation>
|
|
168
|
+
Web Service Response:
|
|
169
|
+
---------------------
|
|
170
|
+
success : Indicates if the request is successful.
|
|
171
|
+
warnings : Indicates if there are warnings
|
|
172
|
+
during request processing. Only
|
|
173
|
+
applicable if success is true.
|
|
174
|
+
responseBinary : Indicates if the response is binary data.
|
|
175
|
+
responseCompressed : Indicate if the response is compressed.
|
|
176
|
+
responseDataType : Indicate the response data type,
|
|
177
|
+
XML/HTML/CSV/TXT.
|
|
178
|
+
responseFilename : Filename of the response, if applicable. It
|
|
179
|
+
is set for pre-generated reports.
|
|
180
|
+
responseData : The actual response payload.
|
|
181
|
+
|
|
182
|
+
NOTE : responseCompressed is not supported. It is
|
|
183
|
+
for potential future use.
|
|
184
|
+
</xsd:documentation>
|
|
185
|
+
</xsd:annotation>
|
|
186
|
+
<xsd:complexType>
|
|
187
|
+
<xsd:sequence>
|
|
188
|
+
<xsd:element name="success" type="xsd:boolean"
|
|
189
|
+
minOccurs="1" maxOccurs="1" />
|
|
190
|
+
<xsd:element name="warnings" type="xsd:boolean"
|
|
191
|
+
minOccurs="1" maxOccurs="1" default="false" />
|
|
192
|
+
<xsd:element name="responseBinary" type="xsd:boolean"
|
|
193
|
+
minOccurs="1" maxOccurs="1" default="false" />
|
|
194
|
+
<xsd:element name="responseCompressed" type="xsd:boolean"
|
|
195
|
+
minOccurs="1" maxOccurs="1" default="false" />
|
|
196
|
+
<xsd:element name="responseDataType" type="types:ResponseDataType"
|
|
197
|
+
minOccurs="1" maxOccurs="1" />
|
|
198
|
+
<xsd:element name="responseFilename" type="xsd:string"
|
|
199
|
+
minOccurs="0" maxOccurs="1" />
|
|
200
|
+
<xsd:element name="responseData" type="xsd:base64Binary"
|
|
201
|
+
minOccurs="0" maxOccurs="1" xmime:expectedContentTypes="application/octet-stream" />
|
|
202
|
+
<xsd:element name="attachmentData"
|
|
203
|
+
type="types:AttachmentType" minOccurs="0" maxOccurs="20" />
|
|
204
|
+
</xsd:sequence>
|
|
205
|
+
</xsd:complexType>
|
|
206
|
+
</xsd:element>
|
|
207
|
+
|
|
208
|
+
<xsd:element name="AttachmentInfo" type="types:AttachmentType">
|
|
209
|
+
<xsd:annotation>
|
|
210
|
+
<xsd:documentation>
|
|
211
|
+
Attachment Response definition.
|
|
212
|
+
</xsd:documentation>
|
|
213
|
+
</xsd:annotation>
|
|
214
|
+
</xsd:element>
|
|
215
|
+
|
|
216
|
+
</xsd:schema>
|
|
217
|
+
</wsdl:types>
|
|
218
|
+
|
|
219
|
+
<!-- Messages -->
|
|
220
|
+
<wsdl:message name="submitAttachmentRequest">
|
|
221
|
+
<wsdl:part name="RequestInput" element="types:RequestAttInfo" />
|
|
222
|
+
</wsdl:message>
|
|
223
|
+
|
|
224
|
+
<wsdl:message name="retrieveAttachmentResponse">
|
|
225
|
+
<wsdl:part name="ResponseOutput" element="types:ResponseAttInfo" />
|
|
226
|
+
</wsdl:message>
|
|
227
|
+
|
|
228
|
+
<!-- Port Types -->
|
|
229
|
+
<wsdl:portType name="OmiWebService">
|
|
230
|
+
|
|
231
|
+
<wsdl:operation name="submitAttachment">
|
|
232
|
+
<wsdl:input message="tns:submitAttachmentRequest" />
|
|
233
|
+
<wsdl:output message="tns:retrieveAttachmentResponse" />
|
|
234
|
+
</wsdl:operation>
|
|
235
|
+
|
|
236
|
+
</wsdl:portType>
|
|
237
|
+
|
|
238
|
+
<!-- Bindings -->
|
|
239
|
+
<wsdl:binding name="OmiWebServiceSOAP" type="tns:OmiWebService">
|
|
240
|
+
<soap:binding style="document"
|
|
241
|
+
transport="http://schemas.xmlsoap.org/soap/http" />
|
|
242
|
+
|
|
243
|
+
<!-- For soap file attachment based requests -->
|
|
244
|
+
<wsdl:operation name="submitAttachment">
|
|
245
|
+
<soap:operation soapAction="urn:ws.web.omi.co.jp:submitAttachment" />
|
|
246
|
+
<wsdl:input>
|
|
247
|
+
<soap:body use="literal" />
|
|
248
|
+
</wsdl:input>
|
|
249
|
+
<wsdl:output>
|
|
250
|
+
<soap:body use="literal" />
|
|
251
|
+
</wsdl:output>
|
|
252
|
+
</wsdl:operation>
|
|
253
|
+
|
|
254
|
+
</wsdl:binding>
|
|
255
|
+
|
|
256
|
+
<wsdl:service name="OmiWebService">
|
|
257
|
+
<wsdl:port name="OmiWebService" binding="tns:OmiWebServiceSOAP">
|
|
258
|
+
<soap:address location="http://hostname:port/axis2/services/OmiWebService" />
|
|
259
|
+
</wsdl:port>
|
|
260
|
+
</wsdl:service>
|
|
261
|
+
|
|
262
|
+
</wsdl:definitions>
|