Welcome to the "trac"-ing site of soap4r!
[soap4r] [httpclient] [openpgp4u] [pkcs1] [logger] [csv] [vtr]

Ticket #205: symgate.wsdl

File symgate.wsdl, 10.7 kB (added by Simon Detheridge <simon@widgit.com>, 3 years ago)

problem wsdl file

Line 
1 <?xml version="1.0" encoding="utf-8" ?>
2
3 <!--
4     * This is the web service definition file for the Symgate service.
5     *
6     * Mostly this deals with the rendering of, and conversion to CML. CML stands for Concept Markup Language,
7     * and is a very simple HTML-like language capable of conveying enough information about every word in a
8     * document to correctly symbolise it. This facilitates easy transfer of symbol-based information across
9     * the internet.
10     *
11     * It provides several main functions:
12     *     textToCML - converts plain-text to CML.
13     *     cmlToXHTML - renders CML as an XHTML document, or document fragment
14     *     htmlToSimpleHTML - generates a much-simplified version of an HTML fragment or page
15     *     htmlToCML - converts html to CML
16     *     conceptToSymbol - determines symbol information for a specific concept in a CML document
17     *     testXelda - used to test the underlying linguistic engine within Symgate - mostly for developer use
18     -->
19
20 <wsdl:definitions
21         name="SymgateEngine"
22         xmlns="http://www.symgate.com/symgate"
23         xmlns:xsd="http://www.w3.org/2001/XMLSchema"
24         xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
25         xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
26         xmlns:cml="http://www.symgate.com/cml"
27         xmlns:sge="http://www.symgate.com/symgate"
28         targetNamespace="http://www.symgate.com/symgate">
29
30         <wsdl:types>
31
32                 <xsd:schema
33                         targetNamespace="http://www.symgate.com/symgate"
34                         xmlns:cml="http://www.symgate.com/cml"
35                         xmlns:xsd="http://www.w3.org/2001/XMLSchema">
36
37                         <!-- import our CML schema -->
38                         <xsd:import namespace="http://www.symgate.com/cml" schemaLocation="cml.xsd" />
39                        
40                         <!-- specifies whether XHTML is to be output as a document fragment, for use within another XHTML
41                              document,or a complete document -->
42                         <xsd:simpleType name="XHTMLOutputFormat">
43                                 <xsd:restriction base="xsd:string">
44                                         <xsd:enumeration value="FullDocument" />
45                                         <xsd:enumeration value="DocumentFragment" />
46                                 </xsd:restriction>
47                         </xsd:simpleType>
48                        
49                         <!-- Defines a user account and client key for authentication -->
50                         <xsd:complexType name="accountID">
51                                 <xsd:sequence>
52                                         <xsd:element name="account" type="xsd:string" />
53                                         <xsd:element name="key" type="xsd:string" />
54                                 </xsd:sequence>
55                         </xsd:complexType>
56                        
57                         <!-- the options required by the symboliser in order to successfully symbolise. -->
58                         <xsd:complexType name="symboliserParseOptions">
59                                 <xsd:sequence>
60                                         <xsd:element name="englishLanguage" type="cml:language" /> <!-- the dialect for English -->
61                                         <xsd:element name="defaultLanguage" type="cml:language" /> <!-- the default language when we can't detect -->
62                                         <xsd:element name="doDisambiguation" type="xsd:boolean" /> <!-- whether to perform linguistic disambiguation -->
63                                 </xsd:sequence>
64                         </xsd:complexType>
65                        
66                         <!-- the options required for turning CML into a readable form -->
67                         <xsd:complexType name="symboliserRenderOptions">
68                                 <xsd:sequence>
69                                         <xsd:element name="symset" type="cml:symset" /> <!-- the symset for the symbols -->
70                                         <xsd:element name="color" type="cml:symsetcol" /> <!-- the color for the symbols when using black & white -->
71                                 </xsd:sequence>
72                         </xsd:complexType>
73                        
74                         <!-- the required inputs for symbolising text -->
75                         <xsd:complexType name="symboliserTextInput">
76                                 <xsd:sequence>
77                                         <xsd:element name="creds" type="accountID" />
78                                         <xsd:element name="options" type="symboliserParseOptions" />
79                                         <xsd:element name="text" type="xsd:string" />
80                                 </xsd:sequence>
81                         </xsd:complexType>
82                        
83                         <!-- the required inputs for processing html -->
84                         <xsd:complexType name="htmlInput">
85                                 <xsd:sequence>
86                                         <xsd:element name="creds" type="accountID" />
87                                         <xsd:choice>
88                                                 <xsd:element name="documentURI" type="xsd:anyURI" />
89                                                 <xsd:element name="encodedHtml" type="xsd:string" />
90                                         </xsd:choice>
91                                 </xsd:sequence>
92                         </xsd:complexType>
93                        
94                         <!-- the required inputs for symbolising html -->
95                         <xsd:complexType name="symboliserHtmlInput">
96                                 <xsd:complexContent>
97                                         <xsd:extension base="htmlInput">
98                                                 <xsd:sequence>
99                                                         <xsd:element name="options" type="symboliserParseOptions" />
100                                                 </xsd:sequence>
101                                         </xsd:extension>
102                                 </xsd:complexContent>
103                         </xsd:complexType>
104                        
105                         <xsd:element name="textToCMLRequest" type="symboliserTextInput" />
106                        
107                         <xsd:element name="textToCMLResponse" type="cml:cml" />
108                        
109                         <!-- the required inputs for converting a concept to a symbol -->
110                         <xsd:element name="conceptToSymbolRequest">
111                                 <xsd:complexType>
112                                         <xsd:sequence>
113                                                 <xsd:element name="creds" type="accountID" />
114                                                 <xsd:element name="concept" type="cml:conceptcode" />
115                                                 <xsd:element name="options" type="symboliserRenderOptions" />
116                                         </xsd:sequence>
117                                 </xsd:complexType>
118                         </xsd:element>
119                        
120                         <xsd:element name="conceptToSymbolResponse" type="cml:symbol" />
121                        
122                         <xsd:element name="htmlToSimpleXHTMLRequest" type="htmlInput" />
123                        
124                         <xsd:element name="htmlToSimpleXHTMLResponse" type="xsd:string" />
125                        
126                         <xsd:element name="htmlToCMLRequest" type="symboliserHtmlInput" />
127                        
128                         <xsd:element name="htmlToCMLResponse" type="cml:cml" />
129                        
130                         <!-- the required inputs to convert cml to xhtml -->
131                         <xsd:element name="cmlToXHTMLRequest">
132                                 <xsd:complexType>
133                                         <xsd:sequence>
134                                                 <xsd:element name="creds" type="accountID" />
135                                                 <xsd:element name="options" type="symboliserRenderOptions" />
136                                                 <xsd:element name="cml" type="cml:cml" />
137                                                 <xsd:element name="outputformat" type="XHTMLOutputFormat" />
138                                         </xsd:sequence>
139                                 </xsd:complexType>
140                         </xsd:element>
141                        
142                         <xsd:element name="cmlToXHTMLResponse" type="xsd:string" />
143                        
144                         <xsd:element name="testXeldaRequest" type="symboliserTextInput" />
145
146                         <xsd:element name="testXeldaResponse" type="xsd:string" />
147                
148                 </xsd:schema>
149
150         </wsdl:types>
151        
152         <!-- everything beyond this point maps the above inputs to the above functions... You probably don't need
153              to read anything below this line. -->
154
155         <wsdl:message name="textToCMLInput">
156                 <wsdl:part name="request" element="textToCMLRequest" />
157         </wsdl:message>
158
159         <wsdl:message name="textToCMLOutput">
160                 <wsdl:part name="cml" element="textToCMLResponse" />
161         </wsdl:message>
162
163         <wsdl:message name="conceptToSymbolInput">
164                 <wsdl:part name="request" element="conceptToSymbolRequest" />
165         </wsdl:message>
166
167         <wsdl:message name="conceptToSymbolOutput">
168                 <wsdl:part name="symbols" element="conceptToSymbolResponse" />
169         </wsdl:message>
170
171         <wsdl:message name="htmlToSimpleXHTMLInput">
172                 <wsdl:part name="request" element="htmlToSimpleXHTMLRequest" />
173         </wsdl:message>
174
175         <wsdl:message name="htmlToSimpleXHTMLOutput">
176                 <wsdl:part name="encodedxhtml" element="htmlToSimpleXHTMLResponse" />
177         </wsdl:message>
178
179         <wsdl:message name="htmlToCMLInput">
180                 <wsdl:part name="request" element="htmlToCMLRequest" />
181         </wsdl:message>
182
183         <wsdl:message name="htmlToCMLOutput">
184                 <wsdl:part name="cml" element="htmlToCMLResponse" />
185         </wsdl:message>
186
187         <wsdl:message name="cmlToXHTMLInput">
188                 <wsdl:part name="request" element="cmlToXHTMLRequest" />
189         </wsdl:message>
190
191         <wsdl:message name="cmlToXHTMLOutput">
192                 <wsdl:part name="encodedxhtml" element="cmlToXHTMLResponse" />
193         </wsdl:message>
194
195         <wsdl:message name="testXeldaInput">
196                 <wsdl:part name="request" element="testXeldaRequest" />
197         </wsdl:message>
198          
199         <wsdl:message name="testXeldaOutput">
200                 <wsdl:part name="response" element="testXeldaResponse" />
201         </wsdl:message>
202          
203         <wsdl:portType name="symbolisation">
204
205                 <wsdl:operation name="textToCML">
206                         <wsdl:input message="textToCMLInput" />
207                         <wsdl:output message="textToCMLOutput" />
208                 </wsdl:operation>
209
210                 <wsdl:operation name="conceptToSymbol">
211                         <wsdl:input message="conceptToSymbolInput" />
212                         <wsdl:output message="conceptToSymbolOutput" />
213                 </wsdl:operation>
214
215                 <wsdl:operation name="htmlToSimpleXHTML">
216                         <wsdl:input message="htmlToSimpleXHTMLInput" />
217                         <wsdl:output message="htmlToSimpleXHTMLOutput" />
218                 </wsdl:operation>
219
220                 <wsdl:operation name="htmlToCML">
221                         <wsdl:input message="htmlToCMLInput" />
222                         <wsdl:output message="htmlToCMLOutput" />
223                 </wsdl:operation>
224
225                 <wsdl:operation name="cmlToXHTML">
226                         <wsdl:input message="cmlToXHTMLInput" />
227                         <wsdl:output message="cmlToXHTMLOutput" />
228                 </wsdl:operation>
229
230                 <wsdl:operation name="testXelda">
231                         <wsdl:input message="testXeldaInput" />
232                         <wsdl:output message="testXeldaOutput" />
233                 </wsdl:operation>
234
235         </wsdl:portType>
236          
237         <wsdl:binding type="symbolisation" name="symbolisationBinding">
238                 <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" />
239
240                 <wsdl:operation name="textToCML">
241                         <soap:operation soapAction="http://zx81.highlyillogical.org:8080/symgate/textToCML" />
242                        
243                         <wsdl:input>
244                                 <soap:body use="literal" />
245                         </wsdl:input>
246                        
247                         <wsdl:output>
248                                 <soap:body use="literal" />
249                         </wsdl:output>
250                        
251                 </wsdl:operation>
252
253                 <wsdl:operation name="conceptToSymbol">
254                         <soap:operation soapAction="http://zx81.highlyillogical.org:8080/symgate/conceptToSymbol" />
255                        
256                         <wsdl:input>
257                                 <soap:body use="literal" />
258                         </wsdl:input>
259                        
260                         <wsdl:output>
261                                 <soap:body use="literal" />
262                         </wsdl:output>
263                        
264                 </wsdl:operation>
265
266                 <wsdl:operation name="htmlToSimpleXHTML">
267                         <soap:operation soapAction="http://zx81.highlyillogical.org:8080/symgate/htmlToSimpleXHTML" />
268                        
269                         <wsdl:input>
270                                 <soap:body use="literal" />
271                         </wsdl:input>
272                        
273                         <wsdl:output>
274                                 <soap:body use="literal" />
275                         </wsdl:output>
276                        
277                 </wsdl:operation>
278
279                 <wsdl:operation name="htmlToCML">
280                         <soap:operation soapAction="http://zx81.highlyillogical.org:8080/symgate/htmlToCML" />
281                        
282                         <wsdl:input>
283                                 <soap:body use="literal" />
284                         </wsdl:input>
285                        
286                         <wsdl:output>
287                                 <soap:body use="literal" />
288                         </wsdl:output>
289                        
290                 </wsdl:operation>
291
292                 <wsdl:operation name="cmlToXHTML">
293                         <soap:operation soapAction="http://zx81.highlyillogical.org:8080/symgate/cmlToXHTML" />
294                        
295                         <wsdl:input>
296                                 <soap:body use="literal" />
297                         </wsdl:input>
298                        
299                         <wsdl:output>
300                                 <soap:body use="literal" />
301                         </wsdl:output>
302                        
303                 </wsdl:operation>
304
305                 <wsdl:operation name="testXelda">
306                         <soap:operation soapAction="http://zx81.highlyillogical.org:8080/symgate/testXelda" />
307                        
308                         <wsdl:input>
309                                 <soap:body use="literal" />
310                         </wsdl:input>
311                        
312                         <wsdl:output>
313                                 <soap:body use="literal" />
314                         </wsdl:output>
315                        
316                 </wsdl:operation>
317
318         </wsdl:binding>
319
320         <wsdl:service name="symgateEngine">
321                 <wsdl:port name="symbolisation" binding="symbolisationBinding">
322                         <soap:address location="http://zx81.highlyillogical.org:8080/symgate"/>
323                 </wsdl:port>
324         </wsdl:service>
325
326 </wsdl:definitions>