share/OCISchemaAS/Services/OCISchemaServiceCustomRingback.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 <!-- C U S T O M   R I N G B A C K  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   <!-- C U S T O M   R I N G B A C K    R E Q U E S T S  A N D  R E S P O N S E S         -->\r
  27   <!-- ********************************************************************************** -->\r
  28   <!--\r
  29   Requests and responses are listed here in alphabetical order.\r
  30   The non-primitive attributes inside the commands are defined in another\r
  31   section of the schema.\r
  32 \r
  33   Requests in this schema file:\r
  34     GroupCustomRingbackGroupGetRequest20    \r
  35     GroupCustomRingbackGroupModifyRequest20    \r
  36     UserCustomRingbackUserAddCriteriaRequest20    \r
  37     UserCustomRingbackUserDeleteCriteriaRequest    \r
  38     UserCustomRingbackUserGetCriteriaListRequest    \r
  39     UserCustomRingbackUserGetCriteriaRequest21    \r
  40     UserCustomRingbackUserModifyActiveCriteriaListRequest    \r
  41     UserCustomRingbackUserModifyCriteriaRequest20    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="GroupCustomRingbackGroupGetRequest20">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Get the group's custom ring back service settings.\r
  49         The response is either a GroupCustomRingbackGroupGetResponse20 or an ErrorResponse.\r
  50       </xs:documentation>\r
  51     </xs:annotation>\r
  52     <xs:complexContent>\r
  53       <xs:extension base="core:OCIRequest">\r
  54         <xs:sequence>\r
  55           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  56           <xs:element name="groupId" type="GroupId"/>\r
  57         </xs:sequence>\r
  58       </xs:extension>\r
  59     </xs:complexContent>\r
  60   </xs:complexType>    \r
  61     \r
  62   <xs:complexType name="GroupCustomRingbackGroupGetResponse20">\r
  63     <xs:annotation>\r
  64       <xs:documentation>\r
  65         Response to the GroupCustomRingbackGroupGetRequest20.\r
  66       </xs:documentation>\r
  67     </xs:annotation>\r
  68     <xs:complexContent>\r
  69       <xs:extension base="core:OCIDataResponse">\r
  70         <xs:sequence>\r
  71           <xs:element name="isActive" type="xs:boolean"/>\r
  72           <xs:element name="audioSelection" type="ExtendedFileResourceSelection"/>\r
  73           <xs:element name="audioFile" type="AnnouncementFileKey" minOccurs="0"/>\r
  74           <xs:element name="audioFileUrl" type="URL" minOccurs="0"/>\r
  75           <xs:element name="videoSelection" type="ExtendedFileResourceSelection"/>\r
  76           <xs:element name="videoFile" type="AnnouncementFileKey" minOccurs="0"/>\r
  77           <xs:element name="videoFileUrl" type="URL" minOccurs="0"/>\r
  78         </xs:sequence>\r
  79       </xs:extension>\r
  80     </xs:complexContent>\r
  81   </xs:complexType>    \r
  82     \r
  83   <xs:complexType name="GroupCustomRingbackGroupModifyRequest20">\r
  84     <xs:annotation>\r
  85       <xs:documentation>\r
  86         Modify the group's custom ring back service settings.\r
  87         The response is either a SuccessResponse or an ErrorResponse.\r
  88       </xs:documentation>\r
  89     </xs:annotation>\r
  90     <xs:complexContent>\r
  91       <xs:extension base="core:OCIRequest">\r
  92         <xs:sequence>\r
  93           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  94           <xs:element name="groupId" type="GroupId"/>\r
  95           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
  96           <xs:element name="audioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
  97           <xs:element name="audioFile" type="ExtendedMediaFileResource20" minOccurs="0" nillable="true"/>\r
  98           <xs:element name="videoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
  99           <xs:element name="videoFile" type="ExtendedMediaFileResource20" minOccurs="0" nillable="true"/>\r
 100         </xs:sequence>\r
 101       </xs:extension>\r
 102     </xs:complexContent>\r
 103   </xs:complexType>    \r
 104     \r
 105   <xs:complexType name="UserCustomRingbackUserAddCriteriaRequest20">\r
 106     <xs:annotation>\r
 107       <xs:documentation>\r
 108         Add a criteria to the user's custom ringback service.\r
 109         For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
 110         The response is either a SuccessResponse or an ErrorResponse.\r
 111       </xs:documentation>\r
 112     </xs:annotation>\r
 113     <xs:complexContent>\r
 114       <xs:extension base="core:OCIRequest">\r
 115         <xs:sequence>\r
 116           <xs:element name="userId" type="UserId"/>\r
 117           <xs:element name="criteriaName" type="CriteriaName"/>\r
 118           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 119           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 120           <xs:element name="blacklisted" type="xs:boolean"/>\r
 121           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 122           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 123           <xs:element name="audioSelection" type="ExtendedFileResourceSelection"/>\r
 124           <xs:element name="audioFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 125           <xs:element name="videoSelection" type="ExtendedFileResourceSelection"/>\r
 126           <xs:element name="videoFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 127           <xs:element name="callWaitingAudioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 128           <xs:element name="callWaitingAudioFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 129           <xs:element name="callWaitingVideoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 130           <xs:element name="callWaitingVideoFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 131         </xs:sequence>\r
 132       </xs:extension>\r
 133     </xs:complexContent>\r
 134   </xs:complexType>    \r
 135     \r
 136   <xs:complexType name="UserCustomRingbackUserDeleteCriteriaRequest">\r
 137     <xs:annotation>\r
 138       <xs:documentation>\r
 139         Delete a criteria from the user's custom ringback service.\r
 140         The response is either a SuccessResponse or an ErrorResponse.\r
 141       </xs:documentation>\r
 142     </xs:annotation>\r
 143     <xs:complexContent>\r
 144       <xs:extension base="core:OCIRequest">\r
 145         <xs:sequence>\r
 146           <xs:element name="userId" type="UserId"/>\r
 147           <xs:element name="criteriaName" type="CriteriaName"/>\r
 148         </xs:sequence>\r
 149       </xs:extension>\r
 150     </xs:complexContent>\r
 151   </xs:complexType>    \r
 152     \r
 153   <xs:complexType name="UserCustomRingbackUserGetCriteriaListRequest">\r
 154     <xs:annotation>\r
 155       <xs:documentation>\r
 156         Get the user's custom ringback service criteria listing.\r
 157         The response is either a UserCustomRingbackUserGetCriteriaListResponse or an ErrorResponse.\r
 158       </xs:documentation>\r
 159     </xs:annotation>\r
 160     <xs:complexContent>\r
 161       <xs:extension base="core:OCIRequest">\r
 162         <xs:sequence>\r
 163           <xs:element name="userId" type="UserId"/>\r
 164         </xs:sequence>\r
 165       </xs:extension>\r
 166     </xs:complexContent>\r
 167   </xs:complexType>    \r
 168     \r
 169   <xs:complexType name="UserCustomRingbackUserGetCriteriaListResponse">\r
 170     <xs:annotation>\r
 171       <xs:documentation>\r
 172         Response to the UserCustomRingbackUserGetCriteriaListRequest.\r
 173         The criteria table's column headings are: "Is Active", "Criteria Name", \r
 174         "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension".\r
 175        The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:\r
 176           - Primary\r
 177           - Alternate X (where x is a number between 1 and 10)\r
 178           - Mobility        \r
 179         The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:\r
 180           - 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
 181           - When no number is available a blank space is provided instead.\r
 182         The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:\r
 183           - 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
 184           - For Mobility Calls To Type, this is always blank.\r
 185           - When no extension is available a blank space is provided instead.\r
 186       </xs:documentation>\r
 187     </xs:annotation>\r
 188     <xs:complexContent>\r
 189       <xs:extension base="core:OCIDataResponse">\r
 190         <xs:sequence>\r
 191           <xs:element name="criteriaTable" type="core:OCITable"/>\r
 192         </xs:sequence>\r
 193       </xs:extension>\r
 194     </xs:complexContent>\r
 195   </xs:complexType>    \r
 196     \r
 197   <xs:complexType name="UserCustomRingbackUserGetCriteriaRequest21">\r
 198     <xs:annotation>\r
 199       <xs:documentation>\r
 200         Get a criteria for the user's custom ringback service.\r
 201         The response is either a UserCustomRingbackUserGetCriteriaResponse21 or an ErrorResponse.\r
 202       </xs:documentation>\r
 203     </xs:annotation>\r
 204     <xs:complexContent>\r
 205       <xs:extension base="core:OCIRequest">\r
 206         <xs:sequence>\r
 207           <xs:element name="userId" type="UserId"/>\r
 208           <xs:element name="criteriaName" type="CriteriaName"/>\r
 209         </xs:sequence>\r
 210       </xs:extension>\r
 211     </xs:complexContent>\r
 212   </xs:complexType>    \r
 213     \r
 214   <xs:complexType name="UserCustomRingbackUserGetCriteriaResponse21">\r
 215     <xs:annotation>\r
 216       <xs:documentation>\r
 217         Response to the UserCustomRingbackUserGetCriteriaRequest21.\r
 218       </xs:documentation>\r
 219     </xs:annotation>\r
 220     <xs:complexContent>\r
 221       <xs:extension base="core:OCIDataResponse">\r
 222         <xs:sequence>\r
 223           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 224           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 225           <xs:element name="blacklisted" type="xs:boolean"/>\r
 226           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 227           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 228           <xs:element name="audioSelection" type="ExtendedFileResourceSelection"/>\r
 229           <xs:element name="audioFile" type="AnnouncementFileLevelKey" minOccurs="0"/>\r
 230           <xs:element name="audioFileUrl" type="URL" minOccurs="0"/>\r
 231           <xs:element name="videoSelection" type="ExtendedFileResourceSelection"/>\r
 232           <xs:element name="videoFile" type="AnnouncementFileLevelKey" minOccurs="0"/>\r
 233           <xs:element name="videoFileUrl" type="URL" minOccurs="0"/>\r
 234           <xs:element name="callWaitingAudioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 235           <xs:element name="callWaitingAudioFile" type="AnnouncementFileLevelKey" minOccurs="0"/>\r
 236           <xs:element name="callWaitingAudioFileUrl" type="URL" minOccurs="0"/>\r
 237           <xs:element name="callWaitingVideoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 238           <xs:element name="callWaitingVideoFile" type="AnnouncementFileLevelKey" minOccurs="0"/>\r
 239           <xs:element name="callWaitingVideoFileUrl" type="URL" minOccurs="0"/>\r
 240         </xs:sequence>\r
 241       </xs:extension>\r
 242     </xs:complexContent>\r
 243   </xs:complexType>    \r
 244     \r
 245   <xs:complexType name="UserCustomRingbackUserModifyActiveCriteriaListRequest">\r
 246     <xs:annotation>\r
 247       <xs:documentation>\r
 248         Modify the user's custom ringback service criteria's active setting.\r
 249         The response is either a SuccessResponse or an ErrorResponse.\r
 250       </xs:documentation>\r
 251     </xs:annotation>\r
 252     <xs:complexContent>\r
 253       <xs:extension base="core:OCIRequest">\r
 254         <xs:sequence>\r
 255           <xs:element name="userId" type="UserId"/>\r
 256           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 257         </xs:sequence>\r
 258       </xs:extension>\r
 259     </xs:complexContent>\r
 260   </xs:complexType>    \r
 261     \r
 262   <xs:complexType name="UserCustomRingbackUserModifyCriteriaRequest20">\r
 263     <xs:annotation>\r
 264       <xs:documentation>\r
 265         Modify a criteria for the user's custom ringback service.\r
 266         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
 267         The response is either a SuccessResponse or an ErrorResponse.\r
 268       </xs:documentation>\r
 269     </xs:annotation>\r
 270     <xs:complexContent>\r
 271       <xs:extension base="core:OCIRequest">\r
 272         <xs:sequence>\r
 273           <xs:element name="userId" type="UserId"/>\r
 274           <xs:element name="criteriaName" type="CriteriaName"/>\r
 275           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
 276           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
 277           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
 278           <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>\r
 279           <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>\r
 280           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
 281           <xs:element name="audioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 282           <xs:element name="audioFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 283           <xs:element name="videoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 284           <xs:element name="videoFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 285           <xs:element name="callWaitingAudioSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 286           <xs:element name="callWaitingAudioFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 287           <xs:element name="callWaitingVideoSelection" type="ExtendedFileResourceSelection" minOccurs="0"/>\r
 288           <xs:element name="callWaitingVideoFile" type="ExtendedMediaFileLevelResource20" minOccurs="0"/>\r
 289         </xs:sequence>\r
 290       </xs:extension>\r
 291     </xs:complexContent>\r
 292   </xs:complexType>    \r
 293     \r
 294 </xs:schema>\r