1 <?xml version="1.0" encoding="UTF-8"?>
\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
8 <!-- R O U T E L I S T S E R V I C E -->
\r
10 <!-- This file defines the XML Schema for the BroadSoft Application Server -->
\r
11 <!-- Open Client Interface (OCI). -->
\r
12 <!-- ********************************************************************** -->
\r
14 <xs:schema xmlns:xs = "http://www.w3.org/2001/XMLSchema"
\r
17 attributeFormDefault = "qualified"
\r
18 elementFormDefault = "qualified">
\r
20 <xs:import namespace = "C"
\r
21 schemaLocation = "../OCISchemaBASE.xsd"/>
\r
23 <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>
\r
24 <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>
\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
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
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
53 <xs:complexType name="SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">
\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
61 <xs:extension base="core:OCIRequest">
\r
64 </xs:complexContent>
\r
67 <xs:complexType name="SystemRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">
\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
75 <xs:extension base="core:OCIDataResponse">
\r
77 <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>
\r
80 </xs:complexContent>
\r
83 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">
\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
91 <xs:extension base="core:OCIRequest">
\r
93 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
96 </xs:complexContent>
\r
99 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">
\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
106 <xs:complexContent>
\r
107 <xs:extension base="core:OCIDataResponse">
\r
109 <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>
\r
112 </xs:complexContent>
\r
115 <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">
\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
122 <xs:complexContent>
\r
123 <xs:extension base="core:OCIRequest">
\r
125 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
128 </xs:complexContent>
\r
131 <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">
\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
144 <xs:complexContent>
\r
145 <xs:extension base="core:OCIDataResponse">
\r
147 <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>
\r
150 </xs:complexContent>
\r
153 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeAddListRequest">
\r
156 Add number ranges to a service provider.
\r
157 The response is either SuccessResponse or ErrorResponse.
\r
158 </xs:documentation>
\r
160 <xs:complexContent>
\r
161 <xs:extension base="core:OCIRequest">
\r
163 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
164 <xs:element name="numberRange" type="DNRange" minOccurs="0" maxOccurs="unbounded"/>
\r
167 </xs:complexContent>
\r
170 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeDeleteListRequest">
\r
173 Delete number ranges from a service provider.
\r
174 The response is either SuccessResponse or ErrorResponse.
\r
175 </xs:documentation>
\r
177 <xs:complexContent>
\r
178 <xs:extension base="core:OCIRequest">
\r
180 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
181 <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>
\r
184 </xs:complexContent>
\r
187 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeActivateListRequest">
\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
196 <xs:complexContent>
\r
197 <xs:extension base="core:OCIRequest">
\r
199 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
200 <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>
\r
203 </xs:complexContent>
\r
206 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeDeactivateListRequest">
\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
215 <xs:complexContent>
\r
216 <xs:extension base="core:OCIRequest">
\r
218 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
219 <xs:element name="numberRangeStart" type="DN" minOccurs="0" maxOccurs="unbounded"/>
\r
222 </xs:complexContent>
\r
225 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest">
\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
232 <xs:complexContent>
\r
233 <xs:extension base="core:OCIRequest">
\r
235 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
238 </xs:complexContent>
\r
241 <xs:complexType name="ServiceProviderRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse">
\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
248 <xs:complexContent>
\r
249 <xs:extension base="core:OCIDataResponse">
\r
251 <xs:element name="availableNumberRangeTable" type="core:OCITable"/>
\r
254 </xs:complexContent>
\r
257 <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest">
\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
264 <xs:complexContent>
\r
265 <xs:extension base="core:OCIRequest">
\r
267 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
270 </xs:complexContent>
\r
273 <xs:complexType name="EnterpriseRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse">
\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
281 <xs:complexContent>
\r
282 <xs:extension base="core:OCIDataResponse">
\r
284 <xs:element name="availableNumberRangeTable" type="core:OCITable"/>
\r
287 </xs:complexContent>
\r
290 <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListRequest">
\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
297 <xs:complexContent>
\r
298 <xs:extension base="core:OCIRequest">
\r
300 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
301 <xs:element name="groupId" type="GroupId"/>
\r
304 </xs:complexContent>
\r
307 <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetSummaryListResponse">
\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
320 <xs:complexContent>
\r
321 <xs:extension base="core:OCIDataResponse">
\r
323 <xs:element name="numberRangeSummaryTable" type="core:OCITable"/>
\r
326 </xs:complexContent>
\r
329 <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeAssignListRequest">
\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
337 <xs:complexContent>
\r
338 <xs:extension base="core:OCIRequest">
\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
345 </xs:complexContent>
\r
348 <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeUnassignListRequest">
\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
355 <xs:complexContent>
\r
356 <xs:extension base="core:OCIRequest">
\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
363 </xs:complexContent>
\r
366 <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListRequest">
\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
373 <xs:complexContent>
\r
374 <xs:extension base="core:OCIRequest">
\r
376 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
377 <xs:element name="groupId" type="GroupId"/>
\r
380 </xs:complexContent>
\r
383 <xs:complexType name="GroupRouteListEnterpriseTrunkNumberRangeGetAvailableListResponse">
\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
391 <xs:complexContent>
\r
392 <xs:extension base="core:OCIDataResponse">
\r
394 <xs:element name="availableNumberRangeTable" type="core:OCITable"/>
\r
397 </xs:complexContent>
\r
400 <xs:complexType name="UserRouteListGetRequest">
\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
407 <xs:complexContent>
\r
408 <xs:extension base="core:OCIRequest">
\r
410 <xs:element name="userId" type="UserId"/>
\r
413 </xs:complexContent>
\r
416 <xs:complexType name="UserRouteListGetResponse">
\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
424 <xs:complexContent>
\r
425 <xs:extension base="core:OCIDataResponse">
\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
433 </xs:complexContent>
\r
436 <xs:complexType name="UserRouteListModifyRequest">
\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
443 <xs:complexContent>
\r
444 <xs:extension base="core:OCIRequest">
\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
453 </xs:complexContent>
\r
456 <xs:complexType name="ReplacementDNList">
\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
464 <xs:element name="phoneNumber" type="DN" minOccurs="1" maxOccurs="unbounded"/>
\r