share/OCISchemaAS/Services/OCISchemaServiceThirdPartyVoiceMailSupport.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 \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
   7 <!--                                                                        -->\r
   8 <!-- T H I R D   P A R T Y   V O I C E   M A I L                            -->\r
   9 <!-- S U P P O R T  S E R V I C E                                           -->\r
  10 <!--                                                                        -->\r
  11 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
  12 <!-- Open Client Interface (OCI).                                           -->\r
  13 <!-- ********************************************************************** -->\r
  14 \r
  15 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
  16            xmlns:core           = "C"\r
  17            xmlns                = ""\r
  18            attributeFormDefault = "qualified"\r
  19            elementFormDefault   = "qualified">\r
  20   \r
  21   <xs:import namespace      = "C"\r
  22              schemaLocation = "../OCISchemaBASE.xsd"/>\r
  23   \r
  24   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  25   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  26   \r
  27   <!-- ********************************************************************************** -->\r
  28   <!-- T H I R D   P A R T Y   V O I C E   M A I L   S U P P O R T                        -->\r
  29   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  30   <!-- ********************************************************************************** -->\r
  31   <!--\r
  32   Requests and responses are listed here in alphabetical order.\r
  33   The non-primitive attributes inside the commands are defined in another\r
  34   section of the schema.\r
  35 \r
  36   Requests in this schema file:\r
  37     UserThirdPartyVoiceMailSupportGetRequest17    \r
  38     UserThirdPartyVoiceMailSupportModifyRequest    \r
  39     GroupThirdPartyVoiceMailSupportGetRequest    \r
  40     GroupThirdPartyVoiceMailSupportModifyRequest    \r
  41     SystemThirdPartyVoiceMailSupportAddDnRequest    \r
  42     SystemThirdPartyVoiceMailSupportDeleteDnRequest    \r
  43     SystemThirdPartyVoiceMailSupportGetDnListRequest    \r
  44     SystemThirdPartyVoiceMailSupportModifyDnRequest    \r
  45     SystemThirdPartyVoiceMailSupportGetRequest17sp4    \r
  46     SystemThirdPartyVoiceMailSupportModifyRequest    \r
  47     \r
  48   --> \r
  49   \r
  50   <xs:complexType name="UserThirdPartyVoiceMailSupportGetRequest17">\r
  51     <xs:annotation>\r
  52       <xs:documentation>\r
  53         Request the user level data associated with Third-Party Voice Mail Support.\r
  54         The response is either a UserThirdPartyVoiceMailSupportGetResponse17 or an\r
  55         ErrorResponse.\r
  56       </xs:documentation>\r
  57     </xs:annotation>\r
  58     <xs:complexContent>\r
  59       <xs:extension base="core:OCIRequest">\r
  60         <xs:sequence>\r
  61           <xs:element name="userId" type="UserId"/>\r
  62         </xs:sequence>\r
  63       </xs:extension>\r
  64     </xs:complexContent>\r
  65   </xs:complexType>    \r
  66     \r
  67   <xs:complexType name="UserThirdPartyVoiceMailSupportGetResponse17">\r
  68     <xs:annotation>\r
  69       <xs:documentation>\r
  70         Response to UserThirdPartyVoiceMailSupportGetRequest17.\r
  71       </xs:documentation>\r
  72     </xs:annotation>\r
  73     <xs:complexContent>\r
  74       <xs:extension base="core:OCIDataResponse">\r
  75         <xs:sequence>\r
  76           <xs:element name="isActive" type="xs:boolean"/>\r
  77           <xs:element name="busyRedirectToVoiceMail" type="xs:boolean"/>\r
  78           <xs:element name="noAnswerRedirectToVoiceMail" type="xs:boolean"/>\r
  79           <xs:element name="serverSelection" type="ThirdPartyVoiceMailSupportServerSelection"/>\r
  80           <xs:element name="userServer" type="ThirdPartyVoiceMailSupportMailServer" minOccurs="0"/>\r
  81           <xs:element name="mailboxIdType" type="ThirdPartyVoiceMailSupportMailboxIdType"/>\r
  82           <xs:element name="mailboxURL" type="SIPURI" minOccurs="0"/>\r
  83           <xs:element name="noAnswerNumberOfRings" type="ThirdPartyVoiceMailSupportNumberOfRings"/>\r
  84           <xs:element name="alwaysRedirectToVoiceMail" type="xs:boolean"/>\r
  85           <xs:element name="outOfPrimaryZoneRedirectToVoiceMail" type="xs:boolean"/>\r
  86         </xs:sequence>\r
  87       </xs:extension>\r
  88     </xs:complexContent>\r
  89   </xs:complexType>    \r
  90     \r
  91   <xs:complexType name="UserThirdPartyVoiceMailSupportModifyRequest">\r
  92     <xs:annotation>\r
  93       <xs:documentation>\r
  94         Modify the Third Party Voice Mail Support settings for a user.\r
  95         The response is either a SuccessResponse or an ErrorResponse.\r
  96       </xs:documentation>\r
  97     </xs:annotation>\r
  98     <xs:complexContent>\r
  99       <xs:extension base="core:OCIRequest">\r
 100         <xs:sequence>\r
 101           <xs:element name="userId" type="UserId"/>\r
 102           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 103           <xs:element name="busyRedirectToVoiceMail" type="xs:boolean" minOccurs="0"/>\r
 104           <xs:element name="noAnswerRedirectToVoiceMail" type="xs:boolean" minOccurs="0"/>\r
 105           <xs:element name="serverSelection" type="ThirdPartyVoiceMailSupportServerSelection" minOccurs="0"/>\r
 106           <xs:element name="userServer" type="ThirdPartyVoiceMailSupportMailServer" nillable="true" minOccurs="0"/>\r
 107           <xs:element name="mailboxIdType" type="ThirdPartyVoiceMailSupportMailboxIdType" minOccurs="0"/>\r
 108           <xs:element name="mailboxURL" type="SIPURI" nillable="true" minOccurs="0"/>\r
 109           <xs:element name="noAnswerNumberOfRings" type="ThirdPartyVoiceMailSupportNumberOfRings" minOccurs="0"/>\r
 110           <xs:element name="alwaysRedirectToVoiceMail" type="xs:boolean" minOccurs="0"/>\r
 111           <xs:element name="outOfPrimaryZoneRedirectToVoiceMail" type="xs:boolean" minOccurs="0"/>\r
 112         </xs:sequence>\r
 113       </xs:extension>\r
 114     </xs:complexContent>\r
 115   </xs:complexType>    \r
 116     \r
 117   <xs:complexType name="GroupThirdPartyVoiceMailSupportGetRequest">\r
 118     <xs:annotation>\r
 119       <xs:documentation>\r
 120         Request the group level data associated with Third-Party Voice Mail Support.\r
 121         The response is either a GroupThirdPartyVoiceMailSupportGetResponse or an\r
 122         ErrorResponse.\r
 123       </xs:documentation>\r
 124     </xs:annotation>\r
 125     <xs:complexContent>\r
 126       <xs:extension base="core:OCIRequest">\r
 127         <xs:sequence>\r
 128           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 129           <xs:element name="groupId" type="GroupId"/>\r
 130         </xs:sequence>\r
 131       </xs:extension>\r
 132     </xs:complexContent>\r
 133   </xs:complexType>    \r
 134     \r
 135   <xs:complexType name="GroupThirdPartyVoiceMailSupportGetResponse">\r
 136     <xs:annotation>\r
 137       <xs:documentation>\r
 138         Response to GroupThirdPartyVoiceMailSupportGetRequest.\r
 139       </xs:documentation>\r
 140     </xs:annotation>\r
 141     <xs:complexContent>\r
 142       <xs:extension base="core:OCIDataResponse">\r
 143         <xs:sequence>\r
 144           <xs:element name="isActive" type="xs:boolean"/>\r
 145           <xs:element name="groupServer" type="ThirdPartyVoiceMailSupportMailServer" minOccurs="0"/>\r
 146         </xs:sequence>\r
 147       </xs:extension>\r
 148     </xs:complexContent>\r
 149   </xs:complexType>    \r
 150     \r
 151   <xs:complexType name="GroupThirdPartyVoiceMailSupportModifyRequest">\r
 152     <xs:annotation>\r
 153       <xs:documentation>\r
 154         Modify the Third Party Voice Mail Support settings for a group.\r
 155         The response is either a SuccessResponse or an ErrorResponse.\r
 156       </xs:documentation>\r
 157     </xs:annotation>\r
 158     <xs:complexContent>\r
 159       <xs:extension base="core:OCIRequest">\r
 160         <xs:sequence>\r
 161           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 162           <xs:element name="groupId" type="GroupId"/>\r
 163           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 164           <xs:element name="groupServer" type="ThirdPartyVoiceMailSupportMailServer" nillable="true" minOccurs="0"/>\r
 165         </xs:sequence>\r
 166       </xs:extension>\r
 167     </xs:complexContent>\r
 168   </xs:complexType>    \r
 169     \r
 170   <xs:complexType name="SystemThirdPartyVoiceMailSupportAddDnRequest">\r
 171     <xs:annotation>\r
 172       <xs:appinfo>\r
 173         <asDataModeSupported>true</asDataModeSupported>\r
 174         <hssDataModeSupported>false</hssDataModeSupported>\r
 175       </xs:appinfo>\r
 176       <xs:documentation>\r
 177        Request to add a ThirdPartyVoiceMailSupport User DN to the system.\r
 178        The response is either a SuccessResponse or an ErrorResponse.\r
 179      </xs:documentation>\r
 180     </xs:annotation>\r
 181     <xs:complexContent>\r
 182       <xs:extension base="core:OCIRequest">\r
 183         <xs:sequence>\r
 184           <xs:element name="phoneNumber" type="DN"/>\r
 185           <xs:element name="description" type="ThirdPartyVoiceMailDestinationDescription" minOccurs="0"/>\r
 186         </xs:sequence>\r
 187       </xs:extension>\r
 188     </xs:complexContent>\r
 189   </xs:complexType>    \r
 190     \r
 191   <xs:complexType name="SystemThirdPartyVoiceMailSupportDeleteDnRequest">\r
 192     <xs:annotation>\r
 193       <xs:appinfo>\r
 194         <asDataModeSupported>true</asDataModeSupported>\r
 195         <hssDataModeSupported>false</hssDataModeSupported>\r
 196       </xs:appinfo>\r
 197       <xs:documentation>\r
 198        Request to delete a ThirdPartyVoiceMailSupport User DN from the system.\r
 199        The response is either a SuccessResponse or an ErrorResponse.\r
 200      </xs:documentation>\r
 201     </xs:annotation>\r
 202     <xs:complexContent>\r
 203       <xs:extension base="core:OCIRequest">\r
 204         <xs:sequence>\r
 205           <xs:element name="phoneNumber" type="DN"/>\r
 206         </xs:sequence>\r
 207       </xs:extension>\r
 208     </xs:complexContent>\r
 209   </xs:complexType>    \r
 210     \r
 211   <xs:complexType name="SystemThirdPartyVoiceMailSupportGetDnListRequest">\r
 212     <xs:annotation>\r
 213       <xs:appinfo>\r
 214         <asDataModeSupported>true</asDataModeSupported>\r
 215         <hssDataModeSupported>false</hssDataModeSupported>\r
 216       </xs:appinfo>\r
 217       <xs:documentation>\r
 218        Request to get a list of ThirdPartyVoiceMailSupport User DN's defined in the system.\r
 219        The response is either a SystemThirdPartyVoiceMailSupportGetDnListResponse or an ErrorResponse.\r
 220        The search can be done using multiple criterion.\r
 221      </xs:documentation>\r
 222     </xs:annotation>\r
 223     <xs:complexContent>\r
 224       <xs:extension base="core:OCIRequest">\r
 225         <xs:sequence>\r
 226           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 227           <xs:element name="searchCriteriaSystemServiceDn" type="SearchCriteriaSystemServiceDn" minOccurs="0" maxOccurs="unbounded"/>\r
 228         </xs:sequence>\r
 229       </xs:extension>\r
 230     </xs:complexContent>\r
 231   </xs:complexType>    \r
 232     \r
 233   <xs:complexType name="SystemThirdPartyVoiceMailSupportGetDnListResponse">\r
 234     <xs:annotation>\r
 235       <xs:appinfo>\r
 236         <asDataModeSupported>true</asDataModeSupported>\r
 237         <hssDataModeSupported>false</hssDataModeSupported>\r
 238       </xs:appinfo>\r
 239       <xs:documentation>\r
 240        Response to SystemThirdPartyVoiceMailSupportGetDnListRequest.\r
 241        Contains a table with a row for each ThirdPartyVoiceMailSupport User DN and column headings:\r
 242        "Phone Number", "Description"\r
 243      </xs:documentation>\r
 244     </xs:annotation>\r
 245     <xs:complexContent>\r
 246       <xs:extension base="core:OCIDataResponse">\r
 247         <xs:sequence>\r
 248           <xs:element name="thirdPartyVoiceMailSupportTable" type="core:OCITable"/>\r
 249         </xs:sequence>\r
 250       </xs:extension>\r
 251     </xs:complexContent>\r
 252   </xs:complexType>    \r
 253     \r
 254   <xs:complexType name="SystemThirdPartyVoiceMailSupportModifyDnRequest">\r
 255     <xs:annotation>\r
 256       <xs:appinfo>\r
 257         <asDataModeSupported>true</asDataModeSupported>\r
 258         <hssDataModeSupported>false</hssDataModeSupported>\r
 259       </xs:appinfo>\r
 260       <xs:documentation>\r
 261        Request to modify a ThirdPartyVoiceMailSupport User DN and description in the system.\r
 262        The response is either a SuccessResponse or an ErrorResponse.\r
 263      </xs:documentation>\r
 264     </xs:annotation>\r
 265     <xs:complexContent>\r
 266       <xs:extension base="core:OCIRequest">\r
 267         <xs:sequence>\r
 268           <xs:element name="phoneNumber" type="DN"/>\r
 269           <xs:element name="description" type="ThirdPartyVoiceMailDestinationDescription" nillable="true" minOccurs="0"/>\r
 270         </xs:sequence>\r
 271       </xs:extension>\r
 272     </xs:complexContent>\r
 273   </xs:complexType>    \r
 274     \r
 275   <xs:simpleType name="ThirdPartyVoiceMailSupportServerSelection">\r
 276     <xs:annotation>\r
 277       <xs:documentation>\r
 278         Third Party Voice Mail user-level voice mail server choices.\r
 279       </xs:documentation>\r
 280     </xs:annotation>\r
 281     <xs:restriction base="xs:token">\r
 282       <xs:enumeration value="Group Mail Server"/>\r
 283       <xs:enumeration value="User Specific Mail Server"/>\r
 284     </xs:restriction>\r
 285   </xs:simpleType>    \r
 286     \r
 287   <xs:simpleType name="ThirdPartyVoiceMailSupportMailboxIdType">\r
 288     <xs:annotation>\r
 289       <xs:documentation>\r
 290         Mailbox Id type on Third Party Voice Mail platform.\r
 291       </xs:documentation>\r
 292     </xs:annotation>\r
 293     <xs:restriction base="xs:token">\r
 294       <xs:enumeration value="User Or Group Phone Number"/>\r
 295       <xs:enumeration value="URL"/>\r
 296     </xs:restriction>\r
 297   </xs:simpleType>    \r
 298     \r
 299   <xs:simpleType name="ThirdPartyVoiceMailSupportMailServer">\r
 300     <xs:annotation>\r
 301       <xs:documentation>\r
 302         Uniquely identifies an external voice mail server.\r
 303       </xs:documentation>\r
 304     </xs:annotation>\r
 305     <xs:restriction base="xs:token">\r
 306       <xs:minLength value="1"/>\r
 307       <xs:maxLength value="161"/>\r
 308     </xs:restriction>\r
 309   </xs:simpleType>    \r
 310     \r
 311   <xs:simpleType name="ThirdPartyVoiceMailSupportNumberOfRings">\r
 312     <xs:annotation>\r
 313       <xs:documentation>\r
 314         Number of Rings until call is redirected to voice mail.\r
 315       </xs:documentation>\r
 316     </xs:annotation>\r
 317     <xs:restriction base="xs:int">\r
 318       <xs:enumeration value="0"/>\r
 319       <xs:enumeration value="2"/>\r
 320       <xs:enumeration value="3"/>\r
 321       <xs:enumeration value="4"/>\r
 322       <xs:enumeration value="5"/>\r
 323       <xs:enumeration value="6"/>\r
 324       <xs:enumeration value="7"/>\r
 325       <xs:enumeration value="8"/>\r
 326       <xs:enumeration value="9"/>\r
 327       <xs:enumeration value="10"/>\r
 328       <xs:enumeration value="11"/>\r
 329       <xs:enumeration value="12"/>\r
 330       <xs:enumeration value="13"/>\r
 331       <xs:enumeration value="14"/>\r
 332       <xs:enumeration value="15"/>\r
 333       <xs:enumeration value="16"/>\r
 334       <xs:enumeration value="17"/>\r
 335       <xs:enumeration value="18"/>\r
 336       <xs:enumeration value="19"/>\r
 337       <xs:enumeration value="20"/>\r
 338     </xs:restriction>\r
 339   </xs:simpleType>    \r
 340     \r
 341   <xs:complexType name="SystemThirdPartyVoiceMailSupportGetRequest17sp4">\r
 342     <xs:annotation>\r
 343       <xs:appinfo>\r
 344         <asDataModeSupported>true</asDataModeSupported>\r
 345         <hssDataModeSupported>false</hssDataModeSupported>\r
 346       </xs:appinfo>\r
 347       <xs:documentation>\r
 348         Request the system level data associated with Third-party Voice Mail Support.\r
 349         The response is either a SystemThirdPartyVoiceMailSupportGetResponse17sp4 or an\r
 350         ErrorResponse.\r
 351       </xs:documentation>\r
 352     </xs:annotation>\r
 353     <xs:complexContent>\r
 354       <xs:extension base="core:OCIRequest">\r
 355         <xs:sequence/>\r
 356       </xs:extension>\r
 357     </xs:complexContent>\r
 358   </xs:complexType>    \r
 359     \r
 360   <xs:complexType name="SystemThirdPartyVoiceMailSupportGetResponse17sp4">\r
 361     <xs:annotation>\r
 362       <xs:appinfo>\r
 363         <asDataModeSupported>true</asDataModeSupported>\r
 364         <hssDataModeSupported>false</hssDataModeSupported>\r
 365       </xs:appinfo>\r
 366       <xs:documentation>\r
 367         Response to SystemThirdPartyVoiceMailSupportGetRequest17sp4.\r
 368       </xs:documentation>\r
 369     </xs:annotation>\r
 370     <xs:complexContent>\r
 371       <xs:extension base="core:OCIDataResponse">\r
 372         <xs:sequence>\r
 373           <xs:element name="overrideAltCallerIdForVMRetrieval" type="xs:boolean"/>\r
 374           <xs:element name="stripDiversionOnVMDestinationRetrieval" type="xs:boolean"/>\r
 375         </xs:sequence>\r
 376       </xs:extension>\r
 377     </xs:complexContent>\r
 378   </xs:complexType>    \r
 379     \r
 380   <xs:complexType name="SystemThirdPartyVoiceMailSupportModifyRequest">\r
 381     <xs:annotation>\r
 382       <xs:documentation>\r
 383         Modify the system level data associated with Third-party Voice Mail Support.\r
 384         The response is either a SuccessResponse or an ErrorResponse.\r
 385         \r
 386         The following elements are only used in AS data mode:\r
 387           stripDiversionOnVMDestinationRetrieval   \r
 388       </xs:documentation>\r
 389     </xs:annotation>\r
 390     <xs:complexContent>\r
 391       <xs:extension base="core:OCIRequest">\r
 392         <xs:sequence>\r
 393           <xs:element name="overrideAltCallerIdForVMRetrieval" type="xs:boolean" minOccurs="0"/>\r
 394           <xs:element name="stripDiversionOnVMDestinationRetrieval" type="xs:boolean" minOccurs="0"/>\r
 395         </xs:sequence>\r
 396       </xs:extension>\r
 397     </xs:complexContent>\r
 398   </xs:complexType>    \r
 399     \r
 400   <xs:simpleType name="ThirdPartyVoiceMailDestinationDescription">\r
 401     <xs:annotation>\r
 402       <xs:documentation>\r
 403         ThirdPartyVoiceMailSupport User DN's Description.\r
 404       </xs:documentation>\r
 405     </xs:annotation>\r
 406     <xs:restriction base="xs:token">\r
 407       <xs:minLength value="1"/>\r
 408       <xs:maxLength value="80"/>\r
 409     </xs:restriction>\r
 410   </xs:simpleType>    \r
 411     \r
 412 </xs:schema>\r