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