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 <!-- C O L L A B O R A T 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
24 <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>
\r
26 <!-- ********************************************************************************** -->
\r
27 <!-- C O L L A B O R A T E 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 GroupCollaborateBridgeAddInstanceRequest
\r
36 GroupCollaborateBridgeDeleteInstanceRequest
\r
37 GroupCollaborateBridgeGetAvailableUserListRequest
\r
38 GroupCollaborateBridgeGetInstanceListRequest
\r
39 GroupCollaborateBridgeGetInstanceRequest
\r
40 GroupCollaborateBridgeModifyInstanceRequest
\r
41 SystemCollaborateGetRequest
\r
42 SystemCollaborateModifyRequest
\r
43 UserCollaborateBridgeGetRequest
\r
44 UserCollaborateInstantRoomParametersGetRequest
\r
45 UserCollaborateInstantRoomParametersModifyRequest
\r
46 UserCollaborateProjectRoomAddRequest
\r
47 UserCollaborateInstantRoomAddRequest
\r
48 UserCollaborateDeleteRoomRequest
\r
49 UserCollaborateMyRoomGetRequest
\r
50 UserCollaborateProjectRoomGetRequest
\r
51 UserCollaborateInstantRoomGetRequest
\r
52 UserCollaborateMyRoomModifyRequest
\r
53 UserCollaborateProjectRoomModifyRequest
\r
54 UserCollaborateRoomIDRegenerateRequest
\r
55 UserCollaborateRoomListGetRequest
\r
59 <xs:complexType name="GroupCollaborateBridgeAddInstanceRequest">
\r
62 <asDataModeSupported>true</asDataModeSupported>
\r
63 <hssDataModeSupported>false</hssDataModeSupported>
\r
66 Add a collaborate bridge to a group.
\r
67 The domain is required in the serviceUserId.
\r
68 The request fails when supportOutdial is enabled and the system-level collaborate supportOutdial setting is disabled.
\r
69 The response is either SuccessResponse or ErrorResponse.
\r
73 <xs:extension base="core:OCIRequest">
\r
75 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
76 <xs:element name="groupId" type="GroupId"/>
\r
77 <xs:element name="serviceUserId" type="UserId"/>
\r
78 <xs:element name="serviceInstanceProfile" type="ServiceInstanceAddProfile"/>
\r
79 <xs:element name="maximumBridgeParticipants" type="CollaborateBridgeMaximumParticipants"/>
\r
80 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
81 <xs:element name="maxCollaborateRoomParticipants" type="CollaborateRoomMaximumParticipants"/>
\r
82 <xs:element name="supportOutdial" type="xs:boolean"/>
\r
83 <xs:element name="collaborateOwnerUserId" type="UserId" minOccurs="0" maxOccurs="unbounded"/>
\r
86 </xs:complexContent>
\r
89 <xs:complexType name="GroupCollaborateBridgeDeleteInstanceRequest">
\r
92 <asDataModeSupported>true</asDataModeSupported>
\r
93 <hssDataModeSupported>false</hssDataModeSupported>
\r
96 Delete a collaborate bridge from a group.
\r
97 The request fails when attempting to delete the default collaborate bridge.
\r
98 The response is either SuccessResponse or ErrorResponse.
\r
101 <xs:complexContent>
\r
102 <xs:extension base="core:OCIRequest">
\r
104 <xs:element name="serviceUserId" type="UserId"/>
\r
107 </xs:complexContent>
\r
110 <xs:complexType name="GroupCollaborateBridgeGetAvailableUserListRequest">
\r
113 <asDataModeSupported>true</asDataModeSupported>
\r
114 <hssDataModeSupported>false</hssDataModeSupported>
\r
117 Get a list of users with the Collaborate – Audio service assigned that can be assigned to a collaborate bridge. For an Enterprise Group this will include all users in the group’s enterprise.
\r
118 The SearchCriteriaExactUserGroup parameter is only applicable for enterprise groups.
\r
119 The response is either GroupCollaborateBridgeGetAvailableUserListResponse 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
126 <xs:element name="groupId" type="GroupId"/>
\r
127 <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>
\r
128 <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>
\r
129 <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>
\r
130 <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>
\r
131 <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>
\r
132 <xs:element name="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>
\r
133 <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>
\r
134 <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>
\r
137 </xs:complexContent>
\r
140 <xs:complexType name="GroupCollaborateBridgeGetAvailableUserListResponse">
\r
143 <asDataModeSupported>true</asDataModeSupported>
\r
144 <hssDataModeSupported>false</hssDataModeSupported>
\r
147 Response to the GroupCollaborateBridgeGetAvailableUserListRequest.
\r
148 Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", and "Hiragana First Name",
\r
149 "Phone Number", "Extension", "Department", "Email Address".
\r
150 </xs:documentation>
\r
152 <xs:complexContent>
\r
153 <xs:extension base="core:OCIDataResponse">
\r
155 <xs:element name="userTable" type="core:OCITable"/>
\r
158 </xs:complexContent>
\r
161 <xs:complexType name="GroupCollaborateBridgeGetInstanceListRequest">
\r
164 <asDataModeSupported>true</asDataModeSupported>
\r
165 <hssDataModeSupported>false</hssDataModeSupported>
\r
168 Get a list of collaborate bridges within a group.
\r
169 The response is either GroupCollaborateBridgeGetInstanceListResponse or ErrorResponse.
\r
170 It is possible to get the instances within a specified department.
\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="departmentName" type="DepartmentName" minOccurs="0"/>
\r
181 </xs:complexContent>
\r
184 <xs:complexType name="GroupCollaborateBridgeGetInstanceListResponse">
\r
187 <asDataModeSupported>true</asDataModeSupported>
\r
188 <hssDataModeSupported>false</hssDataModeSupported>
\r
191 Response to the GroupCollaborateBridgeGetInstanceListRequest.
\r
192 Contains a table with column headings: "Service User Id", "Name", "Phone Number", "Extension", "Department", "Participants", and "Is Default".
\r
193 The column values for "Is default" can either be true, or false.
\r
194 </xs:documentation>
\r
196 <xs:complexContent>
\r
197 <xs:extension base="core:OCIDataResponse">
\r
199 <xs:element name="collaborateBridgeTable" type="core:OCITable"/>
\r
202 </xs:complexContent>
\r
205 <xs:complexType name="GroupCollaborateBridgeGetInstanceRequest">
\r
208 <asDataModeSupported>true</asDataModeSupported>
\r
209 <hssDataModeSupported>false</hssDataModeSupported>
\r
212 Request to get all the information of a collaborate bridge.
\r
213 The response is either GroupCollaborateBridgeGetInstanceResponse or ErrorResponse.
\r
214 </xs:documentation>
\r
216 <xs:complexContent>
\r
217 <xs:extension base="core:OCIRequest">
\r
219 <xs:element name="serviceUserId" type="UserId"/>
\r
222 </xs:complexContent>
\r
225 <xs:complexType name="GroupCollaborateBridgeGetInstanceResponse">
\r
228 <asDataModeSupported>true</asDataModeSupported>
\r
229 <hssDataModeSupported>false</hssDataModeSupported>
\r
232 Response to GroupCollaborateBridgeGetInstanceRequest.
\r
233 The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate
\r
234 supportOutdial setting is disabled.
\r
235 Contains the service profile information and a table of assigned owners.
\r
236 The table has column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name",
\r
237 "Hiragana First Name", Phone Number", "Extension", "Department", "Email Address".
\r
238 Collaborate bridge maximum participant’s choices unlimited or a quantified number of participants.
\r
239 </xs:documentation>
\r
241 <xs:complexContent>
\r
242 <xs:extension base="core:OCIDataResponse">
\r
244 <xs:element name="serviceInstanceProfile" type="ServiceInstanceReadProfile19sp1"/>
\r
245 <xs:element name="maximumBridgeParticipants" type="CollaborateBridgeMaximumParticipants"/>
\r
246 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
247 <xs:element name="isDefault" type="xs:boolean"/>
\r
248 <xs:element name="maxCollaborateRoomParticipants" type="CollaborateRoomMaximumParticipants"/>
\r
249 <xs:element name="supportOutdial" type="xs:boolean"/>
\r
250 <xs:element name="collaborateOwnerUserTable" type="core:OCITable" nillable="true" minOccurs="0"/>
\r
253 </xs:complexContent>
\r
256 <xs:complexType name="GroupCollaborateBridgeModifyInstanceRequest">
\r
259 <asDataModeSupported>true</asDataModeSupported>
\r
260 <hssDataModeSupported>false</hssDataModeSupported>
\r
263 Request to modify a Collaborate bridge.
\r
264 The request fails when the collaborateOwnerUserIdList is included in the request for the default collaborate bridge.
\r
265 The request fails when the supportOutdial is included in the request and the system-level collaborate supportOutdial setting is disabled.
\r
266 The response is either SuccessResponse or ErrorResponse.
\r
267 </xs:documentation>
\r
269 <xs:complexContent>
\r
270 <xs:extension base="core:OCIRequest">
\r
272 <xs:element name="serviceUserId" type="UserId"/>
\r
273 <xs:element name="serviceInstanceProfile" type="ServiceInstanceModifyProfile" minOccurs="0"/>
\r
274 <xs:element name="maximumBridgeParticipants" type="CollaborateBridgeMaximumParticipants" minOccurs="0"/>
\r
275 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
276 <xs:element name="maxCollaborateRoomParticipants" type="CollaborateRoomMaximumParticipants" minOccurs="0"/>
\r
277 <xs:element name="supportOutdial" type="xs:boolean" minOccurs="0"/>
\r
278 <xs:element name="collaborateOwnerUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>
\r
281 </xs:complexContent>
\r
284 <xs:complexType name="SystemCollaborateGetRequest">
\r
287 <asDataModeSupported>true</asDataModeSupported>
\r
288 <hssDataModeSupported>false</hssDataModeSupported>
\r
291 Request the system level data associated with collaborate services.
\r
292 The response is either a SystemCollaborateGetResponse or an ErrorResponse.
\r
293 </xs:documentation>
\r
295 <xs:complexContent>
\r
296 <xs:extension base="core:OCIRequest">
\r
299 </xs:complexContent>
\r
302 <xs:complexType name="SystemCollaborateGetResponse">
\r
305 <asDataModeSupported>true</asDataModeSupported>
\r
306 <hssDataModeSupported>false</hssDataModeSupported>
\r
309 Response to SystemCollaborateGetRequest.
\r
310 </xs:documentation>
\r
312 <xs:complexContent>
\r
313 <xs:extension base="core:OCIDataResponse">
\r
315 <xs:element name="collaborateRoomIdLength" type="CollaboratePassCodeLength"/>
\r
316 <xs:element name="instantRoomIdleTimeoutSeconds" type="CollaborateInstantRoomIdleTimeoutSeconds"/>
\r
317 <xs:element name="collaborateRoomMaximumDurationMinutes" type="CollaborateRoomMaximumDurationMinutes"/>
\r
318 <xs:element name="supportOutdial" type="xs:boolean"/>
\r
319 <xs:element name="maxCollaborateRoomParticipants" type="CollaborateRoomMaximumParticipants"/>
\r
320 <xs:element name="collaborateActiveTalkerRefreshIntervalSeconds" type="CollaborateActiveTalkerRefreshIntervalSeconds"/>
\r
321 <xs:element name="terminateCollaborateAfterGracePeriod" type="xs:boolean"/>
\r
322 <xs:element name="collaborateGracePeriod" type="CollaborateGracePeriodDuration"/>
\r
323 <xs:element name="enableActiveCollaborateNotification" type="xs:boolean"/>
\r
324 <xs:element name="collaborateFromAddress" type="EmailAddress" minOccurs="0"/>
\r
327 </xs:complexContent>
\r
330 <xs:complexType name="SystemCollaborateModifyRequest">
\r
333 <asDataModeSupported>true</asDataModeSupported>
\r
334 <hssDataModeSupported>false</hssDataModeSupported>
\r
337 Modify the system level data associated with collaborate services.
\r
338 The response is either a SuccessResponse or an ErrorResponse.
\r
339 </xs:documentation>
\r
341 <xs:complexContent>
\r
342 <xs:extension base="core:OCIRequest">
\r
344 <xs:element name="collaborateRoomIdLength" type="CollaboratePassCodeLength" minOccurs="0"/>
\r
345 <xs:element name="instantRoomIdleTimeoutSeconds" type="CollaborateInstantRoomIdleTimeoutSeconds" minOccurs="0"/>
\r
346 <xs:element name="collaborateRoomMaximumDurationMinutes" type="CollaborateRoomMaximumDurationMinutes" minOccurs="0"/>
\r
347 <xs:element name="supportOutdial" type="xs:boolean" minOccurs="0"/>
\r
348 <xs:element name="maxCollaborateRoomParticipants" type="CollaborateRoomMaximumParticipants" minOccurs="0"/>
\r
349 <xs:element name="collaborateActiveTalkerRefreshIntervalSeconds" type="CollaborateActiveTalkerRefreshIntervalSeconds" minOccurs="0"/>
\r
350 <xs:element name="terminateCollaborateAfterGracePeriod" type="xs:boolean" minOccurs="0"/>
\r
351 <xs:element name="collaborateGracePeriod" type="CollaborateGracePeriodDuration" minOccurs="0"/>
\r
352 <xs:element name="enableActiveCollaborateNotification" type="xs:boolean" minOccurs="0"/>
\r
353 <xs:element name="collaborateFromAddress" type="EmailAddress" nillable="true" minOccurs="0"/>
\r
356 </xs:complexContent>
\r
359 <xs:complexType name="UserCollaborateBridgeGetRequest">
\r
362 <asDataModeSupported>true</asDataModeSupported>
\r
363 <hssDataModeSupported>false</hssDataModeSupported>
\r
366 Request the collaborate bridged assigned to the user. The user can only be assigned to one collaborate bridge at any given time.
\r
367 The response is either UserCollaborateBridgeGetResponse or
\r
369 </xs:documentation>
\r
371 <xs:complexContent>
\r
372 <xs:extension base="core:OCIRequest">
\r
374 <xs:element name="userId" type="UserId"/>
\r
377 </xs:complexContent>
\r
380 <xs:complexType name="UserCollaborateBridgeGetResponse">
\r
383 <asDataModeSupported>true</asDataModeSupported>
\r
384 <hssDataModeSupported>false</hssDataModeSupported>
\r
387 The system-level collaborate supportOutdial setting is returned in the response when the system-level collaborate supportOutdial setting is disabled.
\r
388 Response to UserCollaborateBridgeGetRequest.
\r
389 </xs:documentation>
\r
391 <xs:complexContent>
\r
392 <xs:extension base="core:OCIDataResponse">
\r
394 <xs:element name="bridgeId" type="UserId"/>
\r
395 <xs:element name="bridgeName" type="CollaborateBridgeName"/>
\r
396 <xs:element name="phoneNumber" type="DN" minOccurs="0"/>
\r
397 <xs:element name="extension" type="Extension17" minOccurs="0"/>
\r
398 <xs:element name="alternateNumberEntry" type="AlternateNumberEntry21" minOccurs="0" maxOccurs="unbounded"/>
\r
399 <xs:element name="supportOutDial" type="xs:boolean"/>
\r
400 <xs:element name="maxCollaborateRoomParticipants" type="CollaborateRoomMaximumParticipants"/>
\r
403 </xs:complexContent>
\r
406 <xs:complexType name="UserCollaborateInstantRoomParametersGetRequest">
\r
409 <asDataModeSupported>true</asDataModeSupported>
\r
410 <hssDataModeSupported>false</hssDataModeSupported>
\r
413 Request collaborate instant room settings.
\r
414 The response is either UserCollaborateInstantRoomParametersGetResponse or
\r
416 </xs:documentation>
\r
418 <xs:complexContent>
\r
419 <xs:extension base="core:OCIRequest">
\r
421 <xs:element name="userId" type="UserId"/>
\r
424 </xs:complexContent>
\r
427 <xs:complexType name="UserCollaborateInstantRoomParametersGetResponse">
\r
430 <asDataModeSupported>true</asDataModeSupported>
\r
431 <hssDataModeSupported>false</hssDataModeSupported>
\r
434 Response to UserCollaborateInstantRoomParametersGetRequest.
\r
435 </xs:documentation>
\r
437 <xs:complexContent>
\r
438 <xs:extension base="core:OCIDataResponse">
\r
440 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification"/>
\r
441 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean"/>
\r
442 <xs:element name="ownerRequired" type="xs:boolean"/>
\r
445 </xs:complexContent>
\r
448 <xs:complexType name="UserCollaborateInstantRoomParametersModifyRequest">
\r
451 <asDataModeSupported>true</asDataModeSupported>
\r
452 <hssDataModeSupported>false</hssDataModeSupported>
\r
455 Request to modify collaborate instant room settings.
\r
456 The response is either SuccessResponse or ErrorResponse.
\r
457 </xs:documentation>
\r
459 <xs:complexContent>
\r
460 <xs:extension base="core:OCIRequest">
\r
462 <xs:element name="userId" type="UserId"/>
\r
463 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification" minOccurs="0"/>
\r
464 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean" minOccurs="0"/>
\r
465 <xs:element name="ownerRequired" type="xs:boolean" minOccurs="0"/>
\r
468 </xs:complexContent>
\r
471 <xs:complexType name="UserCollaborateProjectRoomAddRequest">
\r
474 <asDataModeSupported>true</asDataModeSupported>
\r
475 <hssDataModeSupported>false</hssDataModeSupported>
\r
478 Request to add collaborate project room.
\r
479 The response is either a UserCollaborateProjectRoomAddResponse or an ErrorResponse.
\r
480 </xs:documentation>
\r
482 <xs:complexContent>
\r
483 <xs:extension base="core:OCIRequest">
\r
485 <xs:element name="userId" type="UserId"/>
\r
486 <xs:element name="roomName" type="CollaborateRoomName"/>
\r
487 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification"/>
\r
488 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean"/>
\r
489 <xs:element name="ownerRequired" type="xs:boolean"/>
\r
490 <xs:element name="roomSchedule" type="CollaborateRoomSchedule"/>
\r
493 </xs:complexContent>
\r
496 <xs:complexType name="UserCollaborateProjectRoomAddResponse">
\r
499 <asDataModeSupported>true</asDataModeSupported>
\r
500 <hssDataModeSupported>false</hssDataModeSupported>
\r
503 Response to UserCollaborateProjectRoomAddRequest.
\r
504 </xs:documentation>
\r
506 <xs:complexContent>
\r
507 <xs:extension base="core:OCIDataResponse">
\r
509 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
512 </xs:complexContent>
\r
515 <xs:complexType name="UserCollaborateInstantRoomAddRequest">
\r
518 <asDataModeSupported>true</asDataModeSupported>
\r
519 <hssDataModeSupported>false</hssDataModeSupported>
\r
522 Request to add collaborate instant room.
\r
523 The response is either a UserCollaborateInstantRoomAddResponse or an ErrorResponse.
\r
524 </xs:documentation>
\r
526 <xs:complexContent>
\r
527 <xs:extension base="core:OCIRequest">
\r
529 <xs:element name="userId" type="UserId"/>
\r
531 <xs:element name="roomName" type="CollaborateRoomName"/>
\r
532 <xs:element name="useRoomIdAsRoomName" type="xs:boolean" fixed="true"/>
\r
536 </xs:complexContent>
\r
539 <xs:complexType name="UserCollaborateInstantRoomAddResponse">
\r
542 <asDataModeSupported>true</asDataModeSupported>
\r
543 <hssDataModeSupported>false</hssDataModeSupported>
\r
546 Response to UserCollaborateInstantRoomAddRequest.
\r
547 </xs:documentation>
\r
549 <xs:complexContent>
\r
550 <xs:extension base="core:OCIDataResponse">
\r
552 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
555 </xs:complexContent>
\r
558 <xs:complexType name="UserCollaborateDeleteRoomRequest">
\r
561 <asDataModeSupported>true</asDataModeSupported>
\r
562 <hssDataModeSupported>false</hssDataModeSupported>
\r
565 Request to delete a collaborate room. The request only applies to project rooms and instant rooms.
\r
566 The request fails when deleting a collaborate My Room.
\r
567 The response is either SuccessResponse or ErrorResponse.
\r
568 </xs:documentation>
\r
570 <xs:complexContent>
\r
571 <xs:extension base="core:OCIRequest">
\r
573 <xs:element name="userId" type="UserId"/>
\r
574 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
577 </xs:complexContent>
\r
580 <xs:complexType name="UserCollaborateMyRoomGetRequest">
\r
583 <asDataModeSupported>true</asDataModeSupported>
\r
584 <hssDataModeSupported>false</hssDataModeSupported>
\r
587 Request collaborate room settings for MyRoom.
\r
588 The response is either UserCollaboratMyRoomGetResponse or
\r
590 </xs:documentation>
\r
592 <xs:complexContent>
\r
593 <xs:extension base="core:OCIRequest">
\r
595 <xs:element name="userId" type="UserId"/>
\r
598 </xs:complexContent>
\r
601 <xs:complexType name="UserCollaborateMyRoomGetResponse">
\r
604 <asDataModeSupported>true</asDataModeSupported>
\r
605 <hssDataModeSupported>false</hssDataModeSupported>
\r
608 Response to UserCollaborateMyRoomGetRequest.
\r
609 </xs:documentation>
\r
611 <xs:complexContent>
\r
612 <xs:extension base="core:OCIDataResponse">
\r
614 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
615 <xs:element name="roomName" type="CollaborateRoomName"/>
\r
616 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification"/>
\r
617 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean"/>
\r
618 <xs:element name="ownerRequired" type="xs:boolean"/>
\r
621 </xs:complexContent>
\r
624 <xs:complexType name="UserCollaborateProjectRoomGetRequest">
\r
627 <asDataModeSupported>true</asDataModeSupported>
\r
628 <hssDataModeSupported>false</hssDataModeSupported>
\r
631 Request collaborate room settings for a project room.
\r
632 The request fails when requesting collaborate room settings for instant rooms or My Room.
\r
633 The response is either UserCollaboratProjectRoomGetResponse or
\r
635 </xs:documentation>
\r
637 <xs:complexContent>
\r
638 <xs:extension base="core:OCIRequest">
\r
640 <xs:element name="userId" type="UserId"/>
\r
641 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
644 </xs:complexContent>
\r
647 <xs:complexType name="UserCollaborateProjectRoomGetResponse">
\r
650 <asDataModeSupported>true</asDataModeSupported>
\r
651 <hssDataModeSupported>false</hssDataModeSupported>
\r
654 Response to UserCollaborateProjectRoomGetRequest.
\r
655 </xs:documentation>
\r
657 <xs:complexContent>
\r
658 <xs:extension base="core:OCIDataResponse">
\r
660 <xs:element name="roomName" type="CollaborateRoomName"/>
\r
661 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification"/>
\r
662 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean"/>
\r
663 <xs:element name="ownerRequired" type="xs:boolean"/>
\r
664 <xs:element name="roomSchedule" type="CollaborateRoomSchedule"/>
\r
667 </xs:complexContent>
\r
670 <xs:complexType name="UserCollaborateInstantRoomGetRequest">
\r
673 <asDataModeSupported>true</asDataModeSupported>
\r
674 <hssDataModeSupported>false</hssDataModeSupported>
\r
677 Request the collaborate room settings for an instant room.
\r
678 The request fails when requesting collaborate room settings for My Room or project rooms.
\r
679 The response is either UserCollaboratInstantRoomGetResponse or
\r
681 </xs:documentation>
\r
683 <xs:complexContent>
\r
684 <xs:extension base="core:OCIRequest">
\r
686 <xs:element name="userId" type="UserId"/>
\r
687 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
690 </xs:complexContent>
\r
693 <xs:complexType name="UserCollaborateInstantRoomGetResponse">
\r
696 <asDataModeSupported>true</asDataModeSupported>
\r
697 <hssDataModeSupported>false</hssDataModeSupported>
\r
700 Response to UserCollaborateInstantRoomGetRequest.
\r
701 </xs:documentation>
\r
703 <xs:complexContent>
\r
704 <xs:extension base="core:OCIDataResponse">
\r
706 <xs:element name="roomName" type="CollaborateRoomName" minOccurs="0"/>
\r
707 <xs:element name="instantRoomStartTime" type="xs:dateTime"/>
\r
708 <xs:element name="instantRoomEndTime" type="xs:dateTime"/>
\r
711 </xs:complexContent>
\r
714 <xs:complexType name="UserCollaborateMyRoomModifyRequest">
\r
717 <asDataModeSupported>true</asDataModeSupported>
\r
718 <hssDataModeSupported>false</hssDataModeSupported>
\r
721 Request to modify collaborate room settings for MyRoom.
\r
722 The response is either SuccessResponse or ErrorResponse.
\r
723 </xs:documentation>
\r
725 <xs:complexContent>
\r
726 <xs:extension base="core:OCIRequest">
\r
728 <xs:element name="userId" type="UserId"/>
\r
729 <xs:element name="roomName" type="CollaborateRoomName" minOccurs="0"/>
\r
730 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification" minOccurs="0"/>
\r
731 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean" minOccurs="0"/>
\r
732 <xs:element name="ownerRequired" type="xs:boolean" minOccurs="0"/>
\r
735 </xs:complexContent>
\r
738 <xs:complexType name="UserCollaborateProjectRoomModifyRequest">
\r
741 <asDataModeSupported>true</asDataModeSupported>
\r
742 <hssDataModeSupported>false</hssDataModeSupported>
\r
745 Request to modify collaborate room settings for a project room.
\r
746 The request fails when modifying collaborate room settings for instant rooms or My Room.
\r
747 The response is either SuccessResponse or ErrorResponse.
\r
748 </xs:documentation>
\r
750 <xs:complexContent>
\r
751 <xs:extension base="core:OCIRequest">
\r
753 <xs:element name="userId" type="UserId"/>
\r
754 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
755 <xs:element name="roomName" type="CollaborateRoomName" minOccurs="0"/>
\r
756 <xs:element name="attendeeNotification" type="CollaborateRoomAttendeeNotification" minOccurs="0"/>
\r
757 <xs:element name="endCollaborateRoomSessionOnOwnerExit" type="xs:boolean" minOccurs="0"/>
\r
758 <xs:element name="ownerRequired" type="xs:boolean" minOccurs="0"/>
\r
759 <xs:element name="roomSchedule" type="CollaborateRoomSchedule" minOccurs="0"/>
\r
762 </xs:complexContent>
\r
765 <xs:complexType name="UserCollaborateRoomIDRegenerateRequest">
\r
768 <asDataModeSupported>true</asDataModeSupported>
\r
769 <hssDataModeSupported>false</hssDataModeSupported>
\r
772 Request to regenerate collaborate room id for MyRoom and project room.
\r
773 The request fails when requesting to regenerate room ID for an instant room.
\r
774 The response is either a UserCollaborateRoomIDRegenerateResponse or an
\r
776 </xs:documentation>
\r
778 <xs:complexContent>
\r
779 <xs:extension base="core:OCIRequest">
\r
781 <xs:element name="userId" type="UserId"/>
\r
782 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
785 </xs:complexContent>
\r
788 <xs:complexType name="UserCollaborateRoomIDRegenerateResponse">
\r
791 <asDataModeSupported>true</asDataModeSupported>
\r
792 <hssDataModeSupported>false</hssDataModeSupported>
\r
795 Response to UserCollaborateRoomIDRegenerateRequest.
\r
796 </xs:documentation>
\r
798 <xs:complexContent>
\r
799 <xs:extension base="core:OCIDataResponse">
\r
801 <xs:element name="roomId" type="CollaborateRoomId"/>
\r
804 </xs:complexContent>
\r
807 <xs:complexType name="UserCollaborateRoomListGetRequest">
\r
810 <asDataModeSupported>true</asDataModeSupported>
\r
811 <hssDataModeSupported>false</hssDataModeSupported>
\r
814 Request the list of collaborate room instances for this specific user.
\r
815 The response is either a UserCollaborateRoomListGetResponse or an
\r
817 </xs:documentation>
\r
819 <xs:complexContent>
\r
820 <xs:extension base="core:OCIRequest">
\r
822 <xs:element name="userId" type="UserId"/>
\r
825 </xs:complexContent>
\r
828 <xs:complexType name="UserCollaborateRoomListGetResponse">
\r
831 <asDataModeSupported>true</asDataModeSupported>
\r
832 <hssDataModeSupported>false</hssDataModeSupported>
\r
835 Response to UserCollaborateRoomListGetRequest.
\r
836 Contains a table with column headings : "Room Type", "Name", "Room Id",
\r
837 in a row for each collaborate room instance.
\r
838 Possible values for Room Type column are MyRoom, Project Room and
\r
840 </xs:documentation>
\r
842 <xs:complexContent>
\r
843 <xs:extension base="core:OCIDataResponse">
\r
845 <xs:element name="roomInstanceTable" type="core:OCITable"/>
\r
848 </xs:complexContent>
\r
851 <xs:simpleType name="CollaborateActiveTalkerRefreshIntervalSeconds">
\r
854 The Interval in seconds at which, the UVS will refresh and notify active talker details..
\r
855 </xs:documentation>
\r
857 <xs:restriction base="xs:int">
\r
858 <xs:minInclusive value="1"/>
\r
859 <xs:maxInclusive value="5"/>
\r
863 <xs:complexType name="CollaborateBridgeMaximumParticipants">
\r
866 Maximum number of Collaborate bridge participants. Can either be unlimited or limited to a value between 3 and 999999.
\r
867 </xs:documentation>
\r
870 <xs:element name="unlimited" type="xs:boolean" fixed="true"/>
\r
871 <xs:element name="quantity">
\r
874 <xs:restriction base="xs:int">
\r
875 <xs:minInclusive value="3"/>
\r
876 <xs:maxInclusive value="999999"/>
\r
883 <xs:simpleType name="CollaborateBridgeName">
\r
886 Collaborate bridge name.
\r
887 </xs:documentation>
\r
889 <xs:restriction base="xs:token">
\r
890 <xs:minLength value="1"/>
\r
891 <xs:maxLength value="40"/>
\r
895 <xs:complexType name="CollaborateGracePeriodDuration">
\r
898 Collaborate grace period duration.
\r
899 </xs:documentation>
\r
902 <xs:element name="hours" type="Hour"/>
\r
903 <xs:element name="minutes" type="CollaborateGracePeriodDurationMinutes"/>
\r
907 <xs:simpleType name="CollaborateGracePeriodDurationMinutes">
\r
910 Collaborate grace period duration minutes.
\r
911 </xs:documentation>
\r
913 <xs:restriction base="xs:int">
\r
914 <xs:pattern value="0|15|30|45"/>
\r
918 <xs:simpleType name="CollaborateInstantRoomExpirationSeconds">
\r
921 The expiration period in seconds for an instant room to exist.
\r
922 </xs:documentation>
\r
924 <xs:restriction base="xs:int">
\r
925 <xs:minInclusive value="1"/>
\r
926 <xs:maxInclusive value="524700"/>
\r
930 <xs:simpleType name="CollaborateInstantRoomIdleTimeoutSeconds">
\r
933 The time in seconds the instant room lives without a participant, the wait
\r
934 time for the first participant to join and the wait time after the last
\r
935 participant leaves the collaborate room.
\r
936 </xs:documentation>
\r
938 <xs:restriction base="xs:int">
\r
939 <xs:minInclusive value="1"/>
\r
940 <xs:maxInclusive value="3600"/>
\r
944 <xs:simpleType name="CollaboratePassCodeLength">
\r
947 Length of the collaborate room Id.
\r
948 </xs:documentation>
\r
950 <xs:restriction base="xs:int">
\r
951 <xs:minInclusive value="4"/>
\r
952 <xs:maxInclusive value="15"/>
\r
956 <xs:simpleType name="CollaborateRoomAttendeeNotification">
\r
959 Choices for the notification when attendees join or leave the collaborate room session.
\r
960 </xs:documentation>
\r
962 <xs:restriction base="xs:token">
\r
963 <xs:enumeration value="Play Tone"/>
\r
964 <xs:enumeration value="No Notification"/>
\r
968 <xs:simpleType name="CollaborateRoomId">
\r
971 Collaborate room id.
\r
972 </xs:documentation>
\r
974 <xs:restriction base="xs:token">
\r
975 <xs:minLength value="4"/>
\r
976 <xs:maxLength value="15"/>
\r
980 <xs:simpleType name="CollaborateRoomMaximumParticipants">
\r
983 Maximum number of collaborate room participants.
\r
984 </xs:documentation>
\r
986 <xs:restriction base="xs:int">
\r
987 <xs:minInclusive value="3"/>
\r
988 <xs:maxInclusive value="30"/>
\r
992 <xs:simpleType name="CollaborateRoomName">
\r
995 Collaborate room name.
\r
996 </xs:documentation>
\r
998 <xs:restriction base="xs:token">
\r
999 <xs:minLength value="1"/>
\r
1000 <xs:maxLength value="40"/>
\r
1004 <xs:complexType name="CollaborateRoomSchedule">
\r
1006 <xs:documentation>
\r
1007 Collaborate room schedule.
\r
1008 </xs:documentation>
\r
1012 <xs:element name="scheduleReservationless">
\r
1016 <xs:element name="startTime" type="xs:dateTime"/>
\r
1017 <xs:element name="endTime" type="xs:dateTime" nillable="true"/>
\r
1021 <xs:element name="scheduleOneTime">
\r
1025 <xs:element name="startTime" type="xs:dateTime"/>
\r
1026 <xs:element name="duration" type="CollaborateRoomScheduleDuration"/>
\r
1030 <xs:element name="scheduleRecurring">
\r
1034 <xs:element name="startTime" type="xs:dateTime"/>
\r
1035 <xs:element name="duration" type="CollaborateRoomScheduleDuration"/>
\r
1036 <xs:element name="recurrence" type="Recurrence"/>
\r
1042 </xs:complexType>
\r
1044 <xs:complexType name="CollaborateRoomScheduleDuration">
\r
1046 <xs:documentation>
\r
1047 Collaborate room schedule duration.
\r
1048 </xs:documentation>
\r
1051 <xs:element name="hours" type="Hour"/>
\r
1052 <xs:element name="minutes" type="CollaborateRoomScheduleDurationMinutes"/>
\r
1054 </xs:complexType>
\r
1056 <xs:simpleType name="CollaborateRoomScheduleDurationMinutes">
\r
1058 <xs:documentation>
\r
1059 Collaborate room schedule duration minutes.
\r
1060 </xs:documentation>
\r
1062 <xs:restriction base="xs:int">
\r
1063 <xs:pattern value="0|15|30|45"/>
\r
1067 <xs:simpleType name="CollaborateRoomType">
\r
1069 <xs:documentation>
\r
1070 Choices for collaborate room type
\r
1071 </xs:documentation>
\r
1073 <xs:restriction base="xs:token">
\r
1074 <xs:enumeration value="Instant Room"/>
\r
1075 <xs:enumeration value="My Room"/>
\r
1076 <xs:enumeration value="Project Room"/>
\r
1080 <xs:simpleType name="CollaborateRoomMaximumDurationMinutes">
\r
1082 <xs:documentation>
\r
1083 The time in minutes of the maximum duration of the collaborate room session.
\r
1084 </xs:documentation>
\r
1086 <xs:restriction base="xs:int">
\r
1087 <xs:minInclusive value="1"/>
\r
1088 <xs:maxInclusive value="7200"/>
\r