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 <!-- M U S I C O N H O L D 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 <!-- M U S I C O N H O L D R E Q U E S T S A N D R E S P O N S E S -->
\r
27 <!-- ********************************************************************************** -->
\r
29 Requests and responses are listed here in alphabetical order.
\r
30 The non-primitive attributes inside the commands are defined in another
\r
31 section of the schema.
\r
33 Requests in this schema file:
\r
34 GroupMusicOnHoldAddInstanceRequest21
\r
35 GroupMusicOnHoldDeleteInstanceRequest
\r
36 GroupMusicOnHoldGetInstanceRequest21
\r
37 GroupMusicOnHoldGetDepartmentListRequest
\r
38 GroupMusicOnHoldModifyInstanceRequest21
\r
39 SystemMusicOnHoldGetRequest
\r
40 SystemMusicOnHoldModifyRequest
\r
41 UserMusicOnHoldGetRequest
\r
42 UserMusicOnHoldModifyRequest
\r
43 UserMusicOnHoldUserGetRequest20
\r
44 UserMusicOnHoldUserModifyRequest20
\r
48 <xs:complexType name="GroupMusicOnHoldAddInstanceRequest21">
\r
51 Add a Music on Hold Instance to a department.
\r
52 The response is either SuccessResponse or ErrorResponse.
\r
56 <xs:extension base="core:OCIRequest">
\r
58 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
59 <xs:element name="groupId" type="GroupId"/>
\r
60 <xs:element name="department" type="DepartmentKey"/>
\r
61 <xs:element name="isActiveDuringCallHold" type="xs:boolean"/>
\r
62 <xs:element name="isActiveDuringCallPark" type="xs:boolean"/>
\r
63 <xs:element name="isActiveDuringBusyCampOn" type="xs:boolean"/>
\r
64 <xs:element name="source" type="MusicOnHoldSourceAdd21"/>
\r
65 <xs:element name="useAlternateSourceForInternalCalls" type="xs:boolean"/>
\r
66 <xs:element name="internalSource" type="MusicOnHoldSourceAdd21" minOccurs="0"/>
\r
69 </xs:complexContent>
\r
72 <xs:complexType name="GroupMusicOnHoldDeleteInstanceRequest">
\r
75 Delete a Music On Hold department instance.
\r
76 The response is either SuccessResponse or ErrorResponse.
\r
80 <xs:extension base="core:OCIRequest">
\r
82 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
83 <xs:element name="groupId" type="GroupId"/>
\r
84 <xs:element name="department" type="DepartmentKey"/>
\r
87 </xs:complexContent>
\r
90 <xs:complexType name="GroupMusicOnHoldGetInstanceRequest21">
\r
93 Get a Music On Hold data for a group or department instance.
\r
94 The response is either GroupMusicOnHoldGetInstanceResponse21 or ErrorResponse.
\r
98 <xs:extension base="core:OCIRequest">
\r
100 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
101 <xs:element name="groupId" type="GroupId"/>
\r
102 <xs:element name="department" type="DepartmentKey" minOccurs="0"/>
\r
105 </xs:complexContent>
\r
108 <xs:complexType name="GroupMusicOnHoldGetInstanceResponse21">
\r
111 Response to the GroupMusicOnHoldGetInstanceRequest21.
\r
112 </xs:documentation>
\r
114 <xs:complexContent>
\r
115 <xs:extension base="core:OCIDataResponse">
\r
117 <xs:element name="serviceUserId" type="UserId"/>
\r
118 <xs:element name="isActiveDuringCallHold" type="xs:boolean"/>
\r
119 <xs:element name="isActiveDuringCallPark" type="xs:boolean"/>
\r
120 <xs:element name="isActiveDuringBusyCampOn" type="xs:boolean"/>
\r
121 <xs:element name="enableVideo" type="xs:boolean"/>
\r
122 <xs:element name="source" type="MusicOnHoldSourceRead21"/>
\r
123 <xs:element name="useAlternateSourceForInternalCalls" type="xs:boolean"/>
\r
124 <xs:element name="internalSource" type="MusicOnHoldSourceRead21"/>
\r
127 </xs:complexContent>
\r
130 <xs:complexType name="GroupMusicOnHoldGetDepartmentListRequest">
\r
133 Returns a list of all departments that have a Music On Hold instance.
\r
134 The response is either GroupMusicOnHoldGetDepartmentListResponse or ErrorResponse.
\r
135 It is possible to get the instances within a specified department.
\r
136 </xs:documentation>
\r
138 <xs:complexContent>
\r
139 <xs:extension base="core:OCIRequest">
\r
141 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
142 <xs:element name="groupId" type="GroupId"/>
\r
143 <xs:element name="groupDepartmentName" type="DepartmentName" minOccurs="0"/>
\r
146 </xs:complexContent>
\r
149 <xs:complexType name="GroupMusicOnHoldGetDepartmentListResponse">
\r
152 Response to the GroupMusicOnHoldGetDepartmentListRequest.
\r
153 </xs:documentation>
\r
155 <xs:complexContent>
\r
156 <xs:extension base="core:OCIDataResponse">
\r
158 <xs:element name="hasDepartment" type="xs:boolean"/>
\r
159 <xs:element name="department" type="DepartmentKey" minOccurs="0" maxOccurs="unbounded"/>
\r
160 <xs:element name="departmentFullPath" type="DepartmentFullPathName" minOccurs="0" maxOccurs="unbounded"/>
\r
163 </xs:complexContent>
\r
166 <xs:complexType name="GroupMusicOnHoldModifyInstanceRequest21">
\r
169 Modify data for a group or department Music On Hold Instance.
\r
170 The response is either SuccessResponse or ErrorResponse.
\r
171 </xs:documentation>
\r
173 <xs:complexContent>
\r
174 <xs:extension base="core:OCIRequest">
\r
176 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
177 <xs:element name="groupId" type="GroupId"/>
\r
178 <xs:element name="department" type="DepartmentKey" minOccurs="0"/>
\r
179 <xs:element name="isActiveDuringCallHold" type="xs:boolean" minOccurs="0"/>
\r
180 <xs:element name="isActiveDuringCallPark" type="xs:boolean" minOccurs="0"/>
\r
181 <xs:element name="isActiveDuringBusyCampOn" type="xs:boolean" minOccurs="0"/>
\r
182 <xs:element name="source" type="MusicOnHoldSourceModify21" minOccurs="0"/>
\r
183 <xs:element name="useAlternateSourceForInternalCalls" type="xs:boolean" minOccurs="0"/>
\r
184 <xs:element name="internalSource" type="MusicOnHoldSourceModify21" minOccurs="0"/>
\r
187 </xs:complexContent>
\r
190 <xs:complexType name="SystemMusicOnHoldGetRequest">
\r
193 Request the system level data associated with Music On Hold.
\r
194 The response is either a SystemMusicOnHoldGetResponse or an
\r
196 </xs:documentation>
\r
198 <xs:complexContent>
\r
199 <xs:extension base="core:OCIRequest">
\r
202 </xs:complexContent>
\r
205 <xs:complexType name="SystemMusicOnHoldGetResponse">
\r
208 Response to SystemMusicOnHoldGetRequest.
\r
209 </xs:documentation>
\r
211 <xs:complexContent>
\r
212 <xs:extension base="core:OCIDataResponse">
\r
214 <xs:element name="delayMilliseconds" type="MusicOnHoldDelayMilliseconds"/>
\r
217 </xs:complexContent>
\r
220 <xs:complexType name="SystemMusicOnHoldModifyRequest">
\r
223 Modify the system level data associated with Music On Hold.
\r
224 The response is either a SuccessResponse or an ErrorResponse.
\r
225 </xs:documentation>
\r
227 <xs:complexContent>
\r
228 <xs:extension base="core:OCIRequest">
\r
230 <xs:element name="delayMilliseconds" type="MusicOnHoldDelayMilliseconds" minOccurs="0"/>
\r
233 </xs:complexContent>
\r
236 <xs:complexType name="UserMusicOnHoldGetRequest">
\r
239 Request the user level data associated with Music On Hold.
\r
240 The response is either a UserMusicOnHoldGetResponse or an
\r
242 </xs:documentation>
\r
244 <xs:complexContent>
\r
245 <xs:extension base="core:OCIRequest">
\r
247 <xs:element name="userId" type="UserId"/>
\r
250 </xs:complexContent>
\r
253 <xs:complexType name="UserMusicOnHoldGetResponse">
\r
256 Response to UserMusicOnHoldGetRequest.
\r
257 </xs:documentation>
\r
259 <xs:complexContent>
\r
260 <xs:extension base="core:OCIDataResponse">
\r
262 <xs:element name="isActive" type="xs:boolean"/>
\r
265 </xs:complexContent>
\r
268 <xs:complexType name="UserMusicOnHoldModifyRequest">
\r
271 Modify the user level data associated with Music On Hold.
\r
272 The response is either a SuccessResponse or an ErrorResponse.
\r
273 </xs:documentation>
\r
275 <xs:complexContent>
\r
276 <xs:extension base="core:OCIRequest">
\r
278 <xs:element name="userId" type="UserId"/>
\r
279 <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>
\r
282 </xs:complexContent>
\r
285 <xs:complexType name="UserMusicOnHoldUserGetRequest20">
\r
288 Request the user level data associated with Music On Hold User.
\r
289 The response is either a UserMusicOnHoldUserGetResponse16 or an
\r
291 </xs:documentation>
\r
293 <xs:complexContent>
\r
294 <xs:extension base="core:OCIRequest">
\r
296 <xs:element name="userId" type="UserId"/>
\r
299 </xs:complexContent>
\r
302 <xs:complexType name="UserMusicOnHoldUserGetResponse20">
\r
305 Response to UserMusicOnHoldUserGetRequest20.
\r
306 </xs:documentation>
\r
308 <xs:complexContent>
\r
309 <xs:extension base="core:OCIDataResponse">
\r
311 <xs:element name="enableVideo" type="xs:boolean"/>
\r
312 <xs:element name="source" type="MusicOnHoldUserSourceRead20"/>
\r
313 <xs:element name="useAlternateSourceForInternalCalls" type="xs:boolean"/>
\r
314 <xs:element name="internalSource" type="MusicOnHoldUserSourceRead20" minOccurs="0"/>
\r
317 </xs:complexContent>
\r
320 <xs:complexType name="UserMusicOnHoldUserModifyRequest20">
\r
323 Modify data for Music On Hold User.
\r
324 The response is either a SuccessResponse or an
\r
326 </xs:documentation>
\r
328 <xs:complexContent>
\r
329 <xs:extension base="core:OCIRequest">
\r
331 <xs:element name="userId" type="UserId"/>
\r
332 <xs:element name="source" type="MusicOnHoldUserSourceModify20" minOccurs="0"/>
\r
333 <xs:element name="useAlternateSourceForInternalCalls" type="xs:boolean" minOccurs="0"/>
\r
334 <xs:element name="internalSource" type="MusicOnHoldUserSourceModify20" minOccurs="0"/>
\r
337 </xs:complexContent>
\r
340 <xs:simpleType name="MusicOnHoldDelayMilliseconds">
\r
343 Delay in milliseconds.
\r
344 </xs:documentation>
\r
346 <xs:restriction base="xs:int">
\r
347 <xs:minInclusive value="0"/>
\r
348 <xs:maxInclusive value="5000"/>
\r
352 <xs:simpleType name="MusicOnHoldMessageSelection">
\r
355 Music On Hold Message Selection.
\r
356 </xs:documentation>
\r
358 <xs:restriction base="xs:token">
\r
359 <xs:enumeration value="System"/>
\r
360 <xs:enumeration value="External"/>
\r
361 <xs:enumeration value="Custom"/>
\r
365 <xs:complexType name="MusicOnHoldSourceAdd21">
\r
368 Contains the music on hold source configuration.
\r
369 The following elements are only used in HSS data mode and ignored in AS data mode:
\r
371 The following elements are only used in AS data mode and ignored in HSS data mode:
\r
372 announcementMediaFiles
\r
373 </xs:documentation>
\r
376 <xs:element name="audioFilePreferredCodec" type="AudioFileCodecExtended"/>
\r
377 <xs:element name="messageSourceSelection" type="MusicOnHoldMessageSelection"/>
\r
378 <xs:choice minOccurs="0">
\r
379 <xs:element name="labeledCustomSourceMediaFiles">
\r
383 <xs:element name="audioFile" type="LabeledMediaFileResource" minOccurs="0"/>
\r
384 <xs:element name="videoFile" type="LabeledMediaFileResource" minOccurs="0"/>
\r
388 <xs:element name="announcementCustomSourceMediaFiles">
\r
392 <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0"/>
\r
393 <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0"/>
\r
398 <xs:element name="externalSource" minOccurs="0">
\r
402 <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointAdd"/>
\r
409 <xs:complexType name="MusicOnHoldSourceRead21">
\r
412 Contains the music on hold source configuration.
\r
413 The following elements are only used in HSS data mode and not returned in AS data mode:
\r
414 labeledCustomSourceMediaFiles
\r
415 The following elements are only used in AS data mode and not returned in HSS data mode:
\r
416 announcementMediaFiles
\r
417 </xs:documentation>
\r
420 <xs:element name="audioFilePreferredCodec" type="AudioFileCodecExtended"/>
\r
421 <xs:element name="messageSourceSelection" type="MusicOnHoldMessageSelection"/>
\r
422 <xs:choice minOccurs="0">
\r
423 <xs:element name="labeledCustomSourceMediaFiles">
\r
427 <xs:element name="audioFileDescription" type="FileDescription" minOccurs="0"/>
\r
428 <xs:element name="audioMediaType" type="MediaFileType" minOccurs="0"/>
\r
429 <xs:element name="videoFileDescription" type="FileDescription" minOccurs="0"/>
\r
430 <xs:element name="videoMediaType" type="MediaFileType" minOccurs="0"/>
\r
434 <xs:element name="announcementCustomSourceMediaFiles">
\r
438 <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0"/>
\r
439 <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0"/>
\r
444 <xs:element name="externalSource" minOccurs="0">
\r
448 <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointWithPortNumberRead"/>
\r
455 <xs:complexType name="MusicOnHoldSourceModify21">
\r
458 Contains the music on hold source configuration.
\r
459 The following elements are only used in HSS data mode and ignored in AS data mode:
\r
461 The following elements are only used in AS data mode and ignored in HSS data mode:
\r
462 announcementMediaFiles
\r
463 </xs:documentation>
\r
466 <xs:element name="audioFilePreferredCodec" type="AudioFileCodecExtended" minOccurs="0"/>
\r
467 <xs:element name="messageSourceSelection" type="MusicOnHoldMessageSelection" minOccurs="0"/>
\r
468 <xs:choice minOccurs="0">
\r
469 <xs:element name="labeledCustomSourceMediaFiles">
\r
473 <xs:element name="audioFile" type="LabeledMediaFileResource" minOccurs="0"/>
\r
474 <xs:element name="videoFile" type="LabeledMediaFileResource" minOccurs="0"/>
\r
478 <xs:element name="announcementCustomSourceMediaFiles">
\r
482 <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0" nillable="true"/>
\r
483 <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0" nillable="true"/>
\r
488 <xs:element name="externalSource" minOccurs="0">
\r
492 <xs:element name="accessDeviceEndpoint" type="AccessDeviceEndpointModify" nillable="true"/>
\r
499 <xs:simpleType name="MusicOnHoldUserMessageSelection">
\r
502 Music On Hold User Message Selection.
\r
503 </xs:documentation>
\r
505 <xs:restriction base="xs:token">
\r
506 <xs:enumeration value="Group"/>
\r
507 <xs:enumeration value="Custom"/>
\r
511 <xs:complexType name="MusicOnHoldUserSourceModify20">
\r
514 Contains the music on hold user source configuration.
\r
515 </xs:documentation>
\r
518 <xs:element name="messageSourceSelection" type="MusicOnHoldUserMessageSelection" minOccurs="0"/>
\r
519 <xs:element name="customSource" minOccurs="0">
\r
523 <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0" nillable="true"/>
\r
524 <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0" nillable="true"/>
\r
531 <xs:complexType name="MusicOnHoldUserSourceRead20">
\r
534 Contains the music on hold user source configuration.
\r
535 </xs:documentation>
\r
538 <xs:element name="messageSourceSelection" type="MusicOnHoldUserMessageSelection"/>
\r
539 <xs:element name="customSource" minOccurs="0">
\r
543 <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0"/>
\r
544 <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0"/>
\r