mms-client 1.10.0__tar.gz → 1.11.1__tar.gz

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.
Files changed (46) hide show
  1. {mms_client-1.10.0 → mms_client-1.11.1}/PKG-INFO +8 -3
  2. {mms_client-1.10.0 → mms_client-1.11.1}/README.md +5 -0
  3. {mms_client-1.10.0 → mms_client-1.11.1}/pyproject.toml +4 -4
  4. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/wsdl/mi-web-service-jbms.wsdl +276 -276
  5. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/wsdl/omi-web-service.wsdl +262 -262
  6. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/xsd/mi-market.xsd +2405 -2395
  7. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/xsd/mi-outbnd-reports.xsd +1554 -1488
  8. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/xsd/mi-report.xsd +379 -379
  9. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/xsd/mpr.xsd +1858 -1816
  10. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/schemas/xsd/omi.xsd +913 -793
  11. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/services/base.py +1 -1
  12. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/services/market.py +122 -0
  13. mms_client-1.11.1/src/mms_client/services/omi.py +117 -0
  14. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/award.py +6 -0
  15. mms_client-1.11.1/src/mms_client/types/bup.py +207 -0
  16. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/market.py +15 -2
  17. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/offer.py +6 -0
  18. mms_client-1.11.1/src/mms_client/types/omi.py +26 -0
  19. mms_client-1.11.1/src/mms_client/types/settlement.py +81 -0
  20. mms_client-1.11.1/src/mms_client/types/surplus_capcity.py +187 -0
  21. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/utils/serialization.py +5 -2
  22. mms_client-1.10.0/src/mms_client/services/omi.py +0 -18
  23. {mms_client-1.10.0 → mms_client-1.11.1}/LICENSE +0 -0
  24. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/__init__.py +0 -0
  25. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/client.py +0 -0
  26. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/py.typed +0 -0
  27. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/security/__init__.py +0 -0
  28. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/security/certs.py +0 -0
  29. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/security/crypto.py +0 -0
  30. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/services/__init__.py +0 -0
  31. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/services/registration.py +0 -0
  32. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/services/report.py +0 -0
  33. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/__init__.py +0 -0
  34. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/base.py +0 -0
  35. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/enums.py +0 -0
  36. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/fields.py +0 -0
  37. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/registration.py +0 -0
  38. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/report.py +0 -0
  39. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/reserve.py +0 -0
  40. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/resource.py +0 -0
  41. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/types/transport.py +0 -0
  42. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/utils/__init__.py +0 -0
  43. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/utils/errors.py +0 -0
  44. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/utils/multipart_transport.py +0 -0
  45. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/utils/plugin.py +0 -0
  46. {mms_client-1.10.0 → mms_client-1.11.1}/src/mms_client/utils/web.py +0 -0
@@ -1,11 +1,11 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mms-client
3
- Version: 1.10.0
3
+ Version: 1.11.1
4
4
  Summary: API client for accessing the MMS
5
5
  Home-page: https://github.com/ElectroRoute-Japan/mms-client
6
6
  Author: Ryan Wood
7
7
  Author-email: ryan.wood@electroroute.co.jp
8
- Requires-Python: >=3.11,<4.0
8
+ Requires-Python: >=3.12,<4.0
9
9
  Classifier: Development Status :: 5 - Production/Stable
10
10
  Classifier: Framework :: Pydantic :: 2
11
11
  Classifier: Framework :: Pytest
@@ -14,8 +14,8 @@ Classifier: License :: OSI Approved :: The Unlicense (Unlicense)
14
14
  Classifier: Natural Language :: English
15
15
  Classifier: Operating System :: OS Independent
16
16
  Classifier: Programming Language :: Python :: 3
17
- Classifier: Programming Language :: Python :: 3.11
18
17
  Classifier: Programming Language :: Python :: 3 :: Only
18
+ Classifier: Programming Language :: Python :: 3.12
19
19
  Classifier: Topic :: Software Development :: Libraries :: Python Modules
20
20
  Classifier: Typing :: Typed
21
21
  Requires-Dist: backoff (>=2.2.1,<3.0.0)
@@ -221,12 +221,17 @@ This client is not complete. Currently, it supports the following endpoints:
221
221
  - MarketQuery_OfferQuery
222
222
  - MarketCancel_OfferCancel
223
223
  - MarketQuery_AwardResultsQuery
224
+ - MarketQuery_SettlementResultsFileListQuery
225
+ - MarketSubmit_BupSubmit
226
+ - MarketQuery_BupQuery
224
227
  - RegistrationSubmit_Resource
225
228
  - RegistrationQuery_Resource
226
229
  - ReportCreateRequest
227
230
  - ReportListRequest
228
231
  - ReportDownloadRequestTrnID
229
232
  - BSP_ResourceList
233
+ - MarketSubmit_RemainingReserveData
234
+ - MarketQuery_RemainingReserveDataQuery
230
235
 
231
236
  We can add support for additional endpoints as time goes on, and independent contribution is, of course, welcome. However, support for attachments is currently limited because none of the endpoints we support currently require them. We have implemented attachment support up to the client level, but we haven't developed an architecture for submitting them through an endpoint yet.
232
237
 
@@ -187,12 +187,17 @@ This client is not complete. Currently, it supports the following endpoints:
187
187
  - MarketQuery_OfferQuery
188
188
  - MarketCancel_OfferCancel
189
189
  - MarketQuery_AwardResultsQuery
190
+ - MarketQuery_SettlementResultsFileListQuery
191
+ - MarketSubmit_BupSubmit
192
+ - MarketQuery_BupQuery
190
193
  - RegistrationSubmit_Resource
191
194
  - RegistrationQuery_Resource
192
195
  - ReportCreateRequest
193
196
  - ReportListRequest
194
197
  - ReportDownloadRequestTrnID
195
198
  - BSP_ResourceList
199
+ - MarketSubmit_RemainingReserveData
200
+ - MarketQuery_RemainingReserveDataQuery
196
201
 
197
202
  We can add support for additional endpoints as time goes on, and independent contribution is, of course, welcome. However, support for attachments is currently limited because none of the endpoints we support currently require them. We have implemented attachment support up to the client level, but we haven't developed an architecture for submitting them through an endpoint yet.
198
203
 
@@ -1,6 +1,6 @@
1
1
  [tool.poetry]
2
2
  name = "mms_client"
3
- version = "v1.10.0"
3
+ version = "v1.11.1"
4
4
  description = "API client for accessing the MMS"
5
5
  authors = ["Ryan Wood <ryan.wood@electroroute.co.jp>"]
6
6
  readme = "README.md"
@@ -15,13 +15,13 @@ classifiers = [
15
15
  "Natural Language :: English",
16
16
  "Operating System :: OS Independent",
17
17
  "Programming Language :: Python :: 3 :: Only",
18
- "Programming Language :: Python :: 3.11",
18
+ "Programming Language :: Python :: 3.12",
19
19
  "Topic :: Software Development :: Libraries :: Python Modules",
20
20
  "Typing :: Typed",
21
21
  ]
22
22
 
23
23
  [tool.poetry.dependencies]
24
- python = "^3.11"
24
+ python = "^3.12"
25
25
  requests = "^2.31.0"
26
26
  zeep = "^4.2.1"
27
27
  requests-pkcs12 = "^1.24"
@@ -39,7 +39,7 @@ pydantic-extra-types = "^2.7.0"
39
39
  black = "^24.2.0"
40
40
  isort = "^5.13.2"
41
41
  mypy = "^1.8.0"
42
- pylint = "^3.1.0"
42
+ pylint = "~3.2.0"
43
43
  xenon = "^0.9.1"
44
44
  pydocstyle = "^6.3.0"
45
45
  pre-commit = "^3.6.2"
@@ -1,276 +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>
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>