initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceRouteList.xsd
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 \r
3 <!-- ********************************************************************** -->\r
4 <!-- Copyright (c) 2000-2012 BroadSoft, Inc.  All rights reserved.          -->\r
5 <!-- ********************************************************************** -->\r
6 <!-- O C I   X M L   S C H E M A  :  S E R V I C E  P A R T                 -->\r
7 <!--                                                                        -->\r
8 <!-- R O U T E   L I S T  S E R V I C E                                     -->\r
9 <!--                                                                        -->\r
10 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
11 <!-- Open Client Interface (OCI).                                           -->\r
12 <!-- ********************************************************************** -->\r
13 \r
14 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
15            xmlns:core           = "C"\r
16            xmlns                = ""\r
17            attributeFormDefault = "qualified"\r
18            elementFormDefault   = "qualified">\r
19   \r
20   <xs:import namespace      = "C"\r
21              schemaLocation = "../OCISchemaBASE.xsd"/>\r
22   \r
23   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
24   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
25   \r
26   <!-- ********************************************************************************** -->\r
27   <!-- R O U T E   L I S T    R E Q U E S T S  A N D  R E S P O N S E S                   -->\r
28   <!-- ********************************************************************************** -->\r
29   <!--\r
30   Requests and responses are listed here in alphabetical order.\r
31   The non-primitive attributes inside the commands are defined in another\r
32   section of the schema.\r
33 \r
34   Requests in this schema file:\r
35     SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest    \r
36     ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest    \r
37     EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest    \r
38     ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest    \r
39     ServiceProviderRouteListEnterpriseTrunkNumberRangeDeleteListRequest    \r
40     ServiceProviderRouteListEnterpriseTrunkNumberRangeActivateListRequest    \r
41     ServiceProviderRouteListEnterpriseTrunkNumberRangeDeactivateListRequest    \r
42     ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest    \r
43     EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest    \r
44     GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest    \r
45     GroupRouteListEnterpriseTrunkNumberRangeAssignListRequest    \r
46     GroupRouteListEnterpriseTrunkNumberRangeUnassignListRequest    \r
47     GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest    \r
48     UserRouteListGetRequest    \r
49     UserRouteListModifyRequest    \r
50     \r
51   --> \r
52   \r
53   <xs:complexType name="SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">\r
54     <xs:annotation>\r
55       <xs:documentation>\r
56         Request a summary table of all enterprise trunk number ranges in the system.\r
57         The response is either SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse.\r
58       </xs:documentation>\r
59     </xs:annotation>\r
60     <xs:complexContent>\r
61       <xs:extension base="core:OCIRequest">\r
62         <xs:sequence/>\r
63       </xs:extension>\r
64     </xs:complexContent>\r
65   </xs:complexType>    \r
66     \r
67   <xs:complexType name="SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">\r
68     <xs:annotation>\r
69       <xs:documentation>\r
70         Response to SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest.\r
71         The column headings are "Number Range Start", "Number Range End", "Service Provider Id", "Is Enterprise", "User Id", "Enterprise Trunk" and "Is Active".\r
72       </xs:documentation>\r
73     </xs:annotation>\r
74     <xs:complexContent>\r
75       <xs:extension base="core:OCIDataResponse">\r
76         <xs:sequence>\r
77           <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>\r
78         </xs:sequence>\r
79       </xs:extension>\r
80     </xs:complexContent>\r
81   </xs:complexType>    \r
82     \r
83   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">\r
84     <xs:annotation>\r
85       <xs:documentation>\r
86         Request a summary table of all enterprise trunk number ranges in the service provider.\r
87         The response is either ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse.\r
88       </xs:documentation>\r
89     </xs:annotation>\r
90     <xs:complexContent>\r
91       <xs:extension base="core:OCIRequest">\r
92         <xs:sequence>\r
93           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
94         </xs:sequence>\r
95       </xs:extension>\r
96     </xs:complexContent>\r
97   </xs:complexType>    \r
98     \r
99   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">\r
100     <xs:annotation>\r
101       <xs:documentation>\r
102         Response to ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest.\r
103         The column headings are "Number Range Start", "Number Range End", "Group Id" and "Is Active".\r
104       </xs:documentation>\r
105     </xs:annotation>\r
106     <xs:complexContent>\r
107       <xs:extension base="core:OCIDataResponse">\r
108         <xs:sequence>\r
109           <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>\r
110         </xs:sequence>\r
111       </xs:extension>\r
112     </xs:complexContent>\r
113   </xs:complexType>    \r
114     \r
115   <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">\r
116     <xs:annotation>\r
117       <xs:documentation>\r
118         Request a summary table of all enterprise trunk number ranges in the enterprise.\r
119         The response is either EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse.\r
120       </xs:documentation>\r
121     </xs:annotation>\r
122     <xs:complexContent>\r
123       <xs:extension base="core:OCIRequest">\r
124         <xs:sequence>\r
125           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
126         </xs:sequence>\r
127       </xs:extension>\r
128     </xs:complexContent>\r
129   </xs:complexType>    \r
130     \r
131   <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">\r
132     <xs:annotation>\r
133       <xs:documentation>\r
134         Response to EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest.\r
135         The response contains a table with columns: "Number Range Start", "Number Range End", "Group Id", "User Id", \r
136         "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", \r
137         "Email Address", "Enterprise Trunk" and "Is Active".\r
138         The "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", \r
139         "Extension", "Department" and "Email Address" columns contains the corresponding attributes of the user possessing the number range. \r
140         The "Enterprise Trunk" column contains the enterprise trunk the user possessing the number range belongs to. \r
141         The "Is Active" column indicates if the number range has been activated.  \r
142       </xs:documentation>\r
143     </xs:annotation>\r
144     <xs:complexContent>\r
145       <xs:extension base="core:OCIDataResponse">\r
146         <xs:sequence>\r
147           <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>\r
148         </xs:sequence>\r
149       </xs:extension>\r
150     </xs:complexContent>\r
151   </xs:complexType>    \r
152     \r
153   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest">\r
154     <xs:annotation>\r
155       <xs:documentation>\r
156         Add number ranges to a service provider.\r
157         The response is either SuccessResponse or ErrorResponse.\r
158       </xs:documentation>\r
159     </xs:annotation>\r
160     <xs:complexContent>\r
161       <xs:extension base="core:OCIRequest">\r
162         <xs:sequence>\r
163           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
164           <xs:element name="numberRange" type="DNRange" minOccurs="0" maxOccurs="unbounded"/>\r
165         </xs:sequence>\r
166       </xs:extension>\r
167     </xs:complexContent>\r
168   </xs:complexType>    \r
169     \r
170   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeDeleteListRequest">\r
171     <xs:annotation>\r
172       <xs:documentation>\r
173         Delete number ranges from a service provider.\r
174         The response is either SuccessResponse or ErrorResponse.\r
175       </xs:documentation>\r
176     </xs:annotation>\r
177     <xs:complexContent>\r
178       <xs:extension base="core:OCIRequest">\r
179         <xs:sequence>\r
180           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
181           <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>\r
182         </xs:sequence>\r
183       </xs:extension>\r
184     </xs:complexContent>\r
185   </xs:complexType>    \r
186     \r
187   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeActivateListRequest">\r
188     <xs:annotation>\r
189       <xs:documentation>\r
190         Activate number ranges in a service provider.\r
191         It is not an error to activate an already activated number range. \r
192         The command fails if executed when system level enterprise trunk number range activation is disabled.\r
193         The response is either SuccessResponse or ErrorResponse.\r
194       </xs:documentation>\r
195     </xs:annotation>\r
196     <xs:complexContent>\r
197       <xs:extension base="core:OCIRequest">\r
198         <xs:sequence>\r
199           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
200           <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>\r
201         </xs:sequence>\r
202       </xs:extension>\r
203     </xs:complexContent>\r
204   </xs:complexType>    \r
205     \r
206   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeDeactivateListRequest">\r
207     <xs:annotation>\r
208       <xs:documentation>\r
209         Deactivate number ranges in a service provider.\r
210         It is not an error to deactivate an already deactivated number range. \r
211         The command fails if executed when system level enterprise trunk number range activation is disabled.\r
212         The response is either SuccessResponse or ErrorResponse.\r
213       </xs:documentation>\r
214     </xs:annotation>\r
215     <xs:complexContent>\r
216       <xs:extension base="core:OCIRequest">\r
217         <xs:sequence>\r
218           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
219           <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>\r
220         </xs:sequence>\r
221       </xs:extension>\r
222     </xs:complexContent>\r
223   </xs:complexType>    \r
224     \r
225   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest">\r
226     <xs:annotation>\r
227       <xs:documentation>\r
228         Request a list of available number ranges not yet assigned to any group.\r
229         The response is either ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse or ErrorResponse.\r
230       </xs:documentation>\r
231     </xs:annotation>\r
232     <xs:complexContent>\r
233       <xs:extension base="core:OCIRequest">\r
234         <xs:sequence>\r
235           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
236         </xs:sequence>\r
237       </xs:extension>\r
238     </xs:complexContent>\r
239   </xs:complexType>    \r
240     \r
241   <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse">\r
242     <xs:annotation>\r
243       <xs:documentation>\r
244         Response to ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest. Contains a list of available number ranges not yet assigned to any group.\r
245         The column headings are "Number Range Start", "Number Range End" and "Is Active".\r
246       </xs:documentation>\r
247     </xs:annotation>\r
248     <xs:complexContent>\r
249       <xs:extension base="core:OCIDataResponse">\r
250         <xs:sequence>\r
251           <xs:element name="availableNumberRangeTable" type="core:OCITable"/>\r
252         </xs:sequence>\r
253       </xs:extension>\r
254     </xs:complexContent>\r
255   </xs:complexType>    \r
256     \r
257   <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest">\r
258     <xs:annotation>\r
259       <xs:documentation>\r
260         Request a list of number ranges that are assigned to an enterprise and still available for assignment to users within the enterprise. \r
261         The response is either EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse or ErrorResponse.\r
262       </xs:documentation>\r
263     </xs:annotation>\r
264     <xs:complexContent>\r
265       <xs:extension base="core:OCIRequest">\r
266         <xs:sequence>\r
267           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
268         </xs:sequence>\r
269       </xs:extension>\r
270     </xs:complexContent>\r
271   </xs:complexType>    \r
272     \r
273   <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse">\r
274     <xs:annotation>\r
275       <xs:documentation>\r
276         Response to EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest.\r
277         Contains a list of number ranges that are assigned to an enterprise and still available for assignment to users within the enterprise.\r
278         The column headings are "Number Range Start", "Number Range End" and "Is Active".\r
279       </xs:documentation>\r
280     </xs:annotation>\r
281     <xs:complexContent>\r
282       <xs:extension base="core:OCIDataResponse">\r
283         <xs:sequence>\r
284           <xs:element name="availableNumberRangeTable" type="core:OCITable"/>\r
285         </xs:sequence>\r
286       </xs:extension>\r
287     </xs:complexContent>\r
288   </xs:complexType>    \r
289     \r
290   <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">\r
291     <xs:annotation>\r
292       <xs:documentation>\r
293         Get the list of assigned and unassigned enterprise trunknumber ranges in a group.\r
294         The response is either GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse or ErrorResponse.\r
295       </xs:documentation>\r
296     </xs:annotation>\r
297     <xs:complexContent>\r
298       <xs:extension base="core:OCIRequest">\r
299         <xs:sequence>\r
300           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
301           <xs:element name="groupId" type="GroupId"/>\r
302         </xs:sequence>\r
303       </xs:extension>\r
304     </xs:complexContent>\r
305   </xs:complexType>    \r
306     \r
307   <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">\r
308     <xs:annotation>\r
309       <xs:documentation>\r
310         Response to GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest.\r
311         The response contains a table with columns: "Number Range Start", "Number Range End", "User Id", \r
312         "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension",  \r
313         "Department", "Email Address", "Enterprise Trunk" and "Is Active".\r
314         The "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number",  \r
315         "Extension", "Department" and "Email Address" columns contains the corresponding attributes of the user possessing the number range. \r
316         The "Enterprise Trunk" column contains the enterprise trunk the user possessing the number range belongs to. \r
317         The "Is Active" column indicates if the number range has been activated.  \r
318       </xs:documentation>\r
319     </xs:annotation>\r
320     <xs:complexContent>\r
321       <xs:extension base="core:OCIDataResponse">\r
322         <xs:sequence>\r
323           <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>\r
324         </xs:sequence>\r
325       </xs:extension>\r
326     </xs:complexContent>\r
327   </xs:complexType>    \r
328     \r
329   <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeAssignListRequest">\r
330     <xs:annotation>\r
331       <xs:documentation>\r
332         Assign a list of service provider number ranges to a group.\r
333         The number ranges must have previously been added to the service provider.\r
334         The response is either SuccessResponse or ErrorResponse.\r
335       </xs:documentation>\r
336     </xs:annotation>\r
337     <xs:complexContent>\r
338       <xs:extension base="core:OCIRequest">\r
339         <xs:sequence>\r
340           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
341           <xs:element name="groupId" type="GroupId"/>\r
342           <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>\r
343         </xs:sequence>\r
344       </xs:extension>\r
345     </xs:complexContent>\r
346   </xs:complexType>    \r
347     \r
348   <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeUnassignListRequest">\r
349     <xs:annotation>\r
350       <xs:documentation>\r
351         Unassign a list of service provider number ranges from a group. The number ranges then become available for assignment to other groups.\r
352         The response is either SuccessResponse or ErrorResponse.\r
353       </xs:documentation>\r
354     </xs:annotation>\r
355     <xs:complexContent>\r
356       <xs:extension base="core:OCIRequest">\r
357         <xs:sequence>\r
358           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
359           <xs:element name="groupId" type="GroupId"/>\r
360           <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>\r
361         </xs:sequence>\r
362       </xs:extension>\r
363     </xs:complexContent>\r
364   </xs:complexType>    \r
365     \r
366   <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest">\r
367     <xs:annotation>\r
368       <xs:documentation>\r
369         Request a list of number ranges that are assigned to a group and still available for assignment to users within the group. \r
370         The response is either GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse or ErrorResponse.\r
371       </xs:documentation>\r
372     </xs:annotation>\r
373     <xs:complexContent>\r
374       <xs:extension base="core:OCIRequest">\r
375         <xs:sequence>\r
376           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
377           <xs:element name="groupId" type="GroupId"/>\r
378         </xs:sequence>\r
379       </xs:extension>\r
380     </xs:complexContent>\r
381   </xs:complexType>    \r
382     \r
383   <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse">\r
384     <xs:annotation>\r
385       <xs:documentation>\r
386         Response to GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest.\r
387         Contains a list of number ranges that are assigned to a group and still available for assignment to users within the group.\r
388         The column headings are "Number Range Start", "Number Range End" and "Is Active".\r
389       </xs:documentation>\r
390     </xs:annotation>\r
391     <xs:complexContent>\r
392       <xs:extension base="core:OCIDataResponse">\r
393         <xs:sequence>\r
394           <xs:element name="availableNumberRangeTable" type="core:OCITable"/>\r
395         </xs:sequence>\r
396       </xs:extension>\r
397     </xs:complexContent>\r
398   </xs:complexType>    \r
399     \r
400   <xs:complexType name="UserRouteListGetRequest">\r
401     <xs:annotation>\r
402       <xs:documentation>\r
403         Get the route list setting and the list of number ranges assigned to a user.\r
404         The response is either UserRouteListGetResponse or ErrorResponse.\r
405       </xs:documentation>\r
406     </xs:annotation>\r
407     <xs:complexContent>\r
408       <xs:extension base="core:OCIRequest">\r
409         <xs:sequence>\r
410           <xs:element name="userId" type="UserId"/>\r
411         </xs:sequence>\r
412       </xs:extension>\r
413     </xs:complexContent>\r
414   </xs:complexType>    \r
415     \r
416   <xs:complexType name="UserRouteListGetResponse">\r
417     <xs:annotation>\r
418       <xs:documentation>\r
419         Response to UserRouteListGetRequest.\r
420         Contains the route list setting and a list of assigned number ranges.\r
421         The column headings for assignedNumberRangeTable are "Number Range Start", "Number Range End" and "Is Active".\r
422       </xs:documentation>\r
423     </xs:annotation>\r
424     <xs:complexContent>\r
425       <xs:extension base="core:OCIDataResponse">\r
426         <xs:sequence>\r
427           <xs:element name="treatOriginationsAndPBXRedirectionsAsScreened" type="xs:boolean"/>\r
428           <xs:element name="useRouteListIdentityForNonEmergencyCalls" type="xs:boolean"/>\r
429           <xs:element name="useRouteListIdentityForEmergencyCalls" type="xs:boolean"/>\r
430           <xs:element name="assignedNumberRangeTable" type="core:OCITable"/>\r
431         </xs:sequence>\r
432       </xs:extension>\r
433     </xs:complexContent>\r
434   </xs:complexType>    \r
435     \r
436   <xs:complexType name="UserRouteListModifyRequest">\r
437     <xs:annotation>\r
438       <xs:documentation>\r
439         Modify the route list setting and the list of number ranges assigned to a user.\r
440         The response is either SuccessResponse or ErrorResponse.\r
441       </xs:documentation>\r
442     </xs:annotation>\r
443     <xs:complexContent>\r
444       <xs:extension base="core:OCIRequest">\r
445         <xs:sequence>\r
446           <xs:element name="userId" type="UserId"/>\r
447           <xs:element name="treatOriginationsAndPBXRedirectionsAsScreened" type="xs:boolean" minOccurs="0"/>\r
448           <xs:element name="useRouteListIdentityForNonEmergencyCalls" type="xs:boolean" minOccurs="0"/>\r
449           <xs:element name="useRouteListIdentityForEmergencyCalls" type="xs:boolean" minOccurs="0"/>\r
450           <xs:element name="assignedNumberRangeStartList" type="ReplacementDNList" nillable="true" minOccurs="0"/>\r
451         </xs:sequence>\r
452       </xs:extension>\r
453     </xs:complexContent>\r
454   </xs:complexType>    \r
455     \r
456   <xs:complexType name="ReplacementDNList">\r
457     <xs:annotation>\r
458       <xs:documentation>\r
459         A list of dns that replaces a previously configured list.\r
460         By convention, an element of this type may be set nill to clear the list.\r
461       </xs:documentation>\r
462     </xs:annotation>\r
463     <xs:sequence>\r
464       <xs:element name="phoneNumber" type="DN" minOccurs="1" maxOccurs="unbounded"/>\r
465     </xs:sequence>\r
466   </xs:complexType>    \r
467     \r
468 </xs:schema>\r