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 W I D E L I V E R Y T O M O B I L E -->
\r
9 <!-- E N D P O I N T S E R V I C E -->
\r
11 <!-- This file defines the XML Schema for the BroadSoft Application Server -->
\r
12 <!-- Open Client Interface (OCI). -->
\r
13 <!-- ********************************************************************** -->
\r
15 <xs:schema xmlns:xs = "http://www.w3.org/2001/XMLSchema"
\r
18 attributeFormDefault = "qualified"
\r
19 elementFormDefault = "qualified">
\r
21 <xs:import namespace = "C"
\r
22 schemaLocation = "../OCISchemaBASE.xsd"/>
\r
24 <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>
\r
26 <!-- ********************************************************************************** -->
\r
27 <!-- M W I D E L I V E R Y T O M O B I L E E N D P O I N T -->
\r
28 <!-- R E Q U E S T S A N D R E S P O N S E S -->
\r
29 <!-- ********************************************************************************** -->
\r
31 Requests and responses are listed here in alphabetical order.
\r
32 The non-primitive attributes inside the commands are defined in another
\r
33 section of the schema.
\r
35 Requests in this schema file:
\r
36 GroupMWIDeliveryToMobileEndpointGetRequest
\r
37 GroupMWIDeliveryToMobileEndpointModifyRequest
\r
38 GroupMWIDeliveryToMobileEndpointCustomTemplateAddRequest
\r
39 GroupMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest
\r
40 GroupMWIDeliveryToMobileEndpointCustomTemplateGetRequest
\r
41 GroupMWIDeliveryToMobileEndpointCustomTemplateModifyRequest
\r
42 ServiceProviderMWIDeliveryToMobileEndpointGetRequest
\r
43 ServiceProviderMWIDeliveryToMobileEndpointModifyRequest
\r
44 ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest
\r
45 ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest
\r
46 ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetRequest
\r
47 ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest
\r
48 UserMWIDeliveryToMobileEndpointGetRequest
\r
49 UserMWIDeliveryToMobileEndpointModifyRequest
\r
53 <xs:complexType name="GroupMWIDeliveryToMobileEndpointGetRequest">
\r
56 Requests group MWI custom notifications settings.
\r
57 The response is either a GroupMWIDeliveryToMobileEndpointGetResponse or an ErrorResponse.
\r
61 <xs:extension base="core:OCIRequest">
\r
63 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
64 <xs:element name="groupId" type="GroupId"/>
\r
67 </xs:complexContent>
\r
70 <xs:complexType name="GroupMWIDeliveryToMobileEndpointGetResponse">
\r
73 Response to GroupMWIDeliveryToMobileEndpointGetRequest.
\r
75 The templateActivationTable contains the list of templates defined for the group.
\r
76 The column headings are "Enable", "Language", "Type".
\r
81 <xs:extension base="core:OCIDataResponse">
\r
83 <xs:element name="useSettingLevel" type="MWIDeliveryToMobileEndpointGroupSettingLevel"/>
\r
84 <xs:element name="templateActivationTable" type="core:OCITable"/>
\r
87 </xs:complexContent>
\r
90 <xs:complexType name="GroupMWIDeliveryToMobileEndpointModifyRequest">
\r
93 Modify the group level MWI custom notifications settings.
\r
94 The response is either a SuccessResponse or an ErrorResponse.
\r
96 If the request is executed by a group administrator and modifies the useSettingLevel, the request is rejected.
\r
100 <xs:complexContent>
\r
101 <xs:extension base="core:OCIRequest">
\r
103 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
104 <xs:element name="groupId" type="GroupId"/>
\r
105 <xs:element name="useSettingLevel" type="MWIDeliveryToMobileEndpointGroupSettingLevel" minOccurs="0"/>
\r
106 <xs:element name="templateActivation" type="MWIDeliveryToMobileEndpointTemplateActivation" minOccurs="0" maxOccurs="unbounded"/>
\r
109 </xs:complexContent>
\r
112 <xs:complexType name="GroupMWIDeliveryToMobileEndpointCustomTemplateAddRequest">
\r
115 Create a MWI Delivery to Mobile Endpoint Custom Template.
\r
116 The response is either a SuccessResponse or an ErrorResponse.
\r
117 </xs:documentation>
\r
119 <xs:complexContent>
\r
120 <xs:extension base="core:OCIRequest">
\r
122 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
123 <xs:element name="groupId" type="GroupId"/>
\r
124 <xs:element name="language" type="Language"/>
\r
125 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
126 <xs:element name="isEnabled" type="xs:boolean"/>
\r
127 <xs:element name="templateBody" type="MWIDeliveryToMobileEndpointTemplateBody"/>
\r
130 </xs:complexContent>
\r
133 <xs:complexType name="GroupMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest">
\r
136 Delete a MWI Delivery to Mobile Endpoint Custom Template.
\r
137 The response is either a SuccessResponse or an ErrorResponse.
\r
138 </xs:documentation>
\r
140 <xs:complexContent>
\r
141 <xs:extension base="core:OCIRequest">
\r
143 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
144 <xs:element name="groupId" type="GroupId"/>
\r
145 <xs:element name="language" type="Language"/>
\r
146 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
149 </xs:complexContent>
\r
152 <xs:complexType name="GroupMWIDeliveryToMobileEndpointCustomTemplateGetRequest">
\r
155 Request a MWI Delivery to Mobile Endpoint Custom Template.
\r
156 The response is either a GroupMWIDeliveryToMobileEndpointCustomTemplateGetResponse or an ErrorResponse.
\r
157 </xs:documentation>
\r
159 <xs:complexContent>
\r
160 <xs:extension base="core:OCIRequest">
\r
162 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
163 <xs:element name="groupId" type="GroupId"/>
\r
164 <xs:element name="language" type="Language"/>
\r
165 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
168 </xs:complexContent>
\r
171 <xs:complexType name="GroupMWIDeliveryToMobileEndpointCustomTemplateGetResponse">
\r
174 Response to the GroupMWIDeliveryToMobileEndpointCustomTemplateGetRequest.
\r
175 </xs:documentation>
\r
177 <xs:complexContent>
\r
178 <xs:extension base="core:OCIDataResponse">
\r
180 <xs:element name="isEnabled" type="xs:boolean"/>
\r
181 <xs:element name="templateBody" type="MWIDeliveryToMobileEndpointTemplateBody"/>
\r
184 </xs:complexContent>
\r
187 <xs:complexType name="GroupMWIDeliveryToMobileEndpointCustomTemplateModifyRequest">
\r
190 Modify a MWI Delivery to Mobile Endpoint Custom Template.
\r
191 The response is either a SuccessResponse or an ErrorResponse.
\r
192 </xs:documentation>
\r
194 <xs:complexContent>
\r
195 <xs:extension base="core:OCIRequest">
\r
197 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
198 <xs:element name="groupId" type="GroupId"/>
\r
199 <xs:element name="language" type="Language"/>
\r
200 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
201 <xs:element name="isEnabled" type="xs:boolean" minOccurs="0"/>
\r
202 <xs:element name="templateBody" type="MWIDeliveryToMobileEndpointTemplateBody" minOccurs="0"/>
\r
205 </xs:complexContent>
\r
208 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointGetRequest">
\r
211 Request the service provider level data associated with MWI Delivery to Mobile Endpoint service.
\r
212 The response is either a ServiceProviderMWIDeliveryToMobileEndpointGetResponse or an ErrorResponse. </xs:documentation>
\r
214 <xs:complexContent>
\r
215 <xs:extension base="core:OCIRequest">
\r
217 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
220 </xs:complexContent>
\r
223 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointGetResponse">
\r
226 Response to ServiceProviderMWIDeliveryToMobileEndpointGetRequest.
\r
228 The templateActivationTable contains the list of templates defined for the service provider.
\r
229 The column headings are "Enable", "Language", "Type".
\r
230 </xs:documentation>
\r
232 <xs:complexContent>
\r
233 <xs:extension base="core:OCIDataResponse">
\r
235 <xs:element name="templateActivationTable" type="core:OCITable"/>
\r
238 </xs:complexContent>
\r
241 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointModifyRequest">
\r
244 Modify the service provider level MWI custom notifications settings.
\r
245 The response is either a SuccessResponse or an ErrorResponse.
\r
246 </xs:documentation>
\r
248 <xs:complexContent>
\r
249 <xs:extension base="core:OCIRequest">
\r
251 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
252 <xs:element name="templateActivation" type="MWIDeliveryToMobileEndpointTemplateActivation" minOccurs="0" maxOccurs="unbounded"/>
\r
255 </xs:complexContent>
\r
258 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateAddRequest">
\r
261 Create a MWI Delivery to Mobile Endpoint Custom Template.
\r
262 The response is either a SuccessResponse or an ErrorResponse.
\r
263 </xs:documentation>
\r
265 <xs:complexContent>
\r
266 <xs:extension base="core:OCIRequest">
\r
268 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
269 <xs:element name="language" type="Language"/>
\r
270 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
271 <xs:element name="isEnabled" type="xs:boolean"/>
\r
272 <xs:element name="templateBody" type="MWIDeliveryToMobileEndpointTemplateBody"/>
\r
275 </xs:complexContent>
\r
278 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateDeleteRequest">
\r
281 Delete a MWI Delivery to Mobile Endpoint Custom Template.
\r
282 The response is either a SuccessResponse or an ErrorResponse.
\r
283 </xs:documentation>
\r
285 <xs:complexContent>
\r
286 <xs:extension base="core:OCIRequest">
\r
288 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
289 <xs:element name="language" type="Language"/>
\r
290 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
293 </xs:complexContent>
\r
296 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetRequest">
\r
299 Request a MWI Delivery to Mobile Endpoint Custom Template.
\r
300 The response is either a ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetResponse or an ErrorResponse.
\r
301 </xs:documentation>
\r
303 <xs:complexContent>
\r
304 <xs:extension base="core:OCIRequest">
\r
306 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
307 <xs:element name="language" type="Language"/>
\r
308 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
311 </xs:complexContent>
\r
314 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetResponse">
\r
317 Response to the ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateGetRequest.
\r
318 </xs:documentation>
\r
320 <xs:complexContent>
\r
321 <xs:extension base="core:OCIDataResponse">
\r
323 <xs:element name="isEnabled" type="xs:boolean"/>
\r
324 <xs:element name="templateBody" type="MWIDeliveryToMobileEndpointTemplateBody"/>
\r
327 </xs:complexContent>
\r
330 <xs:complexType name="ServiceProviderMWIDeliveryToMobileEndpointCustomTemplateModifyRequest">
\r
333 Modify a MWI Delivery to Mobile Endpoint Custom Template.
\r
334 The response is either a SuccessResponse or an ErrorResponse.
\r
335 </xs:documentation>
\r
337 <xs:complexContent>
\r
338 <xs:extension base="core:OCIRequest">
\r
340 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
341 <xs:element name="language" type="Language"/>
\r
342 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
343 <xs:element name="isEnabled" type="xs:boolean" minOccurs="0"/>
\r
344 <xs:element name="templateBody" type="MWIDeliveryToMobileEndpointTemplateBody" minOccurs="0"/>
\r
347 </xs:complexContent>
\r
350 <xs:complexType name="UserMWIDeliveryToMobileEndpointGetRequest">
\r
353 Request the user level data associated with MWI Delivery to Mobile Endpoint service.
\r
354 The response is either a UserMWIDeliveryToMobileEndpointGetResponse or an ErrorResponse.
\r
355 </xs:documentation>
\r
357 <xs:complexContent>
\r
358 <xs:extension base="core:OCIRequest">
\r
360 <xs:element name="userId" type="UserId"/>
\r
363 </xs:complexContent>
\r
366 <xs:complexType name="UserMWIDeliveryToMobileEndpointGetResponse">
\r
369 Response to UserMWIDeliveryToMobileEndpointGetRequest.
\r
370 </xs:documentation>
\r
372 <xs:complexContent>
\r
373 <xs:extension base="core:OCIDataResponse">
\r
375 <xs:element name="isActive" type="xs:boolean"/>
\r
376 <xs:element name="mobilePhoneNumber" type="DN" minOccurs="0"/>
\r
379 </xs:complexContent>
\r
382 <xs:complexType name="UserMWIDeliveryToMobileEndpointModifyRequest">
\r
385 Request to modify the user level data associated with MWI Delivery to Mobile Endpoint service.
\r
386 The response is either a SuccessResponse or an ErrorResponse.
\r
387 </xs:documentation>
\r
389 <xs:complexContent>
\r
390 <xs:extension base="core:OCIRequest">
\r
392 <xs:element name="userId" type="UserId"/>
\r
393 <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>
\r
394 <xs:element name="mobilePhoneNumber" type="DN" nillable="true" minOccurs="0"/>
\r
397 </xs:complexContent>
\r
400 <xs:simpleType name="MWIDeliveryToMobileEndpointGroupSettingLevel">
\r
403 MWI Delivery To Mobile Endpoint setting for the group level.
\r
404 </xs:documentation>
\r
406 <xs:restriction base="xs:token">
\r
407 <xs:enumeration value="Service Provider"/>
\r
408 <xs:enumeration value="Group"/>
\r
412 <xs:complexType name="MWIDeliveryToMobileEndpointTemplateActivation">
\r
415 MWI Delivery To Mobile Endpoint enabled status indicator
\r
416 </xs:documentation>
\r
419 <xs:element name="language" type="Language"/>
\r
420 <xs:element name="type" type="MWIDeliveryToMobileEndpointTemplateType"/>
\r
421 <xs:element name="isEnabled" type="xs:boolean"/>
\r
425 <xs:complexType name="MWIDeliveryToMobileEndpointTemplateBody">
\r
428 MWI Delivery To Mobile Endpoint template body.
\r
429 </xs:documentation>
\r
432 <xs:element name="line" type="MWIDeliveryToMobileEndpointTemplateLine" maxOccurs="6"/>
\r
436 <xs:complexType name="MWIDeliveryToMobileEndpointTemplateLine">
\r
439 MWI Delivery To Mobile Endpoint template section associated with a specific tag.
\r
440 </xs:documentation>
\r
443 <xs:element name="prefix" type="MWIDeliveryToMobileEndpointTemplatePhrase" minOccurs="0"/>
\r
444 <xs:element name="tag" type="MWIDeliveryToMobileEndpointTemplateTag" minOccurs="0"/>
\r
445 <xs:element name="postfix" type="MWIDeliveryToMobileEndpointTemplatePhrase" minOccurs="0"/>
\r
449 <xs:simpleType name="MWIDeliveryToMobileEndpointTemplatePhrase">
\r
452 MWI Delivery To Mobile Endpoint template message body portion.
\r
453 </xs:documentation>
\r
455 <xs:restriction base="xs:string">
\r
456 <xs:whiteSpace value="preserve"/>
\r
457 <xs:minLength value="1"/>
\r
458 <xs:maxLength value="128"/>
\r
462 <xs:simpleType name="MWIDeliveryToMobileEndpointTemplateTag">
\r
465 MWI Delivery To Mobile Endpoint template tag.
\r
466 </xs:documentation>
\r
468 <xs:restriction base="xs:token">
\r
469 <xs:enumeration value="Voice Mail Number"/>
\r
470 <xs:enumeration value="New Messages Count"/>
\r
471 <xs:enumeration value="Total Messages Count"/>
\r
472 <xs:enumeration value="Caller Name"/>
\r
473 <xs:enumeration value="Caller Number"/>
\r
477 <xs:simpleType name="MWIDeliveryToMobileEndpointTemplateType">
\r
480 MWI Delivery To Mobile Endpoint template types.
\r
481 </xs:documentation>
\r
483 <xs:restriction base="xs:token">
\r
484 <xs:enumeration value="Default"/>
\r
485 <xs:enumeration value="Single New No Previous Message"/>
\r
486 <xs:enumeration value="Single New With Previous Message"/>
\r
487 <xs:enumeration value="Multiple New Messages"/>
\r