share/OCISchemaAS/Services/OCISchemaServiceCallForwardingSelective.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 A L L   F O R W A R D I N G   S E L E C T I V E  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 A L L   F O R W A R D I N G   S E L E C T I V E                                  -->\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     UserCallForwardingSelectiveAddCriteriaRequest16    \r
  36     UserCallForwardingSelectiveDeleteCriteriaRequest    \r
  37     UserCallForwardingSelectiveGetCriteriaRequest21    \r
  38     UserCallForwardingSelectiveGetRequest16    \r
  39     UserCallForwardingSelectiveModifyCriteriaRequest    \r
  40     UserCallForwardingSelectiveModifyRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="UserCallForwardingSelectiveAddCriteriaRequest16">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47         Add a criteria to the user's call forwarding selective 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="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
  59           <xs:element name="forwardToNumberSelection" type="CallForwardingSelectiveNumberSelection16" minOccurs="0"/>\r
  60           <xs:element name="forwardToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
  61           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
  62           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
  63         </xs:sequence>\r
  64       </xs:extension>\r
  65     </xs:complexContent>\r
  66   </xs:complexType>    \r
  67     \r
  68   <xs:complexType name="UserCallForwardingSelectiveDeleteCriteriaRequest">\r
  69     <xs:annotation>\r
  70       <xs:documentation>\r
  71         Delete a criteria from the user's call forwarding selective service.\r
  72         The response is either a SuccessResponse or an ErrorResponse.\r
  73       </xs:documentation>\r
  74     </xs:annotation>\r
  75     <xs:complexContent>\r
  76       <xs:extension base="core:OCIRequest">\r
  77         <xs:sequence>\r
  78           <xs:element name="userId" type="UserId"/>\r
  79           <xs:element name="criteriaName" type="CriteriaName"/>\r
  80         </xs:sequence>\r
  81       </xs:extension>\r
  82     </xs:complexContent>\r
  83   </xs:complexType>    \r
  84     \r
  85   <xs:complexType name="UserCallForwardingSelectiveGetCriteriaRequest21">\r
  86     <xs:annotation>\r
  87       <xs:documentation>\r
  88         Get a criteria for the user's call forwarding selective service.\r
  89         The response is either a UserCallForwardingSelectiveGetCriteriaResponse21 or an ErrorResponse.\r
  90       </xs:documentation>\r
  91     </xs:annotation>\r
  92     <xs:complexContent>\r
  93       <xs:extension base="core:OCIRequest">\r
  94         <xs:sequence>\r
  95           <xs:element name="userId" type="UserId"/>\r
  96           <xs:element name="criteriaName" type="CriteriaName"/>\r
  97         </xs:sequence>\r
  98       </xs:extension>\r
  99     </xs:complexContent>\r
 100   </xs:complexType>    \r
 101     \r
 102   <xs:complexType name="UserCallForwardingSelectiveGetCriteriaResponse21">\r
 103     <xs:annotation>\r
 104       <xs:documentation>\r
 105         Response to the UserCallForwardingSelectiveGetCriteriaRequest21.\r
 106       </xs:documentation>\r
 107     </xs:annotation>\r
 108     <xs:complexContent>\r
 109       <xs:extension base="core:OCIDataResponse">\r
 110         <xs:sequence>\r
 111           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
 112           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 113           <xs:element name="forwardToNumberSelection" type="CallForwardingSelectiveNumberSelection16"/>\r
 114           <xs:element name="forwardToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 115           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
 116           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 117         </xs:sequence>\r
 118       </xs:extension>\r
 119     </xs:complexContent>\r
 120   </xs:complexType>    \r
 121     \r
 122   <xs:complexType name="UserCallForwardingSelectiveGetRequest16">\r
 123     <xs:annotation>\r
 124       <xs:documentation>\r
 125         Get the user's call forwarding selective service setting.\r
 126         The response is either a UserCallForwardingSelectiveGetResponse16 or an ErrorResponse.\r
 127       </xs:documentation>\r
 128     </xs:annotation>\r
 129     <xs:complexContent>\r
 130       <xs:extension base="core:OCIRequest">\r
 131         <xs:sequence>\r
 132           <xs:element name="userId" type="UserId"/>\r
 133         </xs:sequence>\r
 134       </xs:extension>\r
 135     </xs:complexContent>\r
 136   </xs:complexType>    \r
 137     \r
 138   <xs:complexType name="UserCallForwardingSelectiveGetResponse16">\r
 139     <xs:annotation>\r
 140       <xs:documentation>\r
 141         Response to the UserCallForwardingSelectiveGetRequest16. The criteria table's column headings are:\r
 142         "Is Active", "Criteria Name", "Time Schedule", "Calls From", "Forward To", "Blacklisted", "Holiday Schedule", "Calls To Type", "Calls To Number" and "Calls To Extension".\r
 143        The possible values for the "Calls To Type" column are the following or a combination of them separated by comma:\r
 144           - Primary\r
 145           - Alternate X (where x is a number between 1 and 10)\r
 146           - Mobility        \r
 147         The possible values for the "Calls To Number" column are the following or a combination of them separated by comma:\r
 148           - 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
 149           - When no number is available a blank space is provided instead.\r
 150         The possible values for the "Calls To Extension" column are the following or a combination of them separated by comma:\r
 151           - 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
 152           - For Mobility Calls To Type, this is always blank.\r
 153           - When no extension is available a blank space is provided instead.\r
 154       </xs:documentation>\r
 155     </xs:annotation>\r
 156     <xs:complexContent>\r
 157       <xs:extension base="core:OCIDataResponse">\r
 158         <xs:sequence>\r
 159           <xs:element name="isActive" type="xs:boolean"/>\r
 160           <xs:element name="defaultForwardToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 161           <xs:element name="playRingReminder" type="xs:boolean"/>\r
 162           <xs:element name="criteriaTable" type="core:OCITable"/>\r
 163         </xs:sequence>\r
 164       </xs:extension>\r
 165     </xs:complexContent>\r
 166   </xs:complexType>    \r
 167     \r
 168   <xs:complexType name="UserCallForwardingSelectiveModifyCriteriaRequest">\r
 169     <xs:annotation>\r
 170       <xs:documentation>\r
 171         Modify a criteria for the user's call forwarding selective service.\r
 172         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
 173         The response is either a SuccessResponse or an ErrorResponse.\r
 174       </xs:documentation>\r
 175     </xs:annotation>\r
 176     <xs:complexContent>\r
 177       <xs:extension base="core:OCIRequest">\r
 178         <xs:sequence>\r
 179           <xs:element name="userId" type="UserId"/>\r
 180           <xs:element name="criteriaName" type="CriteriaName"/>\r
 181           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
 182           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
 183           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
 184           <xs:element name="forwardToNumberSelection" type="CallForwardingSelectiveNumberSelection16" minOccurs="0"/>\r
 185           <xs:element name="forwardToPhoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 186           <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>\r
 187           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
 188         </xs:sequence>\r
 189       </xs:extension>\r
 190     </xs:complexContent>\r
 191   </xs:complexType>    \r
 192     \r
 193   <xs:complexType name="UserCallForwardingSelectiveModifyRequest">\r
 194     <xs:annotation>\r
 195       <xs:documentation>\r
 196         Modify the user's call forwarding selective service setting.\r
 197         The response is either a SuccessResponse or an ErrorResponse.\r
 198       </xs:documentation>\r
 199     </xs:annotation>\r
 200     <xs:complexContent>\r
 201       <xs:extension base="core:OCIRequest">\r
 202         <xs:sequence>\r
 203           <xs:element name="userId" type="UserId"/>\r
 204           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 205           <xs:element name="defaultForwardToPhoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 206           <xs:element name="playRingReminder" type="xs:boolean" minOccurs="0"/>\r
 207           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
 208         </xs:sequence>\r
 209       </xs:extension>\r
 210     </xs:complexContent>\r
 211   </xs:complexType>    \r
 212     \r
 213   <xs:simpleType name="CallForwardingSelectiveNumberSelection16">\r
 214     <xs:annotation>\r
 215       <xs:documentation>\r
 216         Forward to Number Selection.\r
 217       </xs:documentation>\r
 218     </xs:annotation>\r
 219     <xs:restriction base="xs:token">\r
 220       <xs:enumeration value="Forward To Default Number"/>\r
 221       <xs:enumeration value="Forward To Specified Number"/>\r
 222       <xs:enumeration value="Do not forward"/>\r
 223     </xs:restriction>\r
 224   </xs:simpleType>    \r
 225     \r
 226 </xs:schema>\r