share/OCISchemaAS/Services/OCISchemaServiceCommPilotExpress.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 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    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     UserCommPilotExpressGetRequest    \r
  35     UserCommPilotExpressModifyRequest    \r
  36     \r
  37   --> \r
  38   \r
  39   <xs:complexType name="UserCommPilotExpressGetRequest">\r
  40     <xs:annotation>\r
  41       <xs:documentation>\r
  42         Get the user's commPilot express service setting.\r
  43         The response is either a UserCommPilotExpressGetResponse or an ErrorResponse.\r
  44       </xs:documentation>\r
  45     </xs:annotation>\r
  46     <xs:complexContent>\r
  47       <xs:extension base="core:OCIRequest">\r
  48         <xs:sequence>\r
  49           <xs:element name="userId" type="UserId"/>\r
  50         </xs:sequence>\r
  51       </xs:extension>\r
  52     </xs:complexContent>\r
  53   </xs:complexType>    \r
  54     \r
  55   <xs:complexType name="UserCommPilotExpressGetResponse">\r
  56     <xs:annotation>\r
  57       <xs:documentation>\r
  58         Response to the UserCommPilotExpressGetRequest.\r
  59       </xs:documentation>\r
  60     </xs:annotation>\r
  61     <xs:complexContent>\r
  62       <xs:extension base="core:OCIDataResponse">\r
  63         <xs:sequence>\r
  64           <xs:element name="profile" type="CommPilotExpressProfile" minOccurs="0"/>\r
  65           <xs:element name="availableInOffice" type="CommPilotExpressAvailableInOffice"/>\r
  66           <xs:element name="availableOutOfOffice" type="CommPilotExpressAvailableOutOfOffice"/>\r
  67           <xs:element name="busy" type="CommPilotExpressBusy"/>\r
  68           <xs:element name="unavailable" type="CommPilotExpressUnavailable"/>\r
  69         </xs:sequence>\r
  70       </xs:extension>\r
  71     </xs:complexContent>\r
  72   </xs:complexType>    \r
  73     \r
  74   <xs:complexType name="UserCommPilotExpressModifyRequest">\r
  75     <xs:annotation>\r
  76       <xs:documentation>\r
  77         Modify the user's commPilot express service setting.\r
  78         The response is either a SuccessResponse or an ErrorResponse.\r
  79         Engineering Note: This command is used internally by Call Processing.\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="CommPilotExpressProfile" nillable="true" minOccurs="0"/>\r
  87           <xs:element name="availableInOffice" type="CommPilotExpressAvailableInOfficeModify" minOccurs="0"/>\r
  88           <xs:element name="availableOutOfOffice" type="CommPilotExpressAvailableOutOfOfficeModify" minOccurs="0"/>\r
  89           <xs:element name="busy" type="CommPilotExpressBusyModify" minOccurs="0"/>\r
  90           <xs:element name="unavailable" type="CommPilotExpressUnavailableModify" 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="CommPilotExpressAvailableInOffice">\r
  97     <xs:annotation>\r
  98       <xs:documentation>\r
  99         CommPilot Express Available In Office Settings.\r
 100       </xs:documentation>\r
 101     </xs:annotation>\r
 102     <xs:sequence>\r
 103       <xs:element name="additionalPhoneNumberToRing" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 104       <xs:element name="busySetting" type="CommPilotExpressRedirection"/>\r
 105       <xs:element name="noAnswerSetting" type="CommPilotExpressRedirection"/>\r
 106     </xs:sequence>\r
 107   </xs:complexType>    \r
 108     \r
 109   <xs:complexType name="CommPilotExpressAvailableInOfficeModify">\r
 110     <xs:annotation>\r
 111       <xs:documentation>\r
 112         CommPilot Express Available In Office Settings.\r
 113       </xs:documentation>\r
 114     </xs:annotation>\r
 115     <xs:sequence>\r
 116       <xs:element name="additionalPhoneNumberToRing" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 117       <xs:element name="busySetting" type="CommPilotExpressRedirectionModify" minOccurs="0"/>\r
 118       <xs:element name="noAnswerSetting" type="CommPilotExpressRedirectionModify" minOccurs="0"/>\r
 119     </xs:sequence>\r
 120   </xs:complexType>    \r
 121     \r
 122   <xs:complexType name="CommPilotExpressAvailableOutOfOffice">\r
 123     <xs:annotation>\r
 124       <xs:documentation>\r
 125         CommPilot Express 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="incomingCalls" type="CommPilotExpressRedirection"/>\r
 130       <xs:element name="incomingCallNotify" type="CommPilotExpressEmailNotify"/>\r
 131     </xs:sequence>\r
 132   </xs:complexType>    \r
 133     \r
 134   <xs:complexType name="CommPilotExpressAvailableOutOfOfficeModify">\r
 135     <xs:annotation>\r
 136       <xs:documentation>\r
 137         CommPilot Express Available Out Of Office Configuration used in the context of a modify.\r
 138       </xs:documentation>\r
 139     </xs:annotation>\r
 140     <xs:sequence>\r
 141       <xs:element name="incomingCalls" type="CommPilotExpressRedirectionModify" minOccurs="0"/>\r
 142       <xs:element name="incomingCallNotify" type="CommPilotExpressEmailNotifyModify" minOccurs="0"/>\r
 143     </xs:sequence>\r
 144   </xs:complexType>    \r
 145     \r
 146   <xs:complexType name="CommPilotExpressBusy">\r
 147     <xs:annotation>\r
 148       <xs:documentation>\r
 149         CommPilot Express Available In Office Configuration used in the context of a get.\r
 150       </xs:documentation>\r
 151     </xs:annotation>\r
 152     <xs:sequence>\r
 153       <xs:element name="incomingCalls" type="CommPilotExpressRedirectionWithException"/>\r
 154       <xs:element name="voiceMailNotify" type="CommPilotExpressEmailNotify"/>\r
 155     </xs:sequence>\r
 156   </xs:complexType>    \r
 157     \r
 158   <xs:complexType name="CommPilotExpressBusyModify">\r
 159     <xs:annotation>\r
 160       <xs:documentation>\r
 161         CommPilot Express Available In Office Configuration used in the context of a modify.\r
 162       </xs:documentation>\r
 163     </xs:annotation>\r
 164     <xs:sequence>\r
 165       <xs:element name="incomingCalls" type="CommPilotExpressRedirectionWithExceptionModify" minOccurs="0"/>\r
 166       <xs:element name="voiceMailNotify" type="CommPilotExpressEmailNotifyModify" minOccurs="0"/>\r
 167     </xs:sequence>\r
 168   </xs:complexType>    \r
 169     \r
 170   <xs:complexType name="CommPilotExpressUnavailable">\r
 171     <xs:annotation>\r
 172       <xs:documentation>\r
 173         CommPilot Express Unavailable Configuration used in the context of a get.\r
 174       </xs:documentation>\r
 175     </xs:annotation>\r
 176     <xs:sequence>\r
 177       <xs:element name="incomingCalls" type="CommPilotExpressRedirectionWithException"/>\r
 178       <xs:element name="voiceMailGreeting" type="CommPilotExpressVoiceMailGreeting"/>\r
 179     </xs:sequence>\r
 180   </xs:complexType>    \r
 181     \r
 182   <xs:complexType name="CommPilotExpressUnavailableModify">\r
 183     <xs:annotation>\r
 184       <xs:documentation>\r
 185         CommPilot Express Unavailable Configuration used in the context of a modify.\r
 186       </xs:documentation>\r
 187     </xs:annotation>\r
 188     <xs:sequence>\r
 189       <xs:element name="incomingCalls" type="CommPilotExpressRedirectionWithExceptionModify" minOccurs="0"/>\r
 190       <xs:element name="voiceMailGreeting" type="CommPilotExpressVoiceMailGreeting" minOccurs="0"/>\r
 191     </xs:sequence>\r
 192   </xs:complexType>    \r
 193     \r
 194   <xs:complexType name="CommPilotExpressEmailNotify">\r
 195     <xs:annotation>\r
 196       <xs:documentation>\r
 197         CommPilot Express Email Notify configuration used in the context of a get.\r
 198       </xs:documentation>\r
 199     </xs:annotation>\r
 200     <xs:sequence>\r
 201       <xs:element name="sendEmail" type="xs:boolean"/>\r
 202       <xs:element name="emailAddress" type="EmailAddress" minOccurs="0"/>\r
 203     </xs:sequence>\r
 204   </xs:complexType>    \r
 205     \r
 206   <xs:complexType name="CommPilotExpressEmailNotifyModify">\r
 207     <xs:annotation>\r
 208       <xs:documentation>\r
 209         CommPilot Express Email Notify configuration used in the context of a modify.\r
 210       </xs:documentation>\r
 211     </xs:annotation>\r
 212     <xs:sequence>\r
 213       <xs:element name="sendEmail" type="xs:boolean" minOccurs="0"/>\r
 214       <xs:element name="emailAddress" type="EmailAddress" nillable="true" minOccurs="0"/>\r
 215     </xs:sequence>\r
 216   </xs:complexType>    \r
 217     \r
 218   <xs:simpleType name="CommPilotExpressProfile">\r
 219     <xs:annotation>\r
 220       <xs:documentation>\r
 221         CommPilot Express Profile Type.\r
 222       </xs:documentation>\r
 223     </xs:annotation>\r
 224     <xs:restriction base="xs:token">\r
 225       <xs:enumeration value="Available In Office"/>\r
 226       <xs:enumeration value="Available Out Of Office"/>\r
 227       <xs:enumeration value="Busy"/>\r
 228       <xs:enumeration value="Unavailable"/>\r
 229     </xs:restriction>\r
 230   </xs:simpleType>    \r
 231     \r
 232   <xs:simpleType name="CommPilotExpressVoiceMailGreeting">\r
 233     <xs:annotation>\r
 234       <xs:documentation>\r
 235         CommPilot Express Voice Messaging Greeting Choices.\r
 236       </xs:documentation>\r
 237     </xs:annotation>\r
 238     <xs:restriction base="xs:token">\r
 239       <xs:enumeration value="No Answer"/>\r
 240       <xs:enumeration value="Unavailable"/>\r
 241     </xs:restriction>\r
 242   </xs:simpleType>    \r
 243     \r
 244   <xs:simpleType name="CommPilotExpressRedirectionAction">\r
 245     <xs:annotation>\r
 246       <xs:documentation>\r
 247         CommPilot Express Transfer or Forward Options.\r
 248       </xs:documentation>\r
 249     </xs:annotation>\r
 250     <xs:restriction base="xs:token">\r
 251       <xs:enumeration value="Transfer To Voice Mail"/>\r
 252       <xs:enumeration value="Forward"/>\r
 253     </xs:restriction>\r
 254   </xs:simpleType>    \r
 255     \r
 256   <xs:complexType name="CommPilotExpressRedirection">\r
 257     <xs:annotation>\r
 258       <xs:documentation>\r
 259         CommPilot Express type to transfer to voice Mail or forward to a number\r
 260         used in the context of a get.\r
 261       </xs:documentation>\r
 262     </xs:annotation>\r
 263     <xs:sequence>\r
 264       <xs:element name="action" type="CommPilotExpressRedirectionAction"/>\r
 265       <xs:element name="forwardingPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 266     </xs:sequence>\r
 267   </xs:complexType>    \r
 268     \r
 269   <xs:complexType name="CommPilotExpressRedirectionModify">\r
 270     <xs:annotation>\r
 271       <xs:documentation>\r
 272         CommPilot Express type to transfer to voice Mail or forward to a number\r
 273         used in the context of a modify.\r
 274       </xs:documentation>\r
 275     </xs:annotation>\r
 276     <xs:sequence>\r
 277       <xs:element name="action" type="CommPilotExpressRedirectionAction" minOccurs="0"/>\r
 278       <xs:element name="forwardingPhoneNumber" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 279     </xs:sequence>\r
 280   </xs:complexType>    \r
 281     \r
 282   <xs:complexType name="CommPilotExpressRedirectionWithException">\r
 283     <xs:annotation>\r
 284       <xs:documentation>\r
 285         CommPilot Express type to transfer to voice mail or forward to a number\r
 286         with certain exceptions used in the context of a get.\r
 287       </xs:documentation>\r
 288     </xs:annotation>\r
 289     <xs:sequence>\r
 290       <xs:element name="sendCallsToVoiceMailExceptExcludedNumbers" type="xs:boolean"/>\r
 291       <xs:element name="excludedPhoneNumber01" type="DN" minOccurs="0"/>\r
 292       <xs:element name="excludedPhoneNumber02" type="DN" minOccurs="0"/>\r
 293       <xs:element name="excludedPhoneNumber03" type="DN" minOccurs="0"/>\r
 294       <xs:element name="forwardExcludedNumbersTo" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 295     </xs:sequence>\r
 296   </xs:complexType>    \r
 297     \r
 298   <xs:complexType name="CommPilotExpressRedirectionWithExceptionModify">\r
 299     <xs:annotation>\r
 300       <xs:documentation>\r
 301         CommPilot Express type to transfer to voice mail or forward to a number\r
 302         with certain exceptions used in the context of a modify.\r
 303       </xs:documentation>\r
 304     </xs:annotation>\r
 305     <xs:sequence>\r
 306       <xs:element name="sendCallsToVoiceMailExceptExcludedNumbers" type="xs:boolean" minOccurs="0"/>\r
 307       <xs:element name="excludedPhoneNumber01" type="DN" nillable="true" minOccurs="0"/>\r
 308       <xs:element name="excludedPhoneNumber02" type="DN" nillable="true" minOccurs="0"/>\r
 309       <xs:element name="excludedPhoneNumber03" type="DN" nillable="true" minOccurs="0"/>\r
 310       <xs:element name="forwardExcludedNumbersTo" type="OutgoingDNorSIPURI" nillable="true" minOccurs="0"/>\r
 311     </xs:sequence>\r
 312   </xs:complexType>    \r
 313     \r
 314 </xs:schema>\r