Developer Area

root/site/api/schemas/nsp/admin/VirtualFile-1.0.xsd @ 364

Revision 364, 9.2 kB (checked in by nadya, 5 years ago)

update schemas with new copyright, createZone operation amended.

Line 
1<?xml version="1.0" encoding="UTF-8"?>
2
3<!--
4
5  Copyright (c) 2009, Telnic Ltd.
6
7  All rights reserved.
8
9  Redistribution and use in source and binary forms, with or without
10  modification, are permitted provided that the following conditions are met:
11 
12   - Redistributions of source code must retain the above copyright notice,
13     this list of conditions and the following disclaimer.
14   - Redistributions in binary form must reproduce the above copyright notice,
15     this list of conditions and the following disclaimer in the documentation
16     and/or other materials provided with the distribution.
17   - Neither the name of the Telnic Ltd. nor the names of its contributors may
18     be used to endorse or promote products derived from this software without
19     specific prior written permission.
20 
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31  ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 
33-->
34
35<schema
36  xmlns="http://www.w3.org/2001/XMLSchema"
37  xmlns:types="http://xmlns.telnic.org/ws/nsp/admin/virtualfile/types-1.0"
38  targetNamespace="http://xmlns.telnic.org/ws/nsp/admin/virtualfile/types-1.0"
39  elementFormDefault="qualified"
40  attributeFormDefault="unqualified">
41
42  <annotation>
43    <documentation>This schema definition file defines the messages for managing virtual files.</documentation>
44  </annotation> 
45
46  <group name="fileAddressGroup">
47    <annotation>
48      <documentation>Elements required to address a specific file.</documentation>
49    </annotation>
50    <sequence>
51      <element name="partition" type="token">
52        <annotation>
53          <documentation>The partition the file is associated with.</documentation>
54        </annotation>
55      </element>
56      <element name="path">
57        <annotation>
58          <documentation>The full path (including file name) of the file within the specified partition.</documentation>
59        </annotation>
60        <simpleType>
61          <restriction base="string">
62            <minLength value="1"/>
63            <maxLength value="255"/>
64          </restriction>
65        </simpleType>
66      </element>
67    </sequence>
68  </group>
69 
70  <group name="fileContentGroup">
71    <annotation>
72      <documentation>Elements required to denote the contents of a file.</documentation>
73    </annotation>
74    <sequence>
75      <element name="contentType" type="token" minOccurs="0">
76        <annotation>
77          <documentation>The file's content (MIME) type. If missing, the type is derived from the file name extension.</documentation>
78        </annotation>
79      </element>
80      <element name="content" type="base64Binary">
81        <annotation>
82          <documentation>The file's content in binary, base64 encoded form.</documentation>
83        </annotation>
84      </element>
85    </sequence>
86  </group>
87
88  <complexType name="createFileRequestType">
89    <annotation>
90      <documentation>This type describes the content of a create file request.</documentation>
91    </annotation>
92    <sequence>
93      <group ref="types:fileAddressGroup"/>
94      <group ref="types:fileContentGroup"/>
95    </sequence>
96  </complexType>
97   
98  <complexType name="createFileResponseType">
99    <annotation>
100      <documentation>This type describes the content of a create file response.</documentation>
101    </annotation>
102  </complexType>
103 
104  <complexType name="updateFileRequestType">
105    <annotation>
106      <documentation>This type describes the content of an update file request.</documentation>
107    </annotation>
108    <sequence>
109      <group ref="types:fileAddressGroup"/>
110      <group ref="types:fileContentGroup"/>
111    </sequence>
112  </complexType>
113 
114  <complexType name="updateFileResponseType">
115    <annotation>
116      <documentation>This type describes the content of a update file response.</documentation>
117    </annotation>
118  </complexType>
119 
120  <complexType name="deleteFileRequestType">
121    <annotation>
122      <documentation>This type describes the content of a delete file request.</documentation>
123    </annotation>
124    <sequence>
125      <group ref="types:fileAddressGroup"/>
126    </sequence>
127  </complexType>
128 
129  <complexType name="deleteFileResponseType">
130    <annotation>
131      <documentation>This type describes the content of a delete file response.</documentation>
132    </annotation>
133  </complexType>
134
135  <complexType name="getFileRequestType">
136    <annotation>
137      <documentation>This type describes the content of a get file request.</documentation>
138    </annotation>
139    <sequence>
140      <group ref="types:fileAddressGroup"/>
141    </sequence>
142  </complexType>
143 
144  <complexType name="getFileResponseType">
145    <annotation>
146      <documentation>This type describes the content of a get file response.</documentation>
147    </annotation>
148    <sequence>
149      <element name="contentType" type="token">
150        <annotation>
151          <documentation>The file's content (MIME) type.</documentation>
152        </annotation>
153      </element>
154      <element name="modificationDate" type="date">
155        <annotation>
156          <documentation>The date of the file's last modification.</documentation>
157        </annotation>
158      </element>
159      <element name="content" type="base64Binary">
160        <annotation>
161          <documentation>The file's content in binary, base64 encoded form.</documentation>
162        </annotation>
163      </element>
164    </sequence>
165  </complexType>
166 
167  <complexType name="listFilesRequestType">
168    <annotation>
169      <documentation>This type describes the content of a list file request.</documentation>
170    </annotation>
171    <sequence>
172      <element name="partition" type="token">
173        <annotation>
174          <documentation>The partition for which files should be listed.</documentation>
175        </annotation>
176      </element>
177    </sequence>
178  </complexType>
179 
180  <complexType name="listFilesResponseType">
181    <annotation>
182      <documentation>This type describes the content of a list file response.</documentation>
183    </annotation>
184    <sequence>
185      <element name="file" minOccurs="0" maxOccurs="unbounded">
186        <complexType>
187          <sequence>
188            <element name="path" type="string">
189              <annotation>
190                <documentation>The full path (including file name) of the file.</documentation>
191              </annotation>
192            </element>
193            <element name="contentType" type="token">
194              <annotation>
195                <documentation>The file's content (MIME) type.</documentation>
196              </annotation>
197            </element>
198            <element name="modificationDate" type="date">
199              <annotation>
200                <documentation>The date of the file's last modification.</documentation>
201              </annotation>
202            </element>
203          </sequence>
204        </complexType>
205      </element>
206    </sequence>
207  </complexType>
208
209 
210  <!-- top level elements -->
211
212  <element name="createFileRequest" 
213    type="types:createFileRequestType">
214    <annotation>
215      <documentation>A create file request.</documentation>
216    </annotation>
217  </element>
218 
219  <element name="createFileResponse"
220    type="types:createFileResponseType">
221    <annotation>
222      <documentation>A create file response.</documentation>
223    </annotation>
224  </element>
225 
226  <element name="updateFileRequest" 
227    type="types:updateFileRequestType">
228    <annotation>
229      <documentation>An update file request.</documentation>
230    </annotation>
231  </element>
232 
233  <element name="updateFileResponse"
234    type="types:updateFileResponseType">
235    <annotation>
236      <documentation>An update file response.</documentation>
237    </annotation>
238  </element>
239 
240  <element name="deleteFileRequest" 
241    type="types:deleteFileRequestType">
242    <annotation>
243      <documentation>A delete file request.</documentation>
244    </annotation>
245  </element>
246 
247  <element name="deleteFileResponse"
248    type="types:deleteFileResponseType">
249    <annotation>
250      <documentation>A delete file response.</documentation>
251    </annotation>
252  </element>
253 
254  <element name="getFileRequest" 
255    type="types:getFileRequestType">
256    <annotation>
257      <documentation>A get file request.</documentation>
258    </annotation>
259  </element>
260 
261  <element name="getFileResponse"
262    type="types:getFileResponseType">
263    <annotation>
264      <documentation>A get file response.</documentation>
265    </annotation>
266  </element>
267 
268  <element name="listFilesRequest" 
269    type="types:listFilesRequestType">
270    <annotation>
271      <documentation>A list files request.</documentation>
272    </annotation>
273  </element>
274 
275  <element name="listFilesResponse"
276    type="types:listFilesResponseType">
277    <annotation>
278      <documentation>A list files response.</documentation>
279    </annotation>
280  </element>
281 
282</schema>
Note: See TracBrowser for help on using the browser.
Telnic
Search This Site
Partners
Neustar
ICANN
Main site | WHOIS | Sell .tel | FAQ | Archived Site | About Telnic | Contact Us