initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceExecutive.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 <!-- E X E C U T I V E  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="../OCISchemaSearchCriteria.xsd"/>\r
24   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
25   \r
26   <!-- ********************************************************************************** -->\r
27   <!-- E X E C U T I V E    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     SystemExecutiveGetRequest    \r
36     SystemExecutiveModifyRequest    \r
37     UserExecutiveAddFilteringSelectiveCriteriaRequest    \r
38     UserExecutiveDeleteFilteringSelectiveCriteriaRequest    \r
39     UserExecutiveGetAvailableAssistantListRequest    \r
40     UserExecutiveGetAssistantRequest    \r
41     UserExecutiveGetFilteringRequest    \r
42     UserExecutiveGetFilteringSelectiveCriteriaRequest21    \r
43     UserExecutiveGetScreeningAlertingRequest    \r
44     UserExecutiveModifyAssistantRequest    \r
45     UserExecutiveModifyFilteringRequest    \r
46     UserExecutiveModifyFilteringSelectiveCriteriaRequest    \r
47     UserExecutiveModifyScreeningAlertingRequest    \r
48     \r
49   --> \r
50   \r
51   <xs:complexType name="SystemExecutiveGetRequest">\r
52     <xs:annotation>\r
53       <xs:appinfo>\r
54         <asDataModeSupported>true</asDataModeSupported>\r
55         <hssDataModeSupported>false</hssDataModeSupported>\r
56       </xs:appinfo>\r
57       <xs:documentation>\r
58          Request to get the Executive system parameters.\r
59          The response is either SystemExecutiveGetResponse or ErrorResponse.\r
60       </xs:documentation>\r
61     </xs:annotation>\r
62     <xs:complexContent>\r
63       <xs:extension base="core:OCIRequest">\r
64         <xs:sequence/>\r
65       </xs:extension>\r
66     </xs:complexContent>\r
67   </xs:complexType>    \r
68     \r
69   <xs:complexType name="SystemExecutiveGetResponse">\r
70     <xs:annotation>\r
71       <xs:appinfo>\r
72         <asDataModeSupported>true</asDataModeSupported>\r
73         <hssDataModeSupported>false</hssDataModeSupported>\r
74       </xs:appinfo>\r
75       <xs:documentation>\r
76         Response to SystemExecutiveGetRequest.\r
77       </xs:documentation>\r
78     </xs:annotation>\r
79     <xs:complexContent>\r
80       <xs:extension base="core:OCIDataResponse">\r
81         <xs:sequence>\r
82           <xs:element name="treatVirtualOnNetCallsAsInternal" type="xs:boolean"/>\r
83         </xs:sequence>\r
84       </xs:extension>\r
85     </xs:complexContent>\r
86   </xs:complexType>    \r
87     \r
88   <xs:complexType name="SystemExecutiveModifyRequest">\r
89     <xs:annotation>\r
90       <xs:appinfo>\r
91         <asDataModeSupported>true</asDataModeSupported>\r
92         <hssDataModeSupported>false</hssDataModeSupported>\r
93       </xs:appinfo>\r
94       <xs:documentation>\r
95         Request to modify the Executive system parameters.\r
96         The response is either a SuccessResponse or an ErrorResponse.\r
97       </xs:documentation>\r
98     </xs:annotation>\r
99     <xs:complexContent>\r
100       <xs:extension base="core:OCIRequest">\r
101         <xs:sequence>\r
102           <xs:element name="treatVirtualOnNetCallsAsInternal" type="xs:boolean" minOccurs="0"/>\r
103         </xs:sequence>\r
104       </xs:extension>\r
105     </xs:complexContent>\r
106   </xs:complexType>    \r
107     \r
108   <xs:complexType name="UserExecutiveAddFilteringSelectiveCriteriaRequest">\r
109     <xs:annotation>\r
110       <xs:appinfo>\r
111         <asDataModeSupported>true</asDataModeSupported>\r
112         <hssDataModeSupported>false</hssDataModeSupported>\r
113       </xs:appinfo>\r
114       <xs:documentation>\r
115         Add a filtering criteria to an executive user.\r
116         Both executive and the executive assistant can run this command.\r
117         For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
118         The response is either SuccessResponse or ErrorResponse.\r
119       </xs:documentation>\r
120     </xs:annotation>\r
121     <xs:complexContent>\r
122       <xs:extension base="core:OCIRequest">\r
123         <xs:sequence>\r
124           <xs:element name="userId" type="UserId"/>\r
125           <xs:element name="criteriaName" type="CriteriaName"/>\r
126           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
127           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
128           <xs:element name="filter" type="xs:boolean"/>\r
129           <xs:element name="fromDnCriteria" type="ExecutiveCallFilteringCriteriaFromDn"/>\r
130           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
131         </xs:sequence>\r
132       </xs:extension>\r
133     </xs:complexContent>\r
134   </xs:complexType>    \r
135     \r
136   <xs:complexType name="UserExecutiveDeleteFilteringSelectiveCriteriaRequest">\r
137     <xs:annotation>\r
138       <xs:appinfo>\r
139         <asDataModeSupported>true</asDataModeSupported>\r
140         <hssDataModeSupported>false</hssDataModeSupported>\r
141       </xs:appinfo>\r
142       <xs:documentation>\r
143         Delete a filtering criteria from an executive user.\r
144         Both executive and the executive assistant can run this command.\r
145         The response is either SuccessResponse or ErrorResponse.\r
146       </xs:documentation>\r
147     </xs:annotation>\r
148     <xs:complexContent>\r
149       <xs:extension base="core:OCIRequest">\r
150         <xs:sequence>\r
151           <xs:element name="userId" type="UserId"/>\r
152           <xs:element name="criteriaName" type="CriteriaName"/>\r
153         </xs:sequence>\r
154       </xs:extension>\r
155     </xs:complexContent>\r
156   </xs:complexType>    \r
157     \r
158   <xs:complexType name="UserExecutiveGetAvailableAssistantListRequest">\r
159     <xs:annotation>\r
160       <xs:appinfo>\r
161         <asDataModeSupported>true</asDataModeSupported>\r
162         <hssDataModeSupported>false</hssDataModeSupported>\r
163       </xs:appinfo>\r
164       <xs:documentation>\r
165         Get a list of users that can be assigned to an executive.\r
166         Searching for users by group only makes sense when the executive user is part of an Enterprise.\r
167         The response is either UserExecutiveGetAvailableAssistantListResponse or ErrorResponse.\r
168       </xs:documentation>\r
169     </xs:annotation>\r
170     <xs:complexContent>\r
171       <xs:extension base="core:OCIRequest">\r
172         <xs:sequence>\r
173           <xs:element name="userId" type="UserId"/>\r
174           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
175           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
176           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
177           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
178           <xs:element name="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>\r
179           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
180           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
181           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" 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="UserExecutiveGetAvailableAssistantListResponse">\r
188     <xs:annotation>\r
189       <xs:appinfo>\r
190         <asDataModeSupported>true</asDataModeSupported>\r
191         <hssDataModeSupported>false</hssDataModeSupported>\r
192       </xs:appinfo>\r
193       <xs:documentation>\r
194         Response to the UserExecutiveGetAvailableAssistantListResponse.\r
195         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", \r
196         "Hiragana First Name", "Phone Number", "Extension", "Department" and "Email Address".\r
197       </xs:documentation>\r
198     </xs:annotation>\r
199     <xs:complexContent>\r
200       <xs:extension base="core:OCIDataResponse">\r
201         <xs:sequence>\r
202           <xs:element name="userTable" type="core:OCITable"/>\r
203         </xs:sequence>\r
204       </xs:extension>\r
205     </xs:complexContent>\r
206   </xs:complexType>    \r
207     \r
208   <xs:complexType name="UserExecutiveGetAssistantRequest">\r
209     <xs:annotation>\r
210       <xs:appinfo>\r
211         <asDataModeSupported>true</asDataModeSupported>\r
212         <hssDataModeSupported>false</hssDataModeSupported>\r
213       </xs:appinfo>\r
214       <xs:documentation>\r
215         Get the assistant setting and the list of assistants assigned to an executive.\r
216         The response is either UserExecutiveGetAssistantsResponse or ErrorResponse.\r
217       </xs:documentation>\r
218     </xs:annotation>\r
219     <xs:complexContent>\r
220       <xs:extension base="core:OCIRequest">\r
221         <xs:sequence>\r
222           <xs:element name="userId" type="UserId"/>\r
223         </xs:sequence>\r
224       </xs:extension>\r
225     </xs:complexContent>\r
226   </xs:complexType>    \r
227     \r
228   <xs:complexType name="UserExecutiveGetAssistantResponse">\r
229     <xs:annotation>\r
230       <xs:appinfo>\r
231         <asDataModeSupported>true</asDataModeSupported>\r
232         <hssDataModeSupported>false</hssDataModeSupported>\r
233       </xs:appinfo>\r
234       <xs:documentation>\r
235         Response to the UserExecutiveGetAssistantsRequest.\r
236         Contains the assistant setting and a table of assigned assistants.\r
237         The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", \r
238         "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address" and "Opt-in".\r
239         The possible values for "Opt-in" column are "true" and "false".\r
240       </xs:documentation>\r
241     </xs:annotation>\r
242     <xs:complexContent>\r
243       <xs:extension base="core:OCIDataResponse">\r
244         <xs:sequence>\r
245           <xs:element name="allowOptInOut" type="xs:boolean"/>\r
246           <xs:element name="assistantUserTable" type="core:OCITable"/>\r
247         </xs:sequence>\r
248       </xs:extension>\r
249     </xs:complexContent>\r
250   </xs:complexType>    \r
251     \r
252   <xs:complexType name="UserExecutiveGetFilteringRequest">\r
253     <xs:annotation>\r
254       <xs:appinfo>\r
255         <asDataModeSupported>true</asDataModeSupported>\r
256         <hssDataModeSupported>false</hssDataModeSupported>\r
257       </xs:appinfo>\r
258       <xs:documentation>\r
259         Get the filtering setting and the list of filtering criteria defined for an executive user.\r
260         Both executive and the executive assistant can run this command.\r
261         The response is either UserExecutiveGetFilteringResponse 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="userId" type="UserId"/>\r
268         </xs:sequence>\r
269       </xs:extension>\r
270     </xs:complexContent>\r
271   </xs:complexType>    \r
272     \r
273   <xs:complexType name="UserExecutiveGetFilteringResponse">\r
274     <xs:annotation>\r
275       <xs:appinfo>\r
276         <asDataModeSupported>true</asDataModeSupported>\r
277         <hssDataModeSupported>false</hssDataModeSupported>\r
278       </xs:appinfo>\r
279       <xs:documentation>\r
280         Response to the UserExecutiveGetFilteringRequest.\r
281         Contains the filtering setting and a table of filtering criteria.\r
282         The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", \r
283         "Filter", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension".      \r
284         The "Filter" column can contain "true" or "false".\r
285         The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:\r
286           - Primary\r
287           - Alternate X (where x is a number between 1 and 10)\r
288           - Mobility        \r
289         The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:\r
290           - 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
291           - When no number is available a blank space is provided instead.\r
292         The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:\r
293           - 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
294           - For Mobility Calls To Type, this is always blank.\r
295           - When no extension is available a blank space is provided instead.\r
296         </xs:documentation>\r
297     </xs:annotation>\r
298     <xs:complexContent>\r
299       <xs:extension base="core:OCIDataResponse">\r
300         <xs:sequence>\r
301           <xs:element name="enableFiltering" type="xs:boolean"/>\r
302           <xs:element name="filteringMode" type="ExecutiveCallFilteringMode"/>\r
303           <xs:element name="simpleFilterType" type="ExecutiveCallFilteringSimpleFilterType"/>\r
304           <xs:element name="criteriaTable" type="core:OCITable"/>\r
305         </xs:sequence>\r
306       </xs:extension>\r
307     </xs:complexContent>\r
308   </xs:complexType>    \r
309     \r
310   <xs:complexType name="UserExecutiveGetFilteringSelectiveCriteriaRequest21">\r
311     <xs:annotation>\r
312       <xs:appinfo>\r
313         <asDataModeSupported>true</asDataModeSupported>\r
314         <hssDataModeSupported>false</hssDataModeSupported>\r
315       </xs:appinfo>\r
316       <xs:documentation>\r
317         Get a filtering criteria for an executive user.\r
318         Both executive and the executive assistant can run this command.\r
319         The response is either UserExecutiveGetSelectiveCriteriaResponse21 or ErrorResponse.\r
320       </xs:documentation>\r
321     </xs:annotation>\r
322     <xs:complexContent>\r
323       <xs:extension base="core:OCIRequest">\r
324         <xs:sequence>\r
325           <xs:element name="userId" type="UserId"/>\r
326           <xs:element name="criteriaName" type="CriteriaName"/>\r
327         </xs:sequence>\r
328       </xs:extension>\r
329     </xs:complexContent>\r
330   </xs:complexType>    \r
331     \r
332   <xs:complexType name="UserExecutiveGetFilteringSelectiveCriteriaResponse21">\r
333     <xs:annotation>\r
334       <xs:appinfo>\r
335         <asDataModeSupported>true</asDataModeSupported>\r
336         <hssDataModeSupported>false</hssDataModeSupported>\r
337       </xs:appinfo>\r
338       <xs:documentation>\r
339         Response to the UserExecutiveGetFilteringSelectiveCriteriaRequest21.\r
340       </xs:documentation>\r
341     </xs:annotation>\r
342     <xs:complexContent>\r
343       <xs:extension base="core:OCIDataResponse">\r
344         <xs:sequence>\r
345           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
346           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
347           <xs:element name="filter" type="xs:boolean"/>\r
348           <xs:element name="fromDnCriteria" type="ExecutiveCallFilteringCriteriaFromDn"/>\r
349           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
350         </xs:sequence>\r
351       </xs:extension>\r
352     </xs:complexContent>\r
353   </xs:complexType>    \r
354     \r
355   <xs:complexType name="UserExecutiveGetScreeningAlertingRequest">\r
356     <xs:annotation>\r
357       <xs:appinfo>\r
358         <asDataModeSupported>true</asDataModeSupported>\r
359         <hssDataModeSupported>false</hssDataModeSupported>\r
360       </xs:appinfo>\r
361       <xs:documentation>\r
362         Get the screening and alerting setting of an executive. Both executive and the executive assistant can run this command.\r
363         The response is either UserExecutiveGetScreeningAlertingResponse or ErrorResponse.\r
364       </xs:documentation>\r
365     </xs:annotation>\r
366     <xs:complexContent>\r
367       <xs:extension base="core:OCIRequest">\r
368         <xs:sequence>\r
369           <xs:element name="userId" type="UserId"/>\r
370         </xs:sequence>\r
371       </xs:extension>\r
372     </xs:complexContent>\r
373   </xs:complexType>    \r
374     \r
375   <xs:complexType name="UserExecutiveGetScreeningAlertingResponse">\r
376     <xs:annotation>\r
377       <xs:appinfo>\r
378         <asDataModeSupported>true</asDataModeSupported>\r
379         <hssDataModeSupported>false</hssDataModeSupported>\r
380       </xs:appinfo>\r
381       <xs:documentation>\r
382         Response to the UserExecutiveGetScreeningAlertingRequest.\r
383         Contains the screening and alerting settings for an executive.\r
384       </xs:documentation>\r
385     </xs:annotation>\r
386     <xs:complexContent>\r
387       <xs:extension base="core:OCIDataResponse">\r
388         <xs:sequence>\r
389           <xs:element name="enableScreening" type="xs:boolean"/>\r
390           <xs:element name="screeningAlertType" type="ExecutiveScreeningAlertType"/>\r
391           <xs:element name="alertBroadWorksMobilityLocation" type="xs:boolean"/>\r
392           <xs:element name="alertBroadWorksAnywhereLocations" type="xs:boolean"/>\r
393           <xs:element name="alertSharedCallAppearanceLocations" type="xs:boolean"/>\r
394           <xs:element name="alertingMode" type="ExecutiveAlertingMode"/>\r
395           <xs:element name="alertingCallingLineIdNameMode" type="ExecutiveAlertingCallingLineIdNameMode"/>\r
396           <xs:element name="alertingCustomCallingLineIdName" type="ExecutiveAlertingCustomCallingLineIdName" minOccurs="0"/>\r
397           <xs:element name="unicodeAlertingCustomCallingLineIdName" type="ExecutiveAlertingCustomCallingLineIdName" minOccurs="0"/>\r
398           <xs:element name="alertingCallingLineIdPhoneNumberMode" type="ExecutiveAlertingCallingLineIdPhoneNumberMode"/>\r
399           <xs:element name="alertingCustomCallingLineIdPhoneNumber" type="DN" minOccurs="0"/>\r
400           <xs:element name="callPushRecallNumberOfRings" type="ExecutiveCallPushRecallNumberOfRings"/>\r
401           <xs:element name="nextAssistantNumberOfRings" type="ExecutiveNextAssistantNumberOfRings"/>\r
402           <xs:element name="enableRollover" type="xs:boolean"/>\r
403           <xs:element name="rolloverWaitTimeSeconds" type="ExecutiveRolloverWaitTimeSeconds" minOccurs="0"/>\r
404           <xs:element name="rolloverAction" type="ExecutiveRolloverActionType"/>\r
405           <xs:element name="rolloverForwardToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
406         </xs:sequence>\r
407       </xs:extension>\r
408     </xs:complexContent>\r
409   </xs:complexType>    \r
410     \r
411   <xs:complexType name="UserExecutiveModifyAssistantRequest">\r
412     <xs:annotation>\r
413       <xs:appinfo>\r
414         <asDataModeSupported>true</asDataModeSupported>\r
415         <hssDataModeSupported>false</hssDataModeSupported>\r
416       </xs:appinfo>\r
417       <xs:documentation>\r
418         Request to modify the assistant setting and the list of assistants assigned to an executive user.\r
419         The response is either SuccessResponse or ErrorResponse.\r
420       </xs:documentation>\r
421     </xs:annotation>\r
422     <xs:complexContent>\r
423       <xs:extension base="core:OCIRequest">\r
424         <xs:sequence>\r
425           <xs:element name="userId" type="UserId"/>\r
426           <xs:element name="allowOptInOut" type="xs:boolean" minOccurs="0"/>\r
427           <xs:element name="assistantUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
428         </xs:sequence>\r
429       </xs:extension>\r
430     </xs:complexContent>\r
431   </xs:complexType>    \r
432     \r
433   <xs:complexType name="UserExecutiveModifyFilteringRequest">\r
434     <xs:annotation>\r
435       <xs:appinfo>\r
436         <asDataModeSupported>true</asDataModeSupported>\r
437         <hssDataModeSupported>false</hssDataModeSupported>\r
438       </xs:appinfo>\r
439       <xs:documentation>\r
440         Modify the filtering setting for an executive user.\r
441         Both executive and the executive assistant can run this command.\r
442         The response is either SuccessResponse or ErrorResponse.\r
443       </xs:documentation>\r
444     </xs:annotation>\r
445     <xs:complexContent>\r
446       <xs:extension base="core:OCIRequest">\r
447         <xs:sequence>\r
448           <xs:element name="userId" type="UserId"/>\r
449           <xs:element name="enableFiltering" type="xs:boolean" minOccurs="0"/>\r
450           <xs:element name="filteringMode" type="ExecutiveCallFilteringMode" minOccurs="0"/>\r
451           <xs:element name="simpleFilterType" type="ExecutiveCallFilteringSimpleFilterType" minOccurs="0"/>\r
452           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
453         </xs:sequence>\r
454       </xs:extension>\r
455     </xs:complexContent>\r
456   </xs:complexType>    \r
457     \r
458   <xs:complexType name="UserExecutiveModifyFilteringSelectiveCriteriaRequest">\r
459     <xs:annotation>\r
460       <xs:appinfo>\r
461         <asDataModeSupported>true</asDataModeSupported>\r
462         <hssDataModeSupported>false</hssDataModeSupported>\r
463       </xs:appinfo>\r
464       <xs:documentation>\r
465         Modify a filtering selective criteria for an executive.\r
466         Both executive and the executive assistant can run this command.\r
467         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
468         The response is either SuccessResponse or ErrorResponse.\r
469       </xs:documentation>\r
470     </xs:annotation>\r
471     <xs:complexContent>\r
472       <xs:extension base="core:OCIRequest">\r
473         <xs:sequence>\r
474           <xs:element name="userId" type="UserId"/>\r
475           <xs:element name="criteriaName" type="CriteriaName"/>\r
476           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
477           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
478           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
479           <xs:element name="filter" type="xs:boolean" minOccurs="0"/>\r
480           <xs:element name="fromDnCriteria" type="ExecutiveCallFilteringCriteriaFromDnModify" minOccurs="0"/>\r
481           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
482         </xs:sequence>\r
483       </xs:extension>\r
484     </xs:complexContent>\r
485   </xs:complexType>    \r
486     \r
487   <xs:complexType name="UserExecutiveModifyScreeningAlertingRequest">\r
488     <xs:annotation>\r
489       <xs:appinfo>\r
490         <asDataModeSupported>true</asDataModeSupported>\r
491         <hssDataModeSupported>false</hssDataModeSupported>\r
492       </xs:appinfo>\r
493       <xs:documentation>\r
494         Modify the screening and alerting setting of an executive.\r
495         Both executive and the executive assistant can run this command.\r
496         The response is either SuccessResponse or ErrorResponse.\r
497       </xs:documentation>\r
498     </xs:annotation>\r
499     <xs:complexContent>\r
500       <xs:extension base="core:OCIRequest">\r
501         <xs:sequence>\r
502           <xs:element name="userId" type="UserId"/>\r
503           <xs:element name="enableScreening" type="xs:boolean" minOccurs="0"/>\r
504           <xs:element name="screeningAlertType" type="ExecutiveScreeningAlertType" minOccurs="0"/>\r
505           <xs:element name="alertBroadWorksMobilityLocation" type="xs:boolean" minOccurs="0"/>\r
506           <xs:element name="alertBroadWorksAnywhereLocations" type="xs:boolean" minOccurs="0"/>\r
507           <xs:element name="alertSharedCallAppearanceLocations" type="xs:boolean" minOccurs="0"/>\r
508           <xs:element name="alertingMode" type="ExecutiveAlertingMode" minOccurs="0"/>\r
509           <xs:element name="alertingCallingLineIdNameMode" type="ExecutiveAlertingCallingLineIdNameMode" minOccurs="0"/>\r
510           <xs:element name="alertingCustomCallingLineIdName" type="ExecutiveAlertingCustomCallingLineIdName" nillable="true" minOccurs="0"/>\r
511           <xs:element name="unicodeAlertingCustomCallingLineIdName" type="ExecutiveAlertingCustomCallingLineIdName" nillable="true" minOccurs="0"/>\r
512           <xs:element name="alertingCallingLineIdPhoneNumberMode" type="ExecutiveAlertingCallingLineIdPhoneNumberMode" minOccurs="0"/>\r
513           <xs:element name="alertingCustomCallingLineIdPhoneNumber" type="DN" nillable="true" minOccurs="0"/>\r
514           <xs:element name="callPushRecallNumberOfRings" type="ExecutiveCallPushRecallNumberOfRings" minOccurs="0"/>\r
515           <xs:element name="nextAssistantNumberOfRings" type="ExecutiveNextAssistantNumberOfRings" minOccurs="0"/>\r
516           <xs:element name="enableRollover" type="xs:boolean" minOccurs="0"/>\r
517           <xs:element name="rolloverWaitTimeSeconds" type="ExecutiveRolloverWaitTimeSeconds" nillable="true" minOccurs="0"/>\r
518           <xs:element name="rolloverAction" type="ExecutiveRolloverActionType" minOccurs="0"/>\r
519           <xs:element name="rolloverForwardToPhoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
520         </xs:sequence>\r
521       </xs:extension>\r
522     </xs:complexContent>\r
523   </xs:complexType>    \r
524     \r
525   <xs:simpleType name="ExecutiveAlertingCallingLineIdNameMode">\r
526     <xs:annotation>\r
527       <xs:documentation>\r
528         Executive alerting calling line Id name mode.\r
529       </xs:documentation>\r
530     </xs:annotation>\r
531     <xs:restriction base="xs:token">\r
532       <xs:enumeration value="Executive"/>\r
533       <xs:enumeration value="Executive-Originator"/>\r
534       <xs:enumeration value="Originator-Executive"/>\r
535       <xs:enumeration value="Originator"/>\r
536       <xs:enumeration value="Custom"/>\r
537     </xs:restriction>\r
538   </xs:simpleType>    \r
539     \r
540   <xs:simpleType name="ExecutiveAlertingCallingLineIdPhoneNumberMode">\r
541     <xs:annotation>\r
542       <xs:documentation>\r
543         Executive alerting calling line Id phone number mode.\r
544       </xs:documentation>\r
545     </xs:annotation>\r
546     <xs:restriction base="xs:token">\r
547       <xs:enumeration value="Executive"/>\r
548       <xs:enumeration value="Originator"/>\r
549       <xs:enumeration value="Custom"/>\r
550     </xs:restriction>\r
551   </xs:simpleType>    \r
552     \r
553   <xs:simpleType name="ExecutiveAlertingCustomCallingLineIdName">\r
554     <xs:annotation>\r
555       <xs:documentation>\r
556         Executive alerting custom calling line Id name.\r
557       </xs:documentation>\r
558     </xs:annotation>\r
559     <xs:restriction base="xs:token">\r
560       <xs:minLength value="1"/>\r
561       <xs:maxLength value="80"/>\r
562     </xs:restriction>\r
563   </xs:simpleType>    \r
564     \r
565   <xs:simpleType name="ExecutiveAlertingMode">\r
566     <xs:annotation>\r
567       <xs:documentation>\r
568         Executive alerting mode.\r
569       </xs:documentation>\r
570     </xs:annotation>\r
571     <xs:restriction base="xs:token">\r
572       <xs:enumeration value="Simultaneous"/>\r
573       <xs:enumeration value="Sequential"/>\r
574     </xs:restriction>\r
575   </xs:simpleType>    \r
576     \r
577   <xs:simpleType name="ExecutiveCallFilteringCriteriaDnSelection">\r
578     <xs:annotation>\r
579       <xs:documentation>\r
580         Eecutive call filtering criteria selection for a dn.\r
581       </xs:documentation>\r
582     </xs:annotation>\r
583     <xs:restriction base="xs:token">\r
584       <xs:enumeration value="Any"/>\r
585       <xs:enumeration value="Any Internal"/>\r
586       <xs:enumeration value="Any External"/>\r
587       <xs:enumeration value="Specified Only"/>\r
588     </xs:restriction>\r
589   </xs:simpleType>    \r
590     \r
591   <xs:complexType name="ExecutiveCallFilteringCriteriaFromDn">\r
592     <xs:annotation>\r
593       <xs:documentation>\r
594         The from dn criteria used within an executive call filtering criteria add/get request.\r
595       </xs:documentation>\r
596     </xs:annotation>\r
597     <xs:sequence>\r
598       <xs:element name="fromDnCriteriaSelection" type="ExecutiveCallFilteringCriteriaDnSelection"/>\r
599       <xs:element name="includeAnonymousCallers" type="xs:boolean"/>\r
600       <xs:element name="includeUnavailableCallers" type="xs:boolean"/>\r
601       <xs:element name="phoneNumber" type="DN" minOccurs="0" maxOccurs="12"/>\r
602     </xs:sequence>\r
603   </xs:complexType>    \r
604     \r
605   <xs:complexType name="ExecutiveCallFilteringCriteriaFromDnModify">\r
606     <xs:annotation>\r
607       <xs:documentation>\r
608         The from dn criteria used within an executive call filtering criteria modify request.\r
609       </xs:documentation>\r
610     </xs:annotation>\r
611     <xs:sequence>\r
612       <xs:element name="fromDnCriteriaSelection" type="ExecutiveCallFilteringCriteriaDnSelection" minOccurs="0"/>\r
613       <xs:element name="includeAnonymousCallers" type="xs:boolean" minOccurs="0"/>\r
614       <xs:element name="includeUnavailableCallers" type="xs:boolean" minOccurs="0"/>\r
615       <xs:element name="phoneNumberList" type="CriteriaReplacementDNList" nillable="true" minOccurs="0"/>\r
616     </xs:sequence>\r
617   </xs:complexType>    \r
618     \r
619   <xs:simpleType name="ExecutiveCallFilteringMode">\r
620     <xs:annotation>\r
621       <xs:documentation>\r
622         Executive call filtering mode.\r
623       </xs:documentation>\r
624     </xs:annotation>\r
625     <xs:restriction base="xs:token">\r
626       <xs:enumeration value="Simple"/>\r
627       <xs:enumeration value="Advanced"/>\r
628     </xs:restriction>\r
629   </xs:simpleType>    \r
630     \r
631   <xs:simpleType name="ExecutiveCallFilteringSimpleFilterType">\r
632     <xs:annotation>\r
633       <xs:documentation>\r
634         Executive call filtering filter type in simple filtering mode.\r
635       </xs:documentation>\r
636     </xs:annotation>\r
637     <xs:restriction base="xs:token">\r
638       <xs:enumeration value="All Calls"/>\r
639       <xs:enumeration value="All Internal Calls"/>\r
640       <xs:enumeration value="All External Calls"/>\r
641     </xs:restriction>\r
642   </xs:simpleType>    \r
643     \r
644   <xs:simpleType name="ExecutiveCallPushRecallNumberOfRings">\r
645     <xs:annotation>\r
646       <xs:documentation>\r
647         Number of rings to wait before starting the call push recall.\r
648       </xs:documentation>\r
649     </xs:annotation>\r
650     <xs:restriction base="xs:int">\r
651       <xs:minInclusive value="2"/>\r
652       <xs:maxInclusive value="20"/>\r
653     </xs:restriction>\r
654   </xs:simpleType>    \r
655     \r
656   <xs:simpleType name="ExecutiveNextAssistantNumberOfRings">\r
657     <xs:annotation>\r
658       <xs:documentation>\r
659         Number of rings to wait before advancing to next assistant.\r
660       </xs:documentation>\r
661     </xs:annotation>\r
662     <xs:restriction base="xs:int">\r
663       <xs:minInclusive value="1"/>\r
664       <xs:maxInclusive value="20"/>\r
665     </xs:restriction>\r
666   </xs:simpleType>    \r
667     \r
668   <xs:simpleType name="ExecutiveRolloverActionType">\r
669     <xs:annotation>\r
670       <xs:documentation>\r
671         Executive rollover action.\r
672       </xs:documentation>\r
673     </xs:annotation>\r
674     <xs:restriction base="xs:token">\r
675       <xs:enumeration value="Voice Messaging"/>\r
676       <xs:enumeration value="Forward"/>\r
677       <xs:enumeration value="No Answer Processing"/>\r
678     </xs:restriction>\r
679   </xs:simpleType>    \r
680     \r
681   <xs:simpleType name="ExecutiveRolloverWaitTimeSeconds">\r
682     <xs:annotation>\r
683       <xs:documentation>\r
684         Number of seconds to wait before rollover to next assistant.\r
685       </xs:documentation>\r
686     </xs:annotation>\r
687     <xs:restriction base="xs:int">\r
688       <xs:minInclusive value="0"/>\r
689       <xs:maxInclusive value="7200"/>\r
690     </xs:restriction>\r
691   </xs:simpleType>    \r
692     \r
693   <xs:simpleType name="ExecutiveScreeningAlertType">\r
694     <xs:annotation>\r
695       <xs:documentation>\r
696         Executive screening alert type.\r
697       </xs:documentation>\r
698     </xs:annotation>\r
699     <xs:restriction base="xs:token">\r
700       <xs:enumeration value="Silent"/>\r
701       <xs:enumeration value="Ring Splash"/>\r
702     </xs:restriction>\r
703   </xs:simpleType>    \r
704     \r
705 </xs:schema>\r