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 <!-- B R O A D W O R K S A N Y W H E R E 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
25 <!-- ********************************************************************************** -->
\r
26 <!-- B R O A D W O R K S A N Y W H E R E -->
\r
27 <!-- 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 GroupBroadWorksAnywhereAddInstanceRequest
\r
36 GroupBroadWorksAnywhereDeleteInstanceRequest
\r
37 GroupBroadWorksAnywhereGetInstanceListRequest
\r
38 GroupBroadWorksAnywhereGetInstanceRequest19sp1
\r
39 GroupBroadWorksAnywhereModifyActiveInstanceListRequest
\r
40 GroupBroadWorksAnywhereModifyInstanceRequest
\r
41 UserBroadWorksAnywhereAddPhoneNumberRequest
\r
42 UserBroadWorksAnywhereAddSelectiveCriteriaRequest16
\r
43 UserBroadWorksAnywhereDeletePhoneNumberRequest
\r
44 UserBroadWorksAnywhereDeleteSelectiveCriteriaRequest
\r
45 UserBroadWorksAnywhereGetAvailablePortalListRequest
\r
46 UserBroadWorksAnywhereGetPhoneNumberRequest
\r
47 UserBroadWorksAnywhereGetRequest16sp2
\r
48 UserBroadWorksAnywhereGetSelectiveCriteriaRequest21
\r
49 UserBroadWorksAnywhereModifyPhoneNumberRequest
\r
50 UserBroadWorksAnywhereModifyRequest
\r
51 UserBroadWorksAnywhereModifySelectiveCriteriaRequest
\r
55 <xs:complexType name="GroupBroadWorksAnywhereAddInstanceRequest">
\r
58 Add a BroadWorks Anywhere instance to a group.
\r
59 The domain is required in the serviceUserId.
\r
60 The response is either SuccessResponse or ErrorResponse.
\r
64 <xs:extension base="core:OCIRequest">
\r
66 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
67 <xs:element name="groupId" type="GroupId"/>
\r
68 <xs:element name="serviceUserId" type="UserId"/>
\r
69 <xs:element name="serviceInstanceProfile" type="ServiceInstanceAddProfile"/>
\r
70 <xs:element name="broadWorksAnywhereScope" type="BroadWorksAnywhereScope"/>
\r
71 <xs:element name="promptForCLID" type="BroadWorksAnywhereCLIDPrompt"/>
\r
72 <xs:element name="silentPromptMode" type="xs:boolean"/>
\r
73 <xs:element name="promptForPasscode" type="xs:boolean"/>
\r
74 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
77 </xs:complexContent>
\r
80 <xs:complexType name="GroupBroadWorksAnywhereDeleteInstanceRequest">
\r
83 Delete a BroadWorks Anywhere instance from a group.
\r
84 The response is either SuccessResponse or ErrorResponse.
\r
88 <xs:extension base="core:OCIRequest">
\r
90 <xs:element name="serviceUserId" type="UserId"/>
\r
93 </xs:complexContent>
\r
96 <xs:complexType name="GroupBroadWorksAnywhereGetInstanceListRequest">
\r
99 Get a list of BroadWorks Anywhere instances within a group.
\r
100 The response is either GroupBroadWorksAnywhereGetInstanceListResponse or ErrorResponse.
\r
101 It is possible to get the instances within a specified department.
\r
102 </xs:documentation>
\r
104 <xs:complexContent>
\r
105 <xs:extension base="core:OCIRequest">
\r
107 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
108 <xs:element name="groupId" type="GroupId"/>
\r
109 <xs:element name="groupDepartmentName" type="DepartmentName" minOccurs="0"/>
\r
112 </xs:complexContent>
\r
115 <xs:complexType name="GroupBroadWorksAnywhereGetInstanceListResponse">
\r
118 Response to the GroupBroadWorksAnywhereGetInstanceListRequest.
\r
119 Contains a table with column headings:
\r
120 "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active".
\r
121 The column value for "Is Active" can either be true, or false.
\r
122 </xs:documentation>
\r
124 <xs:complexContent>
\r
125 <xs:extension base="core:OCIDataResponse">
\r
127 <xs:element name="broadWorksAnywhereTable" type="core:OCITable"/>
\r
130 </xs:complexContent>
\r
133 <xs:complexType name="GroupBroadWorksAnywhereGetInstanceRequest19sp1">
\r
136 Request to get all the information of a BroadWorks Anywhere instance.
\r
137 The response is either GroupBroadWorksAnywhereGetInstanceResponse19sp1 or ErrorResponse.
\r
138 </xs:documentation>
\r
140 <xs:complexContent>
\r
141 <xs:extension base="core:OCIRequest">
\r
143 <xs:element name="serviceUserId" type="UserId"/>
\r
146 </xs:complexContent>
\r
149 <xs:complexType name="GroupBroadWorksAnywhereGetInstanceResponse19sp1">
\r
152 Response to GroupBroadWorksAnywhereGetInstanceRequest19sp1.
\r
153 Contains the service profile information.
\r
154 </xs:documentation>
\r
156 <xs:complexContent>
\r
157 <xs:extension base="core:OCIDataResponse">
\r
159 <xs:element name="serviceInstanceProfile" type="ServiceInstanceReadProfile19sp1"/>
\r
160 <xs:element name="broadWorksAnywhereScope" type="BroadWorksAnywhereScope"/>
\r
161 <xs:element name="promptForCLID" type="BroadWorksAnywhereCLIDPrompt"/>
\r
162 <xs:element name="silentPromptMode" type="xs:boolean"/>
\r
163 <xs:element name="promptForPasscode" type="xs:boolean"/>
\r
164 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
167 </xs:complexContent>
\r
170 <xs:complexType name="GroupBroadWorksAnywhereModifyActiveInstanceListRequest">
\r
173 Request to set the active status of BroadWorks Anywhere instances.
\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="serviceActivation" type="ServiceActivation" minOccurs="0" maxOccurs="unbounded"/>
\r
183 </xs:complexContent>
\r
186 <xs:complexType name="GroupBroadWorksAnywhereModifyInstanceRequest">
\r
189 Request to modify a BroadWorks Anywhere instance.
\r
190 The response is either SuccessResponse or ErrorResponse.
\r
191 </xs:documentation>
\r
193 <xs:complexContent>
\r
194 <xs:extension base="core:OCIRequest">
\r
196 <xs:element name="serviceUserId" type="UserId"/>
\r
197 <xs:element name="serviceInstanceProfile" type="ServiceInstanceModifyProfile" minOccurs="0"/>
\r
198 <xs:element name="broadWorksAnywhereScope" type="BroadWorksAnywhereScope" minOccurs="0"/>
\r
199 <xs:element name="promptForCLID" type="BroadWorksAnywhereCLIDPrompt" minOccurs="0"/>
\r
200 <xs:element name="silentPromptMode" type="xs:boolean" minOccurs="0"/>
\r
201 <xs:element name="promptForPasscode" type="xs:boolean" minOccurs="0"/>
\r
202 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
205 </xs:complexContent>
\r
208 <xs:complexType name="UserBroadWorksAnywhereAddPhoneNumberRequest">
\r
211 Add a broadworks Anywhere phone number.
\r
212 The response is either a SuccessResponse or an ErrorResponse.
\r
213 </xs:documentation>
\r
215 <xs:complexContent>
\r
216 <xs:extension base="core:OCIRequest">
\r
218 <xs:element name="userId" type="UserId"/>
\r
219 <xs:element name="phoneNumber" type="DN"/>
\r
220 <xs:element name="description" type="BroadWorksAnywherePhoneNumberDescription" minOccurs="0"/>
\r
221 <xs:element name="isActive" type="xs:boolean"/>
\r
222 <xs:element name="outboundAlternateNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
223 <xs:element name="broadworksCallControl" type="xs:boolean"/>
\r
224 <xs:element name="useDiversionInhibitor" type="xs:boolean"/>
\r
225 <xs:element name="answerConfirmationRequired" type="xs:boolean"/>
\r
228 </xs:complexContent>
\r
231 <xs:complexType name="UserBroadWorksAnywhereAddSelectiveCriteriaRequest16">
\r
234 Add a criteria to the user's BroadWorks Anywhere phone number.
\r
235 For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
\r
236 The response is either a SuccessResponse or an ErrorResponse.
\r
237 </xs:documentation>
\r
239 <xs:complexContent>
\r
240 <xs:extension base="core:OCIRequest">
\r
242 <xs:element name="userId" type="UserId"/>
\r
243 <xs:element name="phoneNumber" type="DN"/>
\r
244 <xs:element name="criteriaName" type="CriteriaName"/>
\r
245 <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>
\r
246 <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>
\r
247 <xs:element name="blacklisted" type="xs:boolean"/>
\r
248 <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>
\r
249 <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>
\r
252 </xs:complexContent>
\r
255 <xs:complexType name="UserBroadWorksAnywhereDeletePhoneNumberRequest">
\r
258 Delete a broadworks anywhere phone number. Also deletes all the selective criteria for the phone number.
\r
259 The response is either a SuccessResponse or an ErrorResponse.
\r
260 </xs:documentation>
\r
262 <xs:complexContent>
\r
263 <xs:extension base="core:OCIRequest">
\r
265 <xs:element name="userId" type="UserId"/>
\r
266 <xs:element name="phoneNumber" type="DN"/>
\r
269 </xs:complexContent>
\r
272 <xs:complexType name="UserBroadWorksAnywhereDeleteSelectiveCriteriaRequest">
\r
275 Delete a criteria from the user's BroadWorks Anywhere phone number.
\r
276 The response is either a SuccessResponse or an ErrorResponse.
\r
277 </xs:documentation>
\r
279 <xs:complexContent>
\r
280 <xs:extension base="core:OCIRequest">
\r
282 <xs:element name="userId" type="UserId"/>
\r
283 <xs:element name="phoneNumber" type="DN"/>
\r
284 <xs:element name="criteriaName" type="CriteriaName"/>
\r
287 </xs:complexContent>
\r
290 <xs:complexType name="UserBroadWorksAnywhereGetAvailablePortalListRequest">
\r
293 Get a list of all the available BroadWorks Anywhere portal instances for a specific user
\r
294 The response is either UserBroadWorksAnywhereGetAvailableListResponse or ErrorResponse.
\r
295 </xs:documentation>
\r
297 <xs:complexContent>
\r
298 <xs:extension base="core:OCIRequest">
\r
300 <xs:element name="userId" type="UserId"/>
\r
303 </xs:complexContent>
\r
306 <xs:complexType name="UserBroadWorksAnywhereGetAvailablePortalListResponse">
\r
309 Response to the UserBroadWorksAnywhereGetAvailablePortalListRequest.
\r
310 Contains a table with column headings: "Portal Name", "Phone Number", "Extension", "Language".
\r
311 </xs:documentation>
\r
313 <xs:complexContent>
\r
314 <xs:extension base="core:OCIDataResponse">
\r
316 <xs:element name="portalTable" type="core:OCITable"/>
\r
319 </xs:complexContent>
\r
322 <xs:complexType name="UserBroadWorksAnywhereGetPhoneNumberRequest">
\r
325 Get a broadworks anywhere phone number
\r
326 The response is UserBroadWorksAnywhereGetPhoneNumberResponse.
\r
327 </xs:documentation>
\r
329 <xs:complexContent>
\r
330 <xs:extension base="core:OCIRequest">
\r
332 <xs:element name="userId" type="UserId"/>
\r
333 <xs:element name="phoneNumber" type="DN"/>
\r
336 </xs:complexContent>
\r
339 <xs:complexType name="UserBroadWorksAnywhereGetPhoneNumberResponse">
\r
342 Response to the UserBroadWorksAnywhereGetPhoneNumberRequest.
\r
343 The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule",
\r
344 "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension".
\r
345 The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:
\r
347 - Alternate X (where x is a number between 1 and 10)
\r
349 The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:
\r
350 - The value of the phone number for the corresponding Calls To Type, when the number is available. i.e. Alternate 1 may have extension, but no number.
\r
351 - When no number is available a blank space is provided instead.
\r
352 The possible values for the "Calls To Extension" column are the following or a caombination of them separated by comma:
\r
353 - The value of the extension for the corresponding Calls To Type, when the extension is available. i.e. Primary may have number, but no extension.
\r
354 - For Mobility Calls To Type, this is always blank.
\r
355 - When no exension is available a blank space is provided instead.
\r
356 </xs:documentation>
\r
358 <xs:complexContent>
\r
359 <xs:extension base="core:OCIDataResponse">
\r
361 <xs:element name="description" type="BroadWorksAnywherePhoneNumberDescription" minOccurs="0"/>
\r
362 <xs:element name="outboundAlternateNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
363 <xs:element name="isActive" type="xs:boolean"/>
\r
364 <xs:element name="broadworksCallControl" type="xs:boolean"/>
\r
365 <xs:element name="useDiversionInhibitor" type="xs:boolean"/>
\r
366 <xs:element name="answerConfirmationRequired" type="xs:boolean"/>
\r
367 <xs:element name="criteriaTable" type="core:OCITable"/>
\r
370 </xs:complexContent>
\r
373 <xs:complexType name="UserBroadWorksAnywhereGetRequest16sp2">
\r
376 Get the list of all the BroadWorks Anywhere phone numbers for the user.
\r
377 The response is either a UserBroadWorksAnywhereGetResponse16sp2 or an ErrorResponse.
\r
378 </xs:documentation>
\r
380 <xs:complexContent>
\r
381 <xs:extension base="core:OCIRequest">
\r
383 <xs:element name="userId" type="UserId"/>
\r
386 </xs:complexContent>
\r
389 <xs:complexType name="UserBroadWorksAnywhereGetResponse16sp2">
\r
392 Response to the UserBroadWorksAnywhereGetRequest16sp2.
\r
393 The phoneNumberTable contains columns: "Phone Number", "Description"
\r
394 </xs:documentation>
\r
396 <xs:complexContent>
\r
397 <xs:extension base="core:OCIDataResponse">
\r
399 <xs:element name="alertAllLocationsForClickToDialCalls" type="xs:boolean"/>
\r
400 <xs:element name="alertAllLocationsForGroupPagingCalls" type="xs:boolean"/>
\r
401 <xs:element name="phoneNumberTable" type="core:OCITable"/>
\r
404 </xs:complexContent>
\r
407 <xs:complexType name="UserBroadWorksAnywhereGetSelectiveCriteriaRequest21">
\r
410 Get a criteria for the user's BroadWorks Anywhere phone number.
\r
411 The response is either a UserBroadWorksAnywhereGetSelectiveCriteriaResponse21 or an ErrorResponse.
\r
412 </xs:documentation>
\r
414 <xs:complexContent>
\r
415 <xs:extension base="core:OCIRequest">
\r
417 <xs:element name="userId" type="UserId"/>
\r
418 <xs:element name="phoneNumber" type="DN"/>
\r
419 <xs:element name="criteriaName" type="CriteriaName"/>
\r
422 </xs:complexContent>
\r
425 <xs:complexType name="UserBroadWorksAnywhereGetSelectiveCriteriaResponse21">
\r
428 Response to the UserBroadWorksAnywhereGetSelectiveCriteriaRequest21.
\r
429 </xs:documentation>
\r
431 <xs:complexContent>
\r
432 <xs:extension base="core:OCIDataResponse">
\r
434 <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>
\r
435 <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>
\r
436 <xs:element name="blacklisted" type="xs:boolean"/>
\r
437 <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>
\r
438 <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>
\r
441 </xs:complexContent>
\r
444 <xs:complexType name="UserBroadWorksAnywhereModifyPhoneNumberRequest">
\r
447 Modify a BroadWorks Anywhere phone number
\r
448 The response is either a SuccessResponse or an ErrorResponse.
\r
449 </xs:documentation>
\r
451 <xs:complexContent>
\r
452 <xs:extension base="core:OCIRequest">
\r
454 <xs:element name="userId" type="UserId"/>
\r
455 <xs:element name="phoneNumber" type="DN"/>
\r
456 <xs:element name="newPhoneNumber" type="DN" minOccurs="0"/>
\r
457 <xs:element name="description" type="BroadWorksAnywherePhoneNumberDescription" minOccurs="0" nillable="true"/>
\r
458 <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>
\r
459 <xs:element name="outboundAlternateNumber" type="OutgoingDNorSIPURI" minOccurs="0" nillable="true"/>
\r
460 <xs:element name="broadworksCallControl" type="xs:boolean" minOccurs="0"/>
\r
461 <xs:element name="useDiversionInhibitor" type="xs:boolean" minOccurs="0"/>
\r
462 <xs:element name="answerConfirmationRequired" type="xs:boolean" minOccurs="0"/>
\r
463 <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>
\r
466 </xs:complexContent>
\r
469 <xs:complexType name="UserBroadWorksAnywhereModifyRequest">
\r
472 Request to modify the user-level settings for the BroadWorks Anywhere service for a specified user.
\r
473 The response is either SuccessResponse or ErrorResponse.
\r
474 </xs:documentation>
\r
476 <xs:complexContent>
\r
477 <xs:extension base="core:OCIRequest">
\r
479 <xs:element name="userId" type="UserId"/>
\r
480 <xs:element name="alertAllLocationsForClickToDialCalls" type="xs:boolean" minOccurs="0"/>
\r
481 <xs:element name="alertAllLocationsForGroupPagingCalls" type="xs:boolean" minOccurs="0"/>
\r
484 </xs:complexContent>
\r
487 <xs:complexType name="UserBroadWorksAnywhereModifySelectiveCriteriaRequest">
\r
490 Modify selective criteria for the user's BroadWorks Anywhere phone number.
\r
491 For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.
\r
492 The response is either a SuccessResponse or an ErrorResponse.
\r
493 </xs:documentation>
\r
495 <xs:complexContent>
\r
496 <xs:extension base="core:OCIRequest">
\r
498 <xs:element name="userId" type="UserId"/>
\r
499 <xs:element name="phoneNumber" type="DN"/>
\r
500 <xs:element name="criteriaName" type="CriteriaName"/>
\r
501 <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>
\r
502 <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>
\r
503 <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>
\r
504 <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>
\r
505 <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>
\r
506 <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>
\r
509 </xs:complexContent>
\r
512 <xs:simpleType name="BroadWorksAnywhereCLIDPrompt">
\r
515 BroadWorks Anywhere Prompt for CLID options.
\r
516 </xs:documentation>
\r
518 <xs:restriction base="xs:token">
\r
519 <xs:enumeration value="Always Prompt "/>
\r
520 <xs:enumeration value="Never Prompt "/>
\r
521 <xs:enumeration value="Prompt When Not Available"/>
\r
525 <xs:simpleType name="BroadWorksAnywherePhoneNumberDescription">
\r
528 BroadWorks Anywhere Phone Number Description.
\r
529 </xs:documentation>
\r
531 <xs:restriction base="xs:token">
\r
532 <xs:minLength value="1"/>
\r
533 <xs:maxLength value="80"/>
\r
537 <xs:simpleType name="BroadWorksAnywhereScope">
\r
540 Controls which users may use the BroadWorks Anywhere portal.
\r
541 </xs:documentation>
\r
543 <xs:restriction base="xs:token">
\r
544 <xs:enumeration value="Service Provider"/>
\r
545 <xs:enumeration value="Group"/>
\r