share/OCISchemaAS/Services/OCISchemaServicePriorityAlert.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 I O R I T Y   A L E R 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 I O R I T Y   A L E R T    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     UserPriorityAlertAddCriteriaRequest16    \r
  35     UserPriorityAlertDeleteCriteriaRequest    \r
  36     UserPriorityAlertGetCriteriaListRequest    \r
  37     UserPriorityAlertGetCriteriaRequest21    \r
  38     UserPriorityAlertModifyActiveCriteriaListRequest    \r
  39     UserPriorityAlertModifyCriteriaRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="UserPriorityAlertAddCriteriaRequest16">\r
  44     <xs:annotation>\r
  45       <xs:documentation>\r
  46         Add a criteria to the user's priority alert service.\r
  47         For the callToNumber, the extension element is not used and the number element is only used when the type is BroadWorks Mobility.\r
  48         The response is either a SuccessResponse or an ErrorResponse.\r
  49       </xs:documentation>\r
  50     </xs:annotation>\r
  51     <xs:complexContent>\r
  52       <xs:extension base="core:OCIRequest">\r
  53         <xs:sequence>\r
  54           <xs:element name="userId" type="UserId"/>\r
  55           <xs:element name="criteriaName" type="CriteriaName"/>\r
  56           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
  57           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
  58           <xs:element name="blacklisted" type="xs:boolean"/>\r
  59           <xs:element name="fromDnCriteria" type="PriorityAlertCriteriaFromDn"/>\r
  60           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
  61         </xs:sequence>\r
  62       </xs:extension>\r
  63     </xs:complexContent>\r
  64   </xs:complexType>    \r
  65     \r
  66   <xs:complexType name="UserPriorityAlertDeleteCriteriaRequest">\r
  67     <xs:annotation>\r
  68       <xs:documentation>\r
  69         Delete a criteria from the user's priority alert service.\r
  70         The response is either a SuccessResponse or an ErrorResponse.\r
  71       </xs:documentation>\r
  72     </xs:annotation>\r
  73     <xs:complexContent>\r
  74       <xs:extension base="core:OCIRequest">\r
  75         <xs:sequence>\r
  76           <xs:element name="userId" type="UserId"/>\r
  77           <xs:element name="criteriaName" type="CriteriaName"/>\r
  78         </xs:sequence>\r
  79       </xs:extension>\r
  80     </xs:complexContent>\r
  81   </xs:complexType>    \r
  82     \r
  83   <xs:complexType name="UserPriorityAlertGetCriteriaListRequest">\r
  84     <xs:annotation>\r
  85       <xs:documentation>\r
  86         Get the user's priority alert criteria listing.\r
  87         The response is either a UserPriorityAlertGetCriteriaListResponse 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="userId" type="UserId"/>\r
  94         </xs:sequence>\r
  95       </xs:extension>\r
  96     </xs:complexContent>\r
  97   </xs:complexType>    \r
  98     \r
  99   <xs:complexType name="UserPriorityAlertGetCriteriaListResponse">\r
 100     <xs:annotation>\r
 101       <xs:documentation>\r
 102         Response to the UserPriorityAlertGetCriteriaListRequest. The criteria table's column headings are:\r
 103         "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension".\r
 104        The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:\r
 105           - Primary\r
 106           - Alternate X (where x is a number between 1 and 10)\r
 107           - Mobility        \r
 108         The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:\r
 109           - 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
 110           - When no number is available a blank space is provided instead.\r
 111         The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:\r
 112           - 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
 113           - For Mobility Calls To Type, this is always blank.\r
 114           - When no extension is available a blank space is provided instead.        \r
 115       </xs:documentation>\r
 116     </xs:annotation>\r
 117     <xs:complexContent>\r
 118       <xs:extension base="core:OCIDataResponse">\r
 119         <xs:sequence>\r
 120           <xs:element name="criteriaTable" type="core:OCITable"/>\r
 121         </xs:sequence>\r
 122       </xs:extension>\r
 123     </xs:complexContent>\r
 124   </xs:complexType>    \r
 125     \r
 126   <xs:complexType name="UserPriorityAlertGetCriteriaRequest21">\r
 127     <xs:annotation>\r
 128       <xs:documentation>\r
 129         Get a criteria for the user's priority alert service.\r
 130         The response is either a UserPriorityAlertGetCriteriaResponse21 or an ErrorResponse.\r
 131       </xs:documentation>\r
 132     </xs:annotation>\r
 133     <xs:complexContent>\r
 134       <xs:extension base="core:OCIRequest">\r
 135         <xs:sequence>\r
 136           <xs:element name="userId" type="UserId"/>\r
 137           <xs:element name="criteriaName" type="CriteriaName"/>\r
 138         </xs:sequence>\r
 139       </xs:extension>\r
 140     </xs:complexContent>\r
 141   </xs:complexType>    \r
 142     \r
 143   <xs:complexType name="UserPriorityAlertGetCriteriaResponse21">\r
 144     <xs:annotation>\r
 145       <xs:documentation>\r
 146         Response to the UserPriorityAlertGetCriteriaRequest21.\r
 147       </xs:documentation>\r
 148     </xs:annotation>\r
 149     <xs:complexContent>\r
 150       <xs:extension base="core:OCIDataResponse">\r
 151         <xs:sequence>\r
 152           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 153           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 154           <xs:element name="blacklisted" type="xs:boolean"/>\r
 155           <xs:element name="fromDnCriteria" type="PriorityAlertCriteriaFromDn"/>\r
 156           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 157         </xs:sequence>\r
 158       </xs:extension>\r
 159     </xs:complexContent>\r
 160   </xs:complexType>    \r
 161     \r
 162   <xs:complexType name="UserPriorityAlertModifyActiveCriteriaListRequest">\r
 163     <xs:annotation>\r
 164       <xs:documentation>\r
 165         Activate the user's priority alert criteria list.\r
 166         The response is either a SuccessResponse or an ErrorResponse.\r
 167       </xs:documentation>\r
 168     </xs:annotation>\r
 169     <xs:complexContent>\r
 170       <xs:extension base="core:OCIRequest">\r
 171         <xs:sequence>\r
 172           <xs:element name="userId" type="UserId"/>\r
 173           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 174         </xs:sequence>\r
 175       </xs:extension>\r
 176     </xs:complexContent>\r
 177   </xs:complexType>    \r
 178     \r
 179   <xs:complexType name="UserPriorityAlertModifyCriteriaRequest">\r
 180     <xs:annotation>\r
 181       <xs:documentation>\r
 182         Modify a criteria for the user's priority alert service.\r
 183         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
 184         The response is either a SuccessResponse or an ErrorResponse.\r
 185       </xs:documentation>\r
 186     </xs:annotation>\r
 187     <xs:complexContent>\r
 188       <xs:extension base="core:OCIRequest">\r
 189         <xs:sequence>\r
 190           <xs:element name="userId" type="UserId"/>\r
 191           <xs:element name="criteriaName" type="CriteriaName"/>\r
 192           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
 193           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
 194           <xs:element name="fromDnCriteria" type="PriorityAlertCriteriaFromDnModify" minOccurs="0"/>\r
 195           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
 196           <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>\r
 197           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
 198         </xs:sequence>\r
 199       </xs:extension>\r
 200     </xs:complexContent>\r
 201   </xs:complexType>    \r
 202     \r
 203   <xs:complexType name="PriorityAlertCriteriaFromDn">\r
 204     <xs:annotation>\r
 205       <xs:documentation>\r
 206         The from dn criteria used within an add/get request.\r
 207       </xs:documentation>\r
 208     </xs:annotation>\r
 209     <xs:sequence>\r
 210       <xs:element name="fromDnCriteriaSelection" type="PriorityAlertCriteriaFromDnSelection"/>\r
 211       <xs:element name="includeAnonymousCallers" type="xs:boolean"/>\r
 212       <xs:element name="includeUnavailableCallers" type="xs:boolean"/>\r
 213       <xs:element name="phoneNumber" type="DN" minOccurs="0" maxOccurs="12"/>\r
 214     </xs:sequence>\r
 215   </xs:complexType>    \r
 216     \r
 217   <xs:complexType name="PriorityAlertCriteriaFromDnModify">\r
 218     <xs:annotation>\r
 219       <xs:documentation>\r
 220         The from dn criteria used within a modify request.\r
 221       </xs:documentation>\r
 222     </xs:annotation>\r
 223     <xs:sequence>\r
 224       <xs:element name="fromDnCriteriaSelection" type="PriorityAlertCriteriaFromDnSelection" minOccurs="0"/>\r
 225       <xs:element name="includeAnonymousCallers" type="xs:boolean" minOccurs="0"/>\r
 226       <xs:element name="includeUnavailableCallers" type="xs:boolean" minOccurs="0"/>\r
 227       <xs:element name="phoneNumberList" type="CriteriaReplacementDNList" nillable="true" minOccurs="0"/>\r
 228     </xs:sequence>\r
 229   </xs:complexType>    \r
 230     \r
 231   <xs:simpleType name="PriorityAlertCriteriaFromDnSelection">\r
 232     <xs:annotation>\r
 233       <xs:documentation>\r
 234         Selection criteria for a from dn.\r
 235       </xs:documentation>\r
 236     </xs:annotation>\r
 237     <xs:restriction base="xs:token">\r
 238       <xs:enumeration value="Any External"/>\r
 239       <xs:enumeration value="Specified Only"/>\r
 240     </xs:restriction>\r
 241   </xs:simpleType>    \r
 242     \r
 243 </xs:schema>\r