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 <!-- F I N D M E F O L L O W M 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 <!-- F I N D M E F O L L O W M 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 GroupFindMeFollowMeAddAlertingGroupRequest
\r
36 GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest
\r
37 GroupFindMeFollowMeAddInstanceRequest
\r
38 GroupFindMeFollowMeAlertingGroupGetAvailableUserListRequest
\r
39 GroupFindMeFollowMeDeleteAlertingGroupRequest
\r
40 GroupFindMeFollowMeDeleteAlertingGroupSelectiveCriteriaRequest
\r
41 GroupFindMeFollowMeDeleteInstanceRequest
\r
42 GroupFindMeFollowMeGetAlertingGroupListRequest
\r
43 GroupFindMeFollowMeGetAlertingGroupRequest
\r
44 GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21
\r
45 GroupFindMeFollowMeGetInstanceListRequest
\r
46 GroupFindMeFollowMeGetInstanceRequest19sp1
\r
47 GroupFindMeFollowMeModifyActiveInstanceListRequest
\r
48 GroupFindMeFollowMeModifyAlertingGroupListRequest
\r
49 GroupFindMeFollowMeModifyAlertingGroupRequest
\r
50 GroupFindMeFollowMeModifyAlertingGroupSelectiveCriteriaRequest
\r
51 GroupFindMeFollowMeModifyInstanceRequest
\r
55 <xs:complexType name="GroupFindMeFollowMeAddAlertingGroupRequest">
\r
58 Add an alerting group to a Find-me/Follow-me instance.
\r
59 The response is either SuccessResponse or ErrorResponse.
\r
63 <xs:extension base="core:OCIRequest">
\r
65 <xs:element name="serviceUserId" type="UserId"/>
\r
66 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
67 <xs:element name="alertingGroupDescription" type="FindMeFollowMeAlertingGroupDescription" minOccurs="0"/>
\r
68 <xs:element name="useDiversionInhibitor" type="xs:boolean"/>
\r
69 <xs:element name="answerConfirmationRequired" type="xs:boolean"/>
\r
70 <xs:element name="numberOfRings" type="FindMeFollowMeAlertingGroupNumberOfRings"/>
\r
71 <xs:choice minOccurs="0" maxOccurs="10">
\r
72 <xs:element name="phoneNumber" type="OutgoingDNorSIPURI"/>
\r
73 <xs:element name="userId" type="UserId"/>
\r
77 </xs:complexContent>
\r
80 <xs:complexType name="GroupFindMeFollowMeAddAlertingGroupSelectiveCriteriaRequest">
\r
83 Add a criteria to the Find-me/Follow-me alerting group.
\r
84 For the callToNumber, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails.
\r
85 The response is either a SuccessResponse or an ErrorResponse.
\r
89 <xs:extension base="core:OCIRequest">
\r
91 <xs:element name="serviceUserId" type="UserId"/>
\r
92 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
93 <xs:element name="criteriaName" type="CriteriaName"/>
\r
94 <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>
\r
95 <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>
\r
96 <xs:element name="blacklisted" type="xs:boolean"/>
\r
97 <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>
\r
98 <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>
\r
101 </xs:complexContent>
\r
104 <xs:complexType name="GroupFindMeFollowMeAddInstanceRequest">
\r
107 Add a Find-me/Follow-me instance to a group.
\r
108 The domain is required in the serviceUserId.
\r
109 The response is either SuccessResponse or ErrorResponse.
\r
110 </xs:documentation>
\r
112 <xs:complexContent>
\r
113 <xs:extension base="core:OCIRequest">
\r
115 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
116 <xs:element name="groupId" type="GroupId"/>
\r
117 <xs:element name="serviceUserId" type="UserId"/>
\r
118 <xs:element name="serviceInstanceProfile" type="ServiceInstanceAddProfile"/>
\r
119 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
122 </xs:complexContent>
\r
125 <xs:complexType name="GroupFindMeFollowMeAlertingGroupGetAvailableUserListRequest">
\r
128 Get a list of users that can be assigned to a Find-me/Follow-me alerting group.
\r
129 The response is either GroupFindMeFollowMeAlertingGroupGetAvailableUserListResponse or ErrorResponse.
\r
130 </xs:documentation>
\r
132 <xs:complexContent>
\r
133 <xs:extension base="core:OCIRequest">
\r
135 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
136 <xs:element name="groupId" type="GroupId"/>
\r
137 <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>
\r
138 <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>
\r
139 <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>
\r
140 <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>
\r
141 <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>
\r
142 <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>
\r
143 <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>
\r
146 </xs:complexContent>
\r
149 <xs:complexType name="GroupFindMeFollowMeAlertingGroupGetAvailableUserListResponse">
\r
152 Response to the GroupFindMeFollowMeAlertingGroupGetAvailableUserListRequest.
\r
153 Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name",
\r
154 "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".
\r
155 </xs:documentation>
\r
157 <xs:complexContent>
\r
158 <xs:extension base="core:OCIDataResponse">
\r
160 <xs:element name="userTable" type="core:OCITable"/>
\r
163 </xs:complexContent>
\r
166 <xs:complexType name="GroupFindMeFollowMeDeleteAlertingGroupRequest">
\r
169 Delete an alerting group from a Find-me/Follow-me 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="serviceUserId" type="UserId"/>
\r
177 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
180 </xs:complexContent>
\r
183 <xs:complexType name="GroupFindMeFollowMeDeleteAlertingGroupSelectiveCriteriaRequest">
\r
186 Delete a criteria from the Find-me/Follow-me alerting group.
\r
187 The response is either a SuccessResponse or an ErrorResponse.
\r
188 </xs:documentation>
\r
190 <xs:complexContent>
\r
191 <xs:extension base="core:OCIRequest">
\r
193 <xs:element name="serviceUserId" type="UserId"/>
\r
194 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
195 <xs:element name="criteriaName" type="CriteriaName"/>
\r
198 </xs:complexContent>
\r
201 <xs:complexType name="GroupFindMeFollowMeDeleteInstanceRequest">
\r
204 Delete a Find-me/Follow-me instance from a group.
\r
205 The response is either SuccessResponse or ErrorResponse.
\r
206 </xs:documentation>
\r
208 <xs:complexContent>
\r
209 <xs:extension base="core:OCIRequest">
\r
211 <xs:element name="serviceUserId" type="UserId"/>
\r
214 </xs:complexContent>
\r
217 <xs:complexType name="GroupFindMeFollowMeGetAlertingGroupListRequest">
\r
220 Get a list of Find-me/Follow-me alerting groups within a group.
\r
221 The response is either GroupFindMeFollowMeGetAlertingGroupListResponse or ErrorResponse.
\r
222 </xs:documentation>
\r
224 <xs:complexContent>
\r
225 <xs:extension base="core:OCIRequest">
\r
227 <xs:element name="serviceUserId" type="UserId"/>
\r
230 </xs:complexContent>
\r
233 <xs:complexType name="GroupFindMeFollowMeGetAlertingGroupListResponse">
\r
236 Response to the GroupFindMeFollowMeGetAlertingGroupListRequest.
\r
237 Contains a table with column headings:
\r
238 "Name", "Priority".
\r
239 </xs:documentation>
\r
241 <xs:complexContent>
\r
242 <xs:extension base="core:OCIDataResponse">
\r
244 <xs:element name="alertingGroupTable" type="core:OCITable"/>
\r
247 </xs:complexContent>
\r
250 <xs:complexType name="GroupFindMeFollowMeGetAlertingGroupRequest">
\r
253 Request to get all the information of a Find-me/Follow-me alerting group.
\r
254 The response is either GroupFindMeFollowMeGetAlertingGroupResponse or ErrorResponse.
\r
255 </xs:documentation>
\r
257 <xs:complexContent>
\r
258 <xs:extension base="core:OCIRequest">
\r
260 <xs:element name="serviceUserId" type="UserId"/>
\r
261 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
264 </xs:complexContent>
\r
267 <xs:complexType name="GroupFindMeFollowMeGetAlertingGroupResponse">
\r
270 Response to GroupFindMeFollowMeGetAlertingGroupRequest.
\r
271 Contains the alerting group information.
\r
272 The user table’s column headings are: "User Id", "Last Name", "First Name", "Hiragana Last Name" and "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".
\r
273 The criteria table's column headings are: "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule"", "Calls To Type", "Calls To Number" and "Calls To Extension".
\r
274 The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:
\r
276 - Alternate X (where x is a number between 1 and 10)
\r
277 The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:
\r
278 - 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
279 - When no number is available a blank space is provided instead.
\r
280 The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:
\r
281 - 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
282 - When no extension is available a blank space is provided instead.
\r
283 </xs:documentation>
\r
285 <xs:complexContent>
\r
286 <xs:extension base="core:OCIDataResponse">
\r
288 <xs:element name="alertingGroupDescription" type="FindMeFollowMeAlertingGroupDescription" minOccurs="0"/>
\r
289 <xs:element name="useDiversionInhibitor" type="xs:boolean"/>
\r
290 <xs:element name="answerConfirmationRequired" type="xs:boolean"/>
\r
291 <xs:element name="numberOfRings" type="FindMeFollowMeAlertingGroupNumberOfRings"/>
\r
292 <xs:element name="phoneNumber" type="OutgoingDNorSIPURI" minOccurs="0" maxOccurs="unbounded"/>
\r
293 <xs:element name="userTable" type="core:OCITable"/>
\r
294 <xs:element name="criteriaTable" type="core:OCITable"/>
\r
297 </xs:complexContent>
\r
300 <xs:complexType name="GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21">
\r
303 Request to get all the information of a specific Find-me/Follow-me alerting group selective criteria.
\r
304 The response is either GroupFindMeFollowMeGetAlertingGroupResponse21 or ErrorResponse.
\r
305 </xs:documentation>
\r
307 <xs:complexContent>
\r
308 <xs:extension base="core:OCIRequest">
\r
310 <xs:element name="serviceUserId" type="UserId"/>
\r
311 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
312 <xs:element name="criteriaName" type="CriteriaName"/>
\r
315 </xs:complexContent>
\r
318 <xs:complexType name="GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaResponse21">
\r
321 Response to GroupFindMeFollowMeGetAlertingGroupSelectiveCriteriaRequest21.
\r
322 Contains the alerting group selective criteria information.
\r
323 </xs:documentation>
\r
325 <xs:complexContent>
\r
326 <xs:extension base="core:OCIDataResponse">
\r
328 <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>
\r
329 <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>
\r
330 <xs:element name="blacklisted" type="xs:boolean"/>
\r
331 <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>
\r
332 <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>
\r
335 </xs:complexContent>
\r
338 <xs:complexType name="GroupFindMeFollowMeGetInstanceListRequest">
\r
341 Get a list of Find-me/Follow-me instances within a group.
\r
342 The response is either GroupFindMeFollowMeGetInstanceListResponse or ErrorResponse.
\r
343 It is possible to get the instances within a specified department.
\r
344 </xs:documentation>
\r
346 <xs:complexContent>
\r
347 <xs:extension base="core:OCIRequest">
\r
349 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
350 <xs:element name="groupId" type="GroupId"/>
\r
351 <xs:element name="groupDepartmentName" type="DepartmentName" minOccurs="0"/>
\r
354 </xs:complexContent>
\r
357 <xs:complexType name="GroupFindMeFollowMeGetInstanceListResponse">
\r
360 Response to the GroupFindMeFollowMeGetInstanceListRequest.
\r
361 Contains a table with column headings:
\r
362 "Service User Id", "Name", "Phone Number", "Extension", "Department", "Is Active".
\r
363 The column value for "Is Active" can either be true, or false.
\r
364 </xs:documentation>
\r
366 <xs:complexContent>
\r
367 <xs:extension base="core:OCIDataResponse">
\r
369 <xs:element name="findMeFollowMeTable" type="core:OCITable"/>
\r
372 </xs:complexContent>
\r
375 <xs:complexType name="GroupFindMeFollowMeGetInstanceRequest19sp1">
\r
378 Request to get all the information of a Find-me/Follow-me instance.
\r
379 The response is either GroupFindMeFollowMeGetInstanceResponse19sp1 or ErrorResponse.
\r
380 </xs:documentation>
\r
382 <xs:complexContent>
\r
383 <xs:extension base="core:OCIRequest">
\r
385 <xs:element name="serviceUserId" type="UserId"/>
\r
388 </xs:complexContent>
\r
391 <xs:complexType name="GroupFindMeFollowMeGetInstanceResponse19sp1">
\r
394 Response to GroupFindMeFollowMeGetInstanceRequest19sp1.
\r
395 Contains the service profile information.
\r
396 </xs:documentation>
\r
398 <xs:complexContent>
\r
399 <xs:extension base="core:OCIDataResponse">
\r
401 <xs:element name="serviceInstanceProfile" type="ServiceInstanceReadProfile19sp1"/>
\r
402 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
405 </xs:complexContent>
\r
408 <xs:complexType name="GroupFindMeFollowMeModifyActiveInstanceListRequest">
\r
411 Request to set the active status of Find-me/Follow-me instances.
\r
412 The response is either SuccessResponse or ErrorResponse.
\r
413 </xs:documentation>
\r
415 <xs:complexContent>
\r
416 <xs:extension base="core:OCIRequest">
\r
418 <xs:element name="serviceActivation" type="ServiceActivation" minOccurs="0" maxOccurs="unbounded"/>
\r
421 </xs:complexContent>
\r
424 <xs:complexType name="GroupFindMeFollowMeModifyAlertingGroupListRequest">
\r
427 Modify the priorities assigned to alerting groups
\r
428 The response is either a SuccessResponse or an ErrorResponse.
\r
429 NOTE: The command fails if all the alerting groups defined for the user are not provided.
\r
430 </xs:documentation>
\r
432 <xs:complexContent>
\r
433 <xs:extension base="core:OCIRequest">
\r
435 <xs:element name="serviceUserId" type="UserId"/>
\r
436 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName" minOccurs="0" maxOccurs="5"/>
\r
439 </xs:complexContent>
\r
442 <xs:complexType name="GroupFindMeFollowMeModifyAlertingGroupRequest">
\r
445 Modify a Find-me/Follow-me alerting group.
\r
446 The response is either SuccessResponse or ErrorResponse.
\r
447 </xs:documentation>
\r
449 <xs:complexContent>
\r
450 <xs:extension base="core:OCIRequest">
\r
452 <xs:element name="serviceUserId" type="UserId"/>
\r
453 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
454 <xs:element name="newAlertingGroupName" type="FindMeFollowMeAlertingGroupName" minOccurs="0"/>
\r
455 <xs:element name="alertingGroupDescription" type="FindMeFollowMeAlertingGroupDescription" minOccurs="0" nillable="true"/>
\r
456 <xs:element name="useDiversionInhibitor" type="xs:boolean" minOccurs="0"/>
\r
457 <xs:element name="answerConfirmationRequired" type="xs:boolean" minOccurs="0"/>
\r
458 <xs:element name="numberOfRings" type="FindMeFollowMeAlertingGroupNumberOfRings" minOccurs="0"/>
\r
459 <xs:element name="phoneNumberOrUserList" type="FindMeFollowMeAlertingGroupReplacementOutgoingDNSIPURIorUserIdList" nillable="true" minOccurs="0"/>
\r
460 <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>
\r
463 </xs:complexContent>
\r
466 <xs:complexType name="GroupFindMeFollowMeModifyAlertingGroupSelectiveCriteriaRequest">
\r
469 Modify a Find-me/Follow-me alerting group criteria.
\r
470 For the callToNumbers in the callToNumberList, the extension and number elements are not used and the only types accepted for each number are Primary and Alternates. If other type is specified the command fails.
\r
471 The response is either a SuccessResponse or an ErrorResponse.
\r
472 </xs:documentation>
\r
474 <xs:complexContent>
\r
475 <xs:extension base="core:OCIRequest">
\r
477 <xs:element name="serviceUserId" type="UserId"/>
\r
478 <xs:element name="alertingGroupName" type="FindMeFollowMeAlertingGroupName"/>
\r
479 <xs:element name="criteriaName" type="CriteriaName"/>
\r
480 <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>
\r
481 <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>
\r
482 <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>
\r
483 <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>
\r
484 <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>
\r
485 <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>
\r
488 </xs:complexContent>
\r
491 <xs:complexType name="GroupFindMeFollowMeModifyInstanceRequest">
\r
494 Request to modify a Find-me/Follow-me instance.
\r
495 The response is either SuccessResponse or ErrorResponse.
\r
496 </xs:documentation>
\r
498 <xs:complexContent>
\r
499 <xs:extension base="core:OCIRequest">
\r
501 <xs:element name="serviceUserId" type="UserId"/>
\r
502 <xs:element name="serviceInstanceProfile" type="ServiceInstanceModifyProfile" minOccurs="0"/>
\r
503 <xs:element name="networkClassOfService" type="NetworkClassOfServiceName" minOccurs="0"/>
\r
506 </xs:complexContent>
\r
509 <xs:simpleType name="FindMeFollowMeAlertingGroupDescription">
\r
512 Find-me/Follow-me alerting group description.
\r
513 </xs:documentation>
\r
515 <xs:restriction base="xs:token">
\r
516 <xs:minLength value="1"/>
\r
517 <xs:maxLength value="80"/>
\r
521 <xs:simpleType name="FindMeFollowMeAlertingGroupName">
\r
524 Find-me/Follow-me alerting group name.
\r
525 </xs:documentation>
\r
527 <xs:restriction base="xs:token">
\r
528 <xs:minLength value="1"/>
\r
529 <xs:maxLength value="40"/>
\r
533 <xs:simpleType name="FindMeFollowMeAlertingGroupNumberOfRings">
\r
536 Number of rings to wait for the current alerting group to answer before attempting the next alerting group.
\r
537 </xs:documentation>
\r
539 <xs:restriction base="xs:int">
\r
540 <xs:minInclusive value="2"/>
\r
541 <xs:maxInclusive value="20"/>
\r
545 <xs:complexType name="FindMeFollowMeAlertingGroupReplacementOutgoingDNSIPURIorUserIdList">
\r
548 A list of phone numbers/sipuris or user ids that replaces a previously configured list.
\r
549 By convention, an element of this type may be set nill to clear the list.
\r
550 </xs:documentation>
\r
553 <xs:choice minOccurs="0" maxOccurs="10">
\r
554 <xs:element name="phoneNumber" type="OutgoingDNorSIPURI"/>
\r
555 <xs:element name="userId" type="UserId"/>
\r