share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpressSR.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 O M M   P I L O T   E X P R E S S   S   R  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 O M M   P I L O T   E X P R E S S   S   R                                        -->\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     UserCommPilotExpressSRGetRequest13mp16    \r
  36     UserCommPilotExpressSRModifyRequest    \r
  37     \r
  38   --> \r
  39   \r
  40   <xs:complexType name="UserCommPilotExpressSRGetRequest13mp16">\r
  41     <xs:annotation>\r
  42       <xs:documentation>\r
  43         Get the user's commPilot express SR service setting.\r
  44         The response is either a UserCommPilotExpressSRGetResponse13mp16 or an ErrorResponse.\r
  45       </xs:documentation>\r
  46     </xs:annotation>\r
  47     <xs:complexContent>\r
  48       <xs:extension base="core:OCIRequest">\r
  49         <xs:sequence>\r
  50           <xs:element name="userId" type="UserId"/>\r
  51         </xs:sequence>\r
  52       </xs:extension>\r
  53     </xs:complexContent>\r
  54   </xs:complexType>    \r
  55     \r
  56   <xs:complexType name="UserCommPilotExpressSRGetResponse13mp16">\r
  57     <xs:annotation>\r
  58       <xs:documentation>\r
  59         Response to the UserCommPilotExpressSRGetRequest13mp16.\r
  60       </xs:documentation>\r
  61     </xs:annotation>\r
  62     <xs:complexContent>\r
  63       <xs:extension base="core:OCIDataResponse">\r
  64         <xs:sequence>\r
  65           <xs:element name="profile" type="CommPilotExpressSRProfile" minOccurs="0"/>\r
  66           <xs:element name="availableInOffice" type="CommPilotExpressSRAvailableInOffice"/>\r
  67           <xs:element name="availableOutOfOffice" type="CommPilotExpressSRAvailableOutOfOffice"/>\r
  68           <xs:element name="busy" type="CommPilotExpressSRBusy"/>\r
  69           <xs:element name="unavailable" type="CommPilotExpressSRUnavailable"/>\r
  70         </xs:sequence>\r
  71       </xs:extension>\r
  72     </xs:complexContent>\r
  73   </xs:complexType>    \r
  74     \r
  75   <xs:complexType name="UserCommPilotExpressSRModifyRequest">\r
  76     <xs:annotation>\r
  77       <xs:documentation>\r
  78         Modify the user's commPilot express SR service setting.\r
  79         The response is either a SuccessResponse or an ErrorResponse.\r
  80       </xs:documentation>\r
  81     </xs:annotation>\r
  82     <xs:complexContent>\r
  83       <xs:extension base="core:OCIRequest">\r
  84         <xs:sequence>\r
  85           <xs:element name="userId" type="UserId"/>\r
  86           <xs:element name="profile" type="CommPilotExpressSRProfile" nillable="true" minOccurs="0"/>\r
  87           <xs:element name="availableInOffice" type="CommPilotExpressSRAvailableInOfficeModify" minOccurs="0"/>\r
  88           <xs:element name="availableOutOfOffice" type="CommPilotExpressSRAvailableOutOfOfficeModify" minOccurs="0"/>\r
  89           <xs:element name="busy" type="CommPilotExpressSRBusyModify" minOccurs="0"/>\r
  90           <xs:element name="unavailable" type="CommPilotExpressSRUnavailableModify" minOccurs="0"/>\r
  91         </xs:sequence>\r
  92       </xs:extension>\r
  93     </xs:complexContent>\r
  94   </xs:complexType>    \r
  95     \r
  96   <xs:complexType name="CommPilotExpressSRAvailableInOffice">\r
  97     <xs:annotation>\r
  98       <xs:documentation>\r
  99         CommPilot Express SR Available In Office Settings used in the context of a get.\r
 100       </xs:documentation>\r
 101     </xs:annotation>\r
 102     <xs:sequence>\r
 103       <xs:element name="busySetting" type="CommPilotExpressSRRedirection"/>\r
 104       <xs:element name="noAnswerSetting" type="CommPilotExpressSRNoAnswer"/>\r
 105       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotify"/>\r
 106     </xs:sequence>\r
 107   </xs:complexType>    \r
 108     \r
 109   <xs:complexType name="CommPilotExpressSRAvailableInOfficeModify">\r
 110     <xs:annotation>\r
 111       <xs:documentation>\r
 112         CommPilot Express SR Available In Office Settings used in the context of a modify.\r
 113       </xs:documentation>\r
 114     </xs:annotation>\r
 115     <xs:sequence>\r
 116       <xs:element name="busySetting" type="CommPilotExpressSRRedirectionModify" minOccurs="0"/>\r
 117       <xs:element name="noAnswerSetting" type="CommPilotExpressSRNoAnswerModify" minOccurs="0"/>\r
 118       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotifyModify" minOccurs="0"/>\r
 119     </xs:sequence>\r
 120   </xs:complexType>    \r
 121     \r
 122   <xs:complexType name="CommPilotExpressSRAvailableOutOfOffice">\r
 123     <xs:annotation>\r
 124       <xs:documentation>\r
 125         CommPilot Express SR Available Out Of Office Configuration used in the context of a get.\r
 126       </xs:documentation>\r
 127     </xs:annotation>\r
 128     <xs:sequence>\r
 129       <xs:element name="remotePhoneNumber" type="OutgoingDN" minOccurs="0"/>\r
 130       <xs:element name="noAnswerSetting" type="CommPilotExpressSRNoAnswer"/>\r
 131       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotify"/>\r
 132     </xs:sequence>\r
 133   </xs:complexType>    \r
 134     \r
 135   <xs:complexType name="CommPilotExpressSRAvailableOutOfOfficeModify">\r
 136     <xs:annotation>\r
 137       <xs:documentation>\r
 138         CommPilot Express SR Available Out Of Office Configuration used in the context of a modify.\r
 139       </xs:documentation>\r
 140     </xs:annotation>\r
 141     <xs:sequence>\r
 142       <xs:element name="remotePhoneNumber" type="OutgoingDN" nillable="true" minOccurs="0"/>\r
 143       <xs:element name="noAnswerSetting" type="CommPilotExpressSRNoAnswerModify" minOccurs="0"/>\r
 144       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotifyModify" minOccurs="0"/>\r
 145     </xs:sequence>\r
 146   </xs:complexType>    \r
 147     \r
 148   <xs:complexType name="CommPilotExpressSRBusy">\r
 149     <xs:annotation>\r
 150       <xs:documentation>\r
 151         CommPilot Express SR Available In Office Configuration used in the context of a get.\r
 152       </xs:documentation>\r
 153     </xs:annotation>\r
 154     <xs:sequence>\r
 155       <xs:element name="incomingCalls" type="CommPilotExpressSRRedirectionWithException"/>\r
 156       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotify"/>\r
 157     </xs:sequence>\r
 158   </xs:complexType>    \r
 159     \r
 160   <xs:complexType name="CommPilotExpressSRBusyModify">\r
 161     <xs:annotation>\r
 162       <xs:documentation>\r
 163         CommPilot Express SR Available In Office Configuration used in the context of a modify.\r
 164       </xs:documentation>\r
 165     </xs:annotation>\r
 166     <xs:sequence>\r
 167       <xs:element name="incomingCalls" type="CommPilotExpressSRRedirectionWithExceptionModify" minOccurs="0"/>\r
 168       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotifyModify" minOccurs="0"/>\r
 169     </xs:sequence>\r
 170   </xs:complexType>    \r
 171     \r
 172   <xs:complexType name="CommPilotExpressSRUnavailable">\r
 173     <xs:annotation>\r
 174       <xs:documentation>\r
 175         CommPilot Express SR Unavailable Configuration used in the context of a get.\r
 176       </xs:documentation>\r
 177     </xs:annotation>\r
 178     <xs:sequence>\r
 179       <xs:element name="incomingCalls" type="CommPilotExpressSRRedirectionWithException"/>\r
 180       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotify"/>\r
 181     </xs:sequence>\r
 182   </xs:complexType>    \r
 183     \r
 184   <xs:complexType name="CommPilotExpressSRUnavailableModify">\r
 185     <xs:annotation>\r
 186       <xs:documentation>\r
 187         CommPilot Express SR Unavailable Configuration used in the context of a modify.\r
 188       </xs:documentation>\r
 189     </xs:annotation>\r
 190     <xs:sequence>\r
 191       <xs:element name="incomingCalls" type="CommPilotExpressSRRedirectionWithExceptionModify" minOccurs="0"/>\r
 192       <xs:element name="incomingCallNotify" type="CommPilotExpressSREmailNotifyModify" minOccurs="0"/>\r
 193     </xs:sequence>\r
 194   </xs:complexType>    \r
 195     \r
 196   <xs:complexType name="CommPilotExpressSREmailNotify">\r
 197     <xs:annotation>\r
 198       <xs:documentation>\r
 199         CommPilot Express SR Email Notify configuration used in the context of a get.\r
 200       </xs:documentation>\r
 201     </xs:annotation>\r
 202     <xs:sequence>\r
 203       <xs:element name="sendEmail" type="xs:boolean"/>\r
 204       <xs:element name="emailAddress" type="EmailAddress" minOccurs="0"/>\r
 205     </xs:sequence>\r
 206   </xs:complexType>    \r
 207     \r
 208   <xs:complexType name="CommPilotExpressSREmailNotifyModify">\r
 209     <xs:annotation>\r
 210       <xs:documentation>\r
 211         CommPilot Express SR Email Notify configuration used in the context of a modify.\r
 212       </xs:documentation>\r
 213     </xs:annotation>\r
 214     <xs:sequence>\r
 215       <xs:element name="sendEmail" type="xs:boolean" minOccurs="0"/>\r
 216       <xs:element name="emailAddress" type="EmailAddress" nillable="true" minOccurs="0"/>\r
 217     </xs:sequence>\r
 218   </xs:complexType>    \r
 219     \r
 220   <xs:complexType name="CommPilotExpressSRNoAnswer">\r
 221     <xs:annotation>\r
 222       <xs:documentation>\r
 223         CommPilot Express SR No Answer Settings used in the context of a get.\r
 224       </xs:documentation>\r
 225     </xs:annotation>\r
 226     <xs:sequence>\r
 227       <xs:element name="ringForwardNumbers" type="xs:boolean"/>\r
 228       <xs:element name="forwardingNumberList" type="CommPilotExpressSRRedirectionWithRingList"/>\r
 229       <xs:element name="stillNoAnswer" type="CommPilotExpressSRRedirection"/>\r
 230     </xs:sequence>\r
 231   </xs:complexType>    \r
 232     \r
 233   <xs:complexType name="CommPilotExpressSRNoAnswerModify">\r
 234     <xs:annotation>\r
 235       <xs:documentation>\r
 236         CommPilot Express SR No Answer Settings used in the context of a modify.\r
 237       </xs:documentation>\r
 238     </xs:annotation>\r
 239     <xs:sequence>\r
 240       <xs:element name="ringFowardNumbers" type="xs:boolean" minOccurs="0"/>\r
 241       <xs:element name="forwardingNumberList" type="CommPilotExpressSRRedirectionWithRingList" nillable="true" minOccurs="0"/>\r
 242       <xs:element name="stillNoAnswer" type="CommPilotExpressSRRedirectionModify" minOccurs="0"/>\r
 243     </xs:sequence>\r
 244   </xs:complexType>    \r
 245     \r
 246   <xs:simpleType name="CommPilotExpressSRNumberOfRings">\r
 247     <xs:annotation>\r
 248       <xs:documentation>\r
 249         CommPilot Express SR Number Of Rings.\r
 250       </xs:documentation>\r
 251     </xs:annotation>\r
 252     <xs:restriction base="xs:int">\r
 253       <xs:minInclusive value="2"/>\r
 254       <xs:maxInclusive value="20"/>\r
 255     </xs:restriction>\r
 256   </xs:simpleType>    \r
 257     \r
 258   <xs:simpleType name="CommPilotExpressSRProfile">\r
 259     <xs:annotation>\r
 260       <xs:documentation>\r
 261         CommPilot Express SR Profile Type.\r
 262       </xs:documentation>\r
 263     </xs:annotation>\r
 264     <xs:restriction base="xs:token">\r
 265       <xs:enumeration value="Available In Office"/>\r
 266       <xs:enumeration value="Available Out Of Office"/>\r
 267       <xs:enumeration value="Busy"/>\r
 268       <xs:enumeration value="Unavailable"/>\r
 269     </xs:restriction>\r
 270   </xs:simpleType>    \r
 271     \r
 272   <xs:simpleType name="CommPilotExpressSRRedirectionAction">\r
 273     <xs:annotation>\r
 274       <xs:documentation>\r
 275         CommPilot Express SR Transfer or Forward Options.\r
 276       </xs:documentation>\r
 277     </xs:annotation>\r
 278     <xs:restriction base="xs:token">\r
 279       <xs:enumeration value="Transfer To Voice Mail"/>\r
 280       <xs:enumeration value="Forward"/>\r
 281     </xs:restriction>\r
 282   </xs:simpleType>    \r
 283     \r
 284   <xs:complexType name="CommPilotExpressSRRedirection">\r
 285     <xs:annotation>\r
 286       <xs:documentation>\r
 287         CommPilot Express SR type to transfer to voice Mail or forward to a number\r
 288         used in the context of a get.\r
 289       </xs:documentation>\r
 290     </xs:annotation>\r
 291     <xs:sequence>\r
 292       <xs:element name="action" type="CommPilotExpressSRRedirectionAction"/>\r
 293       <xs:element name="forwardingPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 294     </xs:sequence>\r
 295   </xs:complexType>    \r
 296     \r
 297   <xs:complexType name="CommPilotExpressSRRedirectionModify">\r
 298     <xs:annotation>\r
 299       <xs:documentation>\r
 300         CommPilot Express SR type to transfer to voice Mail or forward to a number\r
 301         used in the context of a modify.\r
 302       </xs:documentation>\r
 303     </xs:annotation>\r
 304     <xs:sequence>\r
 305       <xs:element name="action" type="CommPilotExpressSRRedirectionAction" minOccurs="0"/>\r
 306       <xs:element name="forwardingPhoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 307     </xs:sequence>\r
 308   </xs:complexType>    \r
 309     \r
 310   <xs:complexType name="CommPilotExpressSRRedirectionWithException">\r
 311     <xs:annotation>\r
 312       <xs:documentation>\r
 313         CommPilot Express SR type to transfer to voice mail or forward to a number\r
 314         with certain exceptions used in the context of a get.\r
 315       </xs:documentation>\r
 316     </xs:annotation>\r
 317     <xs:sequence>\r
 318       <xs:element name="sendCallsToVoiceMailExceptExcludedNumbers" type="xs:boolean"/>\r
 319       <xs:element name="excludedPhoneNumber01" type="DN" minOccurs="0"/>\r
 320       <xs:element name="excludedPhoneNumber02" type="DN" minOccurs="0"/>\r
 321       <xs:element name="excludedPhoneNumber03" type="DN" minOccurs="0"/>\r
 322       <xs:element name="forwardExcludedNumbersTo" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 323     </xs:sequence>\r
 324   </xs:complexType>    \r
 325     \r
 326   <xs:complexType name="CommPilotExpressSRRedirectionWithExceptionModify">\r
 327     <xs:annotation>\r
 328       <xs:documentation>\r
 329         CommPilot Express SR type to transfer to voice mail or forward to a number\r
 330         with certain exceptions used in the context of a modify.\r
 331       </xs:documentation>\r
 332     </xs:annotation>\r
 333     <xs:sequence>\r
 334       <xs:element name="sendCallsToVoiceMailExceptExcludedNumbers" type="xs:boolean" minOccurs="0"/>\r
 335       <xs:element name="excludedPhoneNumber01" type="DN" nillable="true" minOccurs="0"/>\r
 336       <xs:element name="excludedPhoneNumber02" type="DN" nillable="true" minOccurs="0"/>\r
 337       <xs:element name="excludedPhoneNumber03" type="DN" nillable="true" minOccurs="0"/>\r
 338       <xs:element name="forwardExcludedNumbersTo" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 339     </xs:sequence>\r
 340   </xs:complexType>    \r
 341     \r
 342   <xs:complexType name="CommPilotExpressSRRedirectionWithRing">\r
 343     <xs:annotation>\r
 344       <xs:documentation>\r
 345         CommPilot Express SR Forward Number Entry with number of times to ring.\r
 346       </xs:documentation>\r
 347     </xs:annotation>\r
 348     <xs:sequence>\r
 349       <xs:element name="phoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 350       <xs:element name="numberOfTimesToRing" type="CommPilotExpressSRNumberOfRings"/>\r
 351     </xs:sequence>\r
 352   </xs:complexType>    \r
 353     \r
 354   <xs:complexType name="CommPilotExpressSRRedirectionWithRingList">\r
 355     <xs:annotation>\r
 356       <xs:documentation>\r
 357         CommPilot Express SR Forward Numbers with number of times to ring.\r
 358       </xs:documentation>\r
 359     </xs:annotation>\r
 360     <xs:sequence>\r
 361       <xs:element name="numberEntry" type="CommPilotExpressSRRedirectionWithRing" minOccurs="0" maxOccurs="5"/>\r
 362     </xs:sequence>\r
 363   </xs:complexType>    \r
 364     \r
 365 </xs:schema>\r