share/OCISchemaAS/Services/OCISchemaServicePreAlertingAnnouncement.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 <!-- P R E   A L E R T I N G   A N N O U N C E M E N T  S E R V I C E       -->\r
   9 <!--                                                                        -->\r
  10 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
  11 <!-- Open Client Interface (OCI).                                           -->\r
  12 <!-- ********************************************************************** -->\r
  13 \r
  14 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
  15            xmlns:core           = "C"\r
  16            xmlns                = ""\r
  17            attributeFormDefault = "qualified"\r
  18            elementFormDefault   = "qualified">\r
  19   \r
  20   <xs:import namespace      = "C"\r
  21              schemaLocation = "../OCISchemaBASE.xsd"/>\r
  22   \r
  23   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  24   \r
  25   <!-- ********************************************************************************** -->\r
  26   <!-- P R E   A L E R T I N G   A N N O U N C E M E N T                                  -->\r
  27   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  28   <!-- ********************************************************************************** -->\r
  29   <!--\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
  33 \r
  34   Requests in this schema file:\r
  35     EnterprisePreAlertingAnnouncementGetRequest    \r
  36     EnterprisePreAlertingAnnouncementModifyRequest    \r
  37     GroupPreAlertingAnnouncementGetRequest20    \r
  38     GroupPreAlertingAnnouncementModifyRequest20    \r
  39     UserPreAlertingAnnouncementGetRequest20    \r
  40     UserPreAlertingAnnouncementModifyRequest20    \r
  41     UserPreAlertingAnnouncementAddCriteriaRequest    \r
  42     UserPreAlertingAnnouncementModifyCriteriaRequest    \r
  43     UserPreAlertingAnnouncementDeleteCriteriaRequest    \r
  44     UserPreAlertingAnnouncementGetCriteriaRequest21    \r
  45     \r
  46   --> \r
  47   \r
  48   <xs:complexType name="EnterprisePreAlertingAnnouncementGetRequest">\r
  49     <xs:annotation>\r
  50       <xs:documentation>\r
  51         Get the Enterprise pre-alerting service settings.\r
  52         The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse.\r
  53       </xs:documentation>\r
  54     </xs:annotation>\r
  55     <xs:complexContent>\r
  56       <xs:extension base="core:OCIRequest">\r
  57         <xs:sequence>\r
  58           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="EnterprisePreAlertingAnnouncementGetResponse">\r
  65     <xs:annotation>\r
  66       <xs:documentation>\r
  67         Get the Enterprise level pre-alerting service settings.\r
  68         The response is either a EnterprisePreAlertingAnnouncementGetResponse or an ErrorResponse.\r
  69       </xs:documentation>\r
  70     </xs:annotation>\r
  71     <xs:complexContent>\r
  72       <xs:extension base="core:OCIDataResponse">\r
  73         <xs:sequence>\r
  74           <xs:element name="announcementInterruption" type="PreAlertingAnnouncementInterrupt"/>\r
  75           <xs:element name="interruptionDigitSequence" type="PreAlertingAnnouncementInterruptDigits" minOccurs="0"/>\r
  76           <xs:element name="audioSelection" type="ExtendedFileResourceSelection"/>\r
  77           <xs:element name="audioFileDescription" type="FileDescription" minOccurs="0"/>\r
  78           <xs:element name="audioMediaType" type="MediaFileType" minOccurs="0"/>\r
  79           <xs:element name="audioFileUrl" type="URL" minOccurs="0"/>\r
  80           <xs:element name="videoSelection" type="ExtendedFileResourceSelection"/>\r
  81           <xs:element name="videoFileDescription" type="FileDescription" minOccurs="0"/>\r
  82           <xs:element name="videoMediaType" type="MediaFileType" minOccurs="0"/>\r
  83           <xs:element name="videoFileUrl" type="URL" minOccurs="0"/>\r
  84         </xs:sequence>\r
  85       </xs:extension>\r
  86     </xs:complexContent>\r
  87   </xs:complexType>    \r
  88     \r
  89   <xs:complexType name="EnterprisePreAlertingAnnouncementModifyRequest">\r
  90     <xs:annotation>\r
  91       <xs:documentation>\r
  92         Modify the enterprise level pre-alerting service settings.\r
  93         The response is either a SuccessResponse or an ErrorResponse.\r
  94       </xs:documentation>\r
  95     </xs:annotation>\r
  96     <xs:complexContent>\r
  97       <xs:extension base="core:OCIRequest">\r
  98         <xs:sequence>\r
  99           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 100           <xs:element name="announcementInterruption" type="PreAlertingAnnouncementInterrupt" minOccurs="0"/>\r
 101           <xs:element name="interruptionDigitSequence" type="PreAlertingAnnouncementInterruptDigits" minOccurs="0"/>\r
 102           <xs:element name="audioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 103           <xs:element name="audioFile" type="ExtendedMediaFileResource" minOccurs="0"/>\r
 104           <xs:element name="videoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 105           <xs:element name="videoFile" type="ExtendedMediaFileResource" minOccurs="0"/>\r
 106         </xs:sequence>\r
 107       </xs:extension>\r
 108     </xs:complexContent>\r
 109   </xs:complexType>    \r
 110     \r
 111   <xs:complexType name="GroupPreAlertingAnnouncementGetRequest20">\r
 112     <xs:annotation>\r
 113       <xs:documentation>\r
 114         Get the group’s PreAlertingservice settings.\r
 115         The response is either a GroupPreAlertingAnnouncementGetResponse20 or an ErrorResponse.\r
 116       </xs:documentation>\r
 117     </xs:annotation>\r
 118     <xs:complexContent>\r
 119       <xs:extension base="core:OCIRequest">\r
 120         <xs:sequence>\r
 121           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 122           <xs:element name="groupId" type="GroupId"/>\r
 123         </xs:sequence>\r
 124       </xs:extension>\r
 125     </xs:complexContent>\r
 126   </xs:complexType>    \r
 127     \r
 128   <xs:complexType name="GroupPreAlertingAnnouncementGetResponse20">\r
 129     <xs:annotation>\r
 130       <xs:documentation>\r
 131          Response to a GroupPreAlertingAnnouncementGetResponse20.\r
 132       </xs:documentation>\r
 133     </xs:annotation>\r
 134     <xs:complexContent>\r
 135       <xs:extension base="core:OCIDataResponse">\r
 136         <xs:sequence>\r
 137           <xs:element name="announcementInterruption" type="PreAlertingAnnouncementInterrupt"/>\r
 138           <xs:element name="interruptionDigitSequence" type="PreAlertingAnnouncementInterruptDigits" minOccurs="0"/>\r
 139           <xs:element name="audioSelection" type="ExtendedFileResourceSelection"/>\r
 140           <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0"/>\r
 141           <xs:element name="audioFileUrl" type="URL" minOccurs="0"/>\r
 142           <xs:element name="videoSelection" type="ExtendedFileResourceSelection"/>\r
 143           <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0"/>\r
 144           <xs:element name="videoFileUrl" type="URL" minOccurs="0"/>\r
 145         </xs:sequence>\r
 146       </xs:extension>\r
 147     </xs:complexContent>\r
 148   </xs:complexType>    \r
 149     \r
 150   <xs:complexType name="GroupPreAlertingAnnouncementModifyRequest20">\r
 151     <xs:annotation>\r
 152       <xs:documentation>\r
 153         Modify the group level pre-alerting service settings.\r
 154         The response is either a SuccessResponse or an ErrorResponse.\r
 155       </xs:documentation>\r
 156     </xs:annotation>\r
 157     <xs:complexContent>\r
 158       <xs:extension base="core:OCIRequest">\r
 159         <xs:sequence>\r
 160           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 161           <xs:element name="groupId" type="GroupId"/>\r
 162           <xs:element name="announcementInterruption" type="PreAlertingAnnouncementInterrupt" minOccurs="0"/>\r
 163           <xs:element name="interruptionDigitSequence" type="PreAlertingAnnouncementInterruptDigits" minOccurs="0"/>\r
 164           <xs:element name="audioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 165           <xs:element name="audioFile" type="ExtendedMediaFileResource20" minOccurs="0"/>\r
 166           <xs:element name="videoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 167           <xs:element name="videoFile" type="ExtendedMediaFileResource20" minOccurs="0"/>\r
 168         </xs:sequence>\r
 169       </xs:extension>\r
 170     </xs:complexContent>\r
 171   </xs:complexType>    \r
 172     \r
 173   <xs:complexType name="UserPreAlertingAnnouncementGetRequest20">\r
 174     <xs:annotation>\r
 175       <xs:documentation>\r
 176         Get the user's pre-alerting service setting.\r
 177         The response is either a UserPreAlertingAnnouncementGetResponse20 or an ErrorResponse.\r
 178       </xs:documentation>\r
 179     </xs:annotation>\r
 180     <xs:complexContent>\r
 181       <xs:extension base="core:OCIRequest">\r
 182         <xs:sequence>\r
 183           <xs:element name="userId" type="UserId"/>\r
 184         </xs:sequence>\r
 185       </xs:extension>\r
 186     </xs:complexContent>\r
 187   </xs:complexType>    \r
 188     \r
 189   <xs:complexType name="UserPreAlertingAnnouncementGetResponse20">\r
 190     <xs:annotation>\r
 191       <xs:documentation>\r
 192          Response to a UserPreAlertingAnnouncementGetRequest20.\r
 193          The criteria table's column headings are: "Is Active", "Criteria Name", "Blacklisted", "Calls From", "Calls To Type", "Calls To Number" and "Calls To Extension".\r
 194        The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:\r
 195           - Primary\r
 196           - Alternate X (where x is a number between 1 and 10)\r
 197           - Mobility        \r
 198         The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:\r
 199           - 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
 200           - When no number is available a blank space is provided instead.\r
 201         The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:\r
 202           - 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
 203           - For Mobility Calls To Type, this is always blank.\r
 204           - When no extension is available a blank space is provided instead.        \r
 205       </xs:documentation>\r
 206     </xs:annotation>\r
 207     <xs:complexContent>\r
 208       <xs:extension base="core:OCIDataResponse">\r
 209         <xs:sequence>\r
 210           <xs:element name="isActive" type="xs:boolean"/>\r
 211           <xs:element name="audioSelection" type="ExtendedFileResourceSelection"/>\r
 212           <xs:element name="audioFile" type="AnnouncementFileLevelKey" minOccurs="0"/>\r
 213           <xs:element name="audioFileUrl" type="URL" minOccurs="0"/>\r
 214           <xs:element name="videoSelection" type="ExtendedFileResourceSelection"/>\r
 215           <xs:element name="videoFile" type="AnnouncementFileLevelKey" minOccurs="0"/>\r
 216           <xs:element name="videoFileUrl" type="URL" minOccurs="0"/>\r
 217           <xs:element name="criteriaTable" type="core:OCITable"/>\r
 218         </xs:sequence>\r
 219       </xs:extension>\r
 220     </xs:complexContent>\r
 221   </xs:complexType>    \r
 222     \r
 223   <xs:complexType name="UserPreAlertingAnnouncementModifyRequest20">\r
 224     <xs:annotation>\r
 225       <xs:documentation>\r
 226         Modify the user's pre-alerting service setting.\r
 227         The response is either a SuccessResponse or an ErrorResponse.\r
 228       </xs:documentation>\r
 229     </xs:annotation>\r
 230     <xs:complexContent>\r
 231       <xs:extension base="core:OCIRequest">\r
 232         <xs:sequence>\r
 233           <xs:element name="userId" type="UserId"/>\r
 234           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 235           <xs:element name="audioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 236           <xs:element name="audioFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 237           <xs:element name="videoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 238           <xs:element name="videoFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 239           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 240         </xs:sequence>\r
 241       </xs:extension>\r
 242     </xs:complexContent>\r
 243   </xs:complexType>    \r
 244     \r
 245   <xs:complexType name="UserPreAlertingAnnouncementAddCriteriaRequest">\r
 246     <xs:annotation>\r
 247       <xs:documentation>\r
 248         Add a criteria to the user's pre-alerting service.\r
 249         For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
 250         The response is either a SuccessResponse or an ErrorResponse.\r
 251       </xs:documentation>\r
 252     </xs:annotation>\r
 253     <xs:complexContent>\r
 254       <xs:extension base="core:OCIRequest">\r
 255         <xs:sequence>\r
 256           <xs:element name="userId" type="UserId"/>\r
 257           <xs:element name="criteriaName" type="CriteriaName"/>\r
 258           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 259           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 260           <xs:element name="blacklisted" type="xs:boolean"/>\r
 261           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 262           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 263         </xs:sequence>\r
 264       </xs:extension>\r
 265     </xs:complexContent>\r
 266   </xs:complexType>    \r
 267     \r
 268   <xs:complexType name="UserPreAlertingAnnouncementModifyCriteriaRequest">\r
 269     <xs:annotation>\r
 270       <xs:documentation>\r
 271         Modify a criteria for the user's pre-alerting service.\r
 272         For the callToNumbers in the callToNumberList, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
 273         The response is either a SuccessResponse or an ErrorResponse.\r
 274       </xs:documentation>\r
 275     </xs:annotation>\r
 276     <xs:complexContent>\r
 277       <xs:extension base="core:OCIRequest">\r
 278         <xs:sequence>\r
 279           <xs:element name="userId" type="UserId"/>\r
 280           <xs:element name="criteriaName" type="CriteriaName"/>\r
 281           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
 282           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
 283           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
 284           <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>\r
 285           <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>\r
 286           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
 287         </xs:sequence>\r
 288       </xs:extension>\r
 289     </xs:complexContent>\r
 290   </xs:complexType>    \r
 291     \r
 292   <xs:complexType name="UserPreAlertingAnnouncementDeleteCriteriaRequest">\r
 293     <xs:annotation>\r
 294       <xs:documentation>\r
 295         Delete a criteria from the user's pre-alerting service.\r
 296         The response is either a SuccessResponse or an ErrorResponse.\r
 297       </xs:documentation>\r
 298     </xs:annotation>\r
 299     <xs:complexContent>\r
 300       <xs:extension base="core:OCIRequest">\r
 301         <xs:sequence>\r
 302           <xs:element name="userId" type="UserId"/>\r
 303           <xs:element name="criteriaName" type="CriteriaName"/>\r
 304         </xs:sequence>\r
 305       </xs:extension>\r
 306     </xs:complexContent>\r
 307   </xs:complexType>    \r
 308     \r
 309   <xs:complexType name="UserPreAlertingAnnouncementGetCriteriaRequest21">\r
 310     <xs:annotation>\r
 311       <xs:documentation>\r
 312         Get a criteria for the user's pre-alerting service.\r
 313         The response is either a UserPreAlertingAnnouncementGetCriteriaResponse21 or an ErrorResponse.\r
 314       </xs:documentation>\r
 315     </xs:annotation>\r
 316     <xs:complexContent>\r
 317       <xs:extension base="core:OCIRequest">\r
 318         <xs:sequence>\r
 319           <xs:element name="userId" type="UserId"/>\r
 320           <xs:element name="criteriaName" type="CriteriaName"/>\r
 321         </xs:sequence>\r
 322       </xs:extension>\r
 323     </xs:complexContent>\r
 324   </xs:complexType>    \r
 325     \r
 326   <xs:complexType name="UserPreAlertingAnnouncementGetCriteriaResponse21">\r
 327     <xs:annotation>\r
 328       <xs:documentation>\r
 329         Response to the UserPreAlertingAnnouncementGetCriteriaRequest21.\r
 330       </xs:documentation>\r
 331     </xs:annotation>\r
 332     <xs:complexContent>\r
 333       <xs:extension base="core:OCIDataResponse">\r
 334         <xs:sequence>\r
 335           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 336           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 337           <xs:element name="blacklisted" type="xs:boolean"/>\r
 338           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 339           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 340         </xs:sequence>\r
 341       </xs:extension>\r
 342     </xs:complexContent>\r
 343   </xs:complexType>    \r
 344     \r
 345   <xs:simpleType name="PreAlertingAnnouncementInterrupt">\r
 346     <xs:annotation>\r
 347       <xs:documentation>\r
 348         Pre-alerting Announcement interrupt type.\r
 349       </xs:documentation>\r
 350     </xs:annotation>\r
 351     <xs:restriction base="xs:token">\r
 352       <xs:enumeration value="Not Allowed"/>\r
 353       <xs:enumeration value="Any Digit"/>\r
 354       <xs:enumeration value="Digit Sequence"/>\r
 355     </xs:restriction>\r
 356   </xs:simpleType>    \r
 357     \r
 358   <xs:simpleType name="PreAlertingAnnouncementInterruptDigits">\r
 359     <xs:annotation>\r
 360       <xs:documentation>\r
 361         Pre-alerting Announcement Interrupt digit sequence.\r
 362         The Interrupt digit sequence may contain digits 0-9, *, and #.\r
 363       </xs:documentation>\r
 364     </xs:annotation>\r
 365     <xs:restriction base="xs:token">\r
 366       <xs:minLength value="1"/>\r
 367       <xs:maxLength value="10"/>\r
 368     </xs:restriction>\r
 369   </xs:simpleType>    \r
 370     \r
 371 </xs:schema>\r