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 A L L P I C K U P 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 A L L P I C K U P 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 GroupCallPickupAddInstanceRequest
\r
36 GroupCallPickupDeleteInstanceRequest
\r
37 GroupCallPickupGetAvailableUserListRequest
\r
38 GroupCallPickupGetInstanceListRequest
\r
39 GroupCallPickupGetInstanceRequest
\r
40 GroupCallPickupModifyInstanceRequest
\r
41 UserCallPickupGetRequest
\r
45 <xs:complexType name="GroupCallPickupAddInstanceRequest">
\r
48 Adds a Call Pickup group.
\r
49 The response is either SuccessResponse or ErrorResponse.
\r
53 <xs:extension base="core:OCIRequest">
\r
55 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
56 <xs:element name="groupId" type="GroupId"/>
\r
57 <xs:element name="name" type="ServiceInstanceName"/>
\r
58 <xs:element name="userId" type="UserId" minOccurs="0" maxOccurs="unbounded"/>
\r
61 </xs:complexContent>
\r
64 <xs:complexType name="GroupCallPickupDeleteInstanceRequest">
\r
67 Deletes a Call Pickup group.
\r
68 The response is either SuccessResponse or ErrorResponse.
\r
72 <xs:extension base="core:OCIRequest">
\r
74 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
75 <xs:element name="groupId" type="GroupId"/>
\r
76 <xs:element name="name" type="ServiceInstanceName"/>
\r
79 </xs:complexContent>
\r
82 <xs:complexType name="GroupCallPickupGetAvailableUserListRequest">
\r
85 Get a list of users that can be assigned to a Call Pickup group.
\r
86 The available user list for a new Call Pickup group can be obtained
\r
87 by not setting the name.
\r
88 The response is either GroupCallPickupGetAvailableUserListResponse or ErrorResponse.
\r
92 <xs:extension base="core:OCIRequest">
\r
94 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
95 <xs:element name="groupId" type="GroupId"/>
\r
96 <xs:element name="name" type="ServiceInstanceName" minOccurs="0"/>
\r
97 <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>
\r
98 <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>
\r
99 <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>
\r
100 <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>
\r
101 <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>
\r
102 <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>
\r
103 <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>
\r
106 </xs:complexContent>
\r
109 <xs:complexType name="GroupCallPickupGetAvailableUserListResponse">
\r
112 Response to the GroupCallPickupGetAvailableUserListRequest.
\r
113 Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
\r
114 "Phone Number", "Extension", "Department", "Email Address".
\r
115 </xs:documentation>
\r
117 <xs:complexContent>
\r
118 <xs:extension base="core:OCIDataResponse">
\r
120 <xs:element name="userTable" type="core:OCITable"/>
\r
123 </xs:complexContent>
\r
126 <xs:complexType name="GroupCallPickupGetInstanceListRequest">
\r
129 Request to get a list of Call Pickup instances within a group.
\r
130 The response is either GroupCallPickupGetInstanceListResponse or ErrorResponse.
\r
131 </xs:documentation>
\r
133 <xs:complexContent>
\r
134 <xs:extension base="core:OCIRequest">
\r
136 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
137 <xs:element name="groupId" type="GroupId"/>
\r
140 </xs:complexContent>
\r
143 <xs:complexType name="GroupCallPickupGetInstanceListResponse">
\r
146 Response to the GroupCallPickupGetInstanceListRequest.
\r
147 </xs:documentation>
\r
149 <xs:complexContent>
\r
150 <xs:extension base="core:OCIDataResponse">
\r
152 <xs:element name="name" type="ServiceInstanceName" minOccurs="0" maxOccurs="unbounded"/>
\r
155 </xs:complexContent>
\r
158 <xs:complexType name="GroupCallPickupGetInstanceRequest">
\r
161 Gets a Call Pickup group.
\r
162 The response is either GroupCallPickupGetInstanceResponse or ErrorResponse.
\r
163 </xs:documentation>
\r
165 <xs:complexContent>
\r
166 <xs:extension base="core:OCIRequest">
\r
168 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
169 <xs:element name="groupId" type="GroupId"/>
\r
170 <xs:element name="name" type="ServiceInstanceName"/>
\r
173 </xs:complexContent>
\r
176 <xs:complexType name="GroupCallPickupGetInstanceResponse">
\r
179 Response to the GroupCallPickupGetInstanceRequest.
\r
180 Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",
\r
181 "Phone Number", "Extension", "Department", "Email Address".
\r
182 </xs:documentation>
\r
184 <xs:complexContent>
\r
185 <xs:extension base="core:OCIDataResponse">
\r
187 <xs:element name="userTable" type="core:OCITable"/>
\r
190 </xs:complexContent>
\r
193 <xs:complexType name="GroupCallPickupModifyInstanceRequest">
\r
196 Modifies a Call Pickup group. Replaces the entire list of users in the group.
\r
197 The response is either SuccessResponse or ErrorResponse.
\r
198 </xs:documentation>
\r
200 <xs:complexContent>
\r
201 <xs:extension base="core:OCIRequest">
\r
203 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
204 <xs:element name="groupId" type="GroupId"/>
\r
205 <xs:element name="name" type="ServiceInstanceName"/>
\r
206 <xs:element name="newName" type="ServiceInstanceName" minOccurs="0"/>
\r
207 <xs:element name="userIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>
\r
210 </xs:complexContent>
\r
213 <xs:complexType name="UserCallPickupGetRequest">
\r
216 Gets the details of the Call Pickup group that a user belongs to (if any).
\r
217 Any user can only belong to one Call Pickup group.
\r
218 The response is either UserCallPickupGetResponse or ErrorResponse.
\r
219 </xs:documentation>
\r
221 <xs:complexContent>
\r
222 <xs:extension base="core:OCIRequest">
\r
224 <xs:element name="userId" type="UserId"/>
\r
227 </xs:complexContent>
\r
230 <xs:complexType name="UserCallPickupGetResponse">
\r
233 Response to the UserCallPickupGetRequest.
\r
234 Identifies which Call Pickup group the user belongs to and the list of users in the group.
\r
235 Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name",
\r
236 "Hiragana First Name", "Department", "Phone Number", "Extension", "Email Address".
\r
237 </xs:documentation>
\r
239 <xs:complexContent>
\r
240 <xs:extension base="core:OCIDataResponse">
\r
242 <xs:element name="name" type="ServiceInstanceName" minOccurs="0"/>
\r
243 <xs:element name="userTable" type="core:OCITable"/>
\r
246 </xs:complexContent>
\r