share/OCISchemaAS/Services/OCISchemaServicePersonalAssistant.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 E R S O N A L   A S S I S T A N 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   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- P E R S O N A L   A S S I S T A N T    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     SystemPersonalAssistantGetRequest    \r
  36     SystemPersonalAssistantModifyRequest    \r
  37     UserPersonalAssistantGetRequest    \r
  38     UserPersonalAssistantModifyRequest    \r
  39     UserPersonalAssistantExclusionNumberAddRequest    \r
  40     UserPersonalAssistantExclusionNumberModifyRequest    \r
  41     UserPersonalAssistantExclusionNumberDeleteListRequest    \r
  42     UserPersonalAssistantExclusionNumberGetRequest    \r
  43     UserPersonalAssistantExclusionNumberGetListRequest    \r
  44     UserCallToNumberGetAvailableListRequest    \r
  45     UserPersonalAssistantCallToNumberGetListRequest    \r
  46     UserPersonalAssistantCallToNumberModifyListRequest    \r
  47     \r
  48   --> \r
  49   \r
  50   <xs:complexType name="SystemPersonalAssistantGetRequest">\r
  51     <xs:annotation>\r
  52       <xs:appinfo>\r
  53         <asDataModeSupported>true</asDataModeSupported>\r
  54         <hssDataModeSupported>false</hssDataModeSupported>\r
  55       </xs:appinfo>\r
  56       <xs:documentation>\r
  57         Get system Personal Assistant Parameters.\r
  58         The response is either SystemPersonalAssistantGetResponse or ErrorResponse.\r
  59       </xs:documentation>\r
  60     </xs:annotation>\r
  61     <xs:complexContent>\r
  62       <xs:extension base="core:OCIRequest"/>\r
  63     </xs:complexContent>\r
  64   </xs:complexType>    \r
  65     \r
  66   <xs:complexType name="SystemPersonalAssistantGetResponse">\r
  67     <xs:annotation>\r
  68       <xs:appinfo>\r
  69         <asDataModeSupported>true</asDataModeSupported>\r
  70         <hssDataModeSupported>false</hssDataModeSupported>\r
  71       </xs:appinfo>\r
  72       <xs:documentation>\r
  73         Response to the SystemPersonalAssistantGetRequest.\r
  74         Returns system Personal Assistant Parameters.\r
  75       </xs:documentation>\r
  76     </xs:annotation>\r
  77     <xs:complexContent>\r
  78       <xs:extension base="core:OCIDataResponse">\r
  79         <xs:sequence>\r
  80           <xs:element name="transferToAttendantKey" type="DigitAny"/>\r
  81           <xs:element name="transferToVoiceMessagingKey" type="DigitAny"/>\r
  82         </xs:sequence>\r
  83       </xs:extension>\r
  84     </xs:complexContent>\r
  85   </xs:complexType>    \r
  86     \r
  87   <xs:complexType name="SystemPersonalAssistantModifyRequest">\r
  88     <xs:annotation>\r
  89       <xs:appinfo>\r
  90         <asDataModeSupported>true</asDataModeSupported>\r
  91         <hssDataModeSupported>false</hssDataModeSupported>\r
  92       </xs:appinfo>\r
  93       <xs:documentation>\r
  94         Modify system Personal Assistant Parameters.\r
  95         The response is either a SuccessResponse or an ErrorResponse.\r
  96       </xs:documentation>\r
  97     </xs:annotation>\r
  98     <xs:complexContent>\r
  99       <xs:extension base="core:OCIRequest">\r
 100         <xs:sequence>\r
 101           <xs:element name="transferToAttendantKey" type="DigitAny" minOccurs="0"/>\r
 102           <xs:element name="transferToVoiceMessagingKey" type="DigitAny" minOccurs="0"/>\r
 103         </xs:sequence>\r
 104       </xs:extension>\r
 105     </xs:complexContent>\r
 106   </xs:complexType>    \r
 107     \r
 108   <xs:complexType name="UserPersonalAssistantGetRequest">\r
 109     <xs:annotation>\r
 110       <xs:appinfo>\r
 111         <asDataModeSupported>true</asDataModeSupported>\r
 112         <hssDataModeSupported>false</hssDataModeSupported>\r
 113       </xs:appinfo>\r
 114       <xs:documentation>\r
 115         Request to get the User Personal Assistant information.\r
 116         The response is either a UserPersonalAssistantGetResponse or an ErrorResponse.\r
 117       </xs:documentation>\r
 118     </xs:annotation>\r
 119     <xs:complexContent>\r
 120       <xs:extension base="core:OCIRequest">\r
 121         <xs:sequence>\r
 122           <xs:element name="userId" type="UserId"/>\r
 123         </xs:sequence>\r
 124       </xs:extension>\r
 125     </xs:complexContent>\r
 126   </xs:complexType>    \r
 127     \r
 128   <xs:complexType name="UserPersonalAssistantGetResponse">\r
 129     <xs:annotation>\r
 130       <xs:appinfo>\r
 131         <asDataModeSupported>true</asDataModeSupported>\r
 132         <hssDataModeSupported>false</hssDataModeSupported>\r
 133       </xs:appinfo>\r
 134       <xs:documentation>\r
 135         Response to the UserPersonalAssistantGetRequest.\r
 136         The response contains the user Personal Assistant information".\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:complexContent>\r
 140       <xs:extension base="core:OCIDataResponse">\r
 141         <xs:sequence>\r
 142           <xs:element name="presence" type="PersonalAssistantPresence"/>\r
 143           <xs:element name="enableTransferToAttendant" type="xs:boolean"/>\r
 144           <xs:element name="attendantNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 145           <xs:element name="enableRingSplash" type="xs:boolean"/>\r
 146           <xs:element name="enableExpirationTime" type="xs:boolean"/>\r
 147           <xs:element name="expirationTime" type="xs:dateTime" minOccurs="0"/>\r
 148         </xs:sequence>\r
 149       </xs:extension>\r
 150     </xs:complexContent>\r
 151   </xs:complexType>    \r
 152     \r
 153   <xs:complexType name="UserPersonalAssistantModifyRequest">\r
 154     <xs:annotation>\r
 155       <xs:appinfo>\r
 156         <asDataModeSupported>true</asDataModeSupported>\r
 157         <hssDataModeSupported>false</hssDataModeSupported>\r
 158       </xs:appinfo>\r
 159       <xs:documentation>\r
 160         Modify the User Personal Assistant information.\r
 161         The response is either a SuccessResponse or an ErrorResponse.\r
 162       </xs:documentation>\r
 163     </xs:annotation>\r
 164     <xs:complexContent>\r
 165       <xs:extension base="core:OCIRequest">\r
 166         <xs:sequence>\r
 167           <xs:element name="userId" type="UserId"/>\r
 168           <xs:element name="presence" type="PersonalAssistantPresence" minOccurs="0"/>\r
 169           <xs:element name="enableTransferToAttendant" type="xs:boolean" minOccurs="0"/>\r
 170           <xs:element name="attendantNumber" type="OutgoingDNorSIPURI" minOccurs="0" nillable="true"/>\r
 171           <xs:element name="enableRingSplash" type="xs:boolean" minOccurs="0"/>\r
 172           <xs:element name="enableExpirationTime" type="xs:boolean" minOccurs="0"/>\r
 173           <xs:element name="expirationTime" type="xs:dateTime" minOccurs="0" nillable="true"/>\r
 174         </xs:sequence>\r
 175       </xs:extension>\r
 176     </xs:complexContent>\r
 177   </xs:complexType>    \r
 178     \r
 179   <xs:complexType name="UserPersonalAssistantExclusionNumberAddRequest">\r
 180     <xs:annotation>\r
 181       <xs:appinfo>\r
 182         <asDataModeSupported>true</asDataModeSupported>\r
 183         <hssDataModeSupported>false</hssDataModeSupported>\r
 184       </xs:appinfo>\r
 185       <xs:documentation>\r
 186         Add a User Personal Assistant Exclusion Number.\r
 187         The response is either a SuccessResponse or an ErrorResponse.\r
 188       </xs:documentation>\r
 189     </xs:annotation>\r
 190     <xs:complexContent>\r
 191       <xs:extension base="core:OCIRequest">\r
 192         <xs:sequence>\r
 193           <xs:element name="userId" type="UserId"/>\r
 194           <xs:element name="exclusionNumber" type="DN"/>\r
 195           <xs:element name="description" type="PersonalAssistantExclusionNumberDescription" minOccurs="0"/>\r
 196         </xs:sequence>\r
 197       </xs:extension>\r
 198     </xs:complexContent>\r
 199   </xs:complexType>    \r
 200     \r
 201   <xs:complexType name="UserPersonalAssistantExclusionNumberModifyRequest">\r
 202     <xs:annotation>\r
 203       <xs:appinfo>\r
 204         <asDataModeSupported>true</asDataModeSupported>\r
 205         <hssDataModeSupported>false</hssDataModeSupported>\r
 206       </xs:appinfo>\r
 207       <xs:documentation>\r
 208         Modify an existing User Personal Assistant Exclusion Number description.\r
 209         The response is either a SuccessResponse or an ErrorResponse.\r
 210       </xs:documentation>\r
 211     </xs:annotation>\r
 212     <xs:complexContent>\r
 213       <xs:extension base="core:OCIRequest">\r
 214         <xs:sequence>\r
 215           <xs:element name="userId" type="UserId"/>\r
 216           <xs:element name="exclusionNumber" type="DN"/>\r
 217           <xs:element name="description" type="PersonalAssistantExclusionNumberDescription" nillable="true" minOccurs="0"/>\r
 218         </xs:sequence>\r
 219       </xs:extension>\r
 220     </xs:complexContent>\r
 221   </xs:complexType>    \r
 222     \r
 223   <xs:complexType name="UserPersonalAssistantExclusionNumberDeleteListRequest">\r
 224     <xs:annotation>\r
 225       <xs:appinfo>\r
 226         <asDataModeSupported>true</asDataModeSupported>\r
 227         <hssDataModeSupported>false</hssDataModeSupported>\r
 228       </xs:appinfo>\r
 229       <xs:documentation>\r
 230         Delete a list of User Personal Assistant Exclusion Number.\r
 231         The response is either a SuccessResponse or an ErrorResponse.\r
 232       </xs:documentation>\r
 233     </xs:annotation>\r
 234     <xs:complexContent>\r
 235       <xs:extension base="core:OCIRequest">\r
 236         <xs:sequence>\r
 237           <xs:element name="userId" type="UserId"/>\r
 238           <xs:element name="exclusionNumber" type="DN" maxOccurs="unbounded"/>\r
 239         </xs:sequence>\r
 240       </xs:extension>\r
 241     </xs:complexContent>\r
 242   </xs:complexType>    \r
 243     \r
 244   <xs:complexType name="UserPersonalAssistantExclusionNumberGetRequest">\r
 245     <xs:annotation>\r
 246       <xs:documentation>\r
 247         Get a Personal Assistant Exclusion Number.\r
 248         The response is either UserPersonalAssistantExclusionNumberGetResponse or ErrorResponse.\r
 249       </xs:documentation>\r
 250     </xs:annotation>\r
 251     <xs:complexContent>\r
 252       <xs:extension base="core:OCIRequest">\r
 253         <xs:sequence>\r
 254           <xs:element name="userId" type="UserId"/>\r
 255           <xs:element name="exclusionNumber" type="DN"/>\r
 256         </xs:sequence>\r
 257       </xs:extension>\r
 258     </xs:complexContent>\r
 259   </xs:complexType>    \r
 260     \r
 261   <xs:complexType name="UserPersonalAssistantExclusionNumberGetResponse">\r
 262     <xs:annotation>\r
 263       <xs:documentation>\r
 264         Response to the UserPersonalAssistantExclusionNumberGetRequest\r
 265       </xs:documentation>\r
 266     </xs:annotation>\r
 267     <xs:complexContent>\r
 268       <xs:extension base="core:OCIDataResponse">\r
 269         <xs:sequence>\r
 270           <xs:element name="description" type="PersonalAssistantExclusionNumberDescription" nillable="true" minOccurs="0"/>\r
 271         </xs:sequence>\r
 272       </xs:extension>\r
 273     </xs:complexContent>\r
 274   </xs:complexType>    \r
 275     \r
 276   <xs:complexType name="UserPersonalAssistantExclusionNumberGetListRequest">\r
 277     <xs:annotation>\r
 278       <xs:appinfo>\r
 279         <asDataModeSupported>true</asDataModeSupported>\r
 280         <hssDataModeSupported>false</hssDataModeSupported>\r
 281       </xs:appinfo>\r
 282       <xs:documentation>\r
 283         Request to get the User Personal Assistant Exclusion Number List information. \r
 284         The response is either a userPersonalAssistantExclusionNumberGetListResponse or an ErrorResponse.\r
 285       </xs:documentation>\r
 286     </xs:annotation>\r
 287     <xs:complexContent>\r
 288       <xs:extension base="core:OCIRequest">\r
 289         <xs:sequence>\r
 290           <xs:element name="userId" type="UserId"/>\r
 291           <xs:element name="searchCriteriaPersonalAssistantExclusionNumber" type="SearchCriteriaPersonalAssistantExclusionNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 292           <xs:element name="searchCriteriaPersonalAssistantExclusionNumberDescription" type="SearchCriteriaPersonalAssistantExclusionNumberDescription" minOccurs="0" maxOccurs="unbounded"/>\r
 293           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 294         </xs:sequence>\r
 295       </xs:extension>\r
 296     </xs:complexContent>\r
 297   </xs:complexType>    \r
 298     \r
 299   <xs:complexType name="UserPersonalAssistantExclusionNumberGetListResponse">\r
 300     <xs:annotation>\r
 301       <xs:appinfo>\r
 302         <asDataModeSupported>true</asDataModeSupported>\r
 303         <hssDataModeSupported>false</hssDataModeSupported>\r
 304       </xs:appinfo>\r
 305       <xs:documentation>\r
 306         Response to the UserPersonalAssistantExclusionNumberGetListRequest.\r
 307         Contains a table with column headings:\r
 308         "Number", "Description".\r
 309       </xs:documentation>\r
 310     </xs:annotation>\r
 311     <xs:complexContent>\r
 312       <xs:extension base="core:OCIDataResponse">\r
 313         <xs:sequence>\r
 314           <xs:element name="exclusionNumberTable" type="core:OCITable"/>\r
 315         </xs:sequence>\r
 316       </xs:extension>\r
 317     </xs:complexContent>\r
 318   </xs:complexType>    \r
 319     \r
 320   <xs:complexType name="UserCallToNumberGetAvailableListRequest">\r
 321     <xs:annotation>\r
 322       <xs:appinfo>\r
 323         <asDataModeSupported>true</asDataModeSupported>\r
 324         <hssDataModeSupported>false</hssDataModeSupported>\r
 325       </xs:appinfo>\r
 326       <xs:documentation>\r
 327         Request to get the user available Call to Number List information. The response is either a UserCallToNumberGetAvailableListResponse or an ErrorResponse.\r
 328       </xs:documentation>\r
 329     </xs:annotation>\r
 330     <xs:complexContent>\r
 331       <xs:extension base="core:OCIRequest">\r
 332         <xs:sequence>\r
 333           <xs:element name="userId" type="UserId"/>\r
 334         </xs:sequence>\r
 335       </xs:extension>\r
 336     </xs:complexContent>\r
 337   </xs:complexType>    \r
 338     \r
 339   <xs:complexType name="UserCallToNumberGetAvailableListResponse">\r
 340     <xs:annotation>\r
 341       <xs:appinfo>\r
 342         <asDataModeSupported>true</asDataModeSupported>\r
 343         <hssDataModeSupported>false</hssDataModeSupported>\r
 344       </xs:appinfo>\r
 345       <xs:documentation>\r
 346         Response to the UserCallToNumberGetAvailableListRequest.\r
 347         Contains a list of the user available Call to Numbers".\r
 348       </xs:documentation>\r
 349     </xs:annotation>\r
 350     <xs:complexContent>\r
 351       <xs:extension base="core:OCIDataResponse">\r
 352         <xs:sequence>\r
 353           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 354         </xs:sequence>\r
 355       </xs:extension>\r
 356     </xs:complexContent>\r
 357   </xs:complexType>    \r
 358     \r
 359   <xs:complexType name="UserPersonalAssistantCallToNumberGetListRequest">\r
 360     <xs:annotation>\r
 361       <xs:appinfo>\r
 362         <asDataModeSupported>true</asDataModeSupported>\r
 363         <hssDataModeSupported>false</hssDataModeSupported>\r
 364       </xs:appinfo>\r
 365       <xs:documentation>\r
 366         Request to get the user assigned Call to Number List information. The response is either a UserPersonalAssistantCallToNumberGetListResponse or an ErrorResponse.\r
 367       </xs:documentation>\r
 368     </xs:annotation>\r
 369     <xs:complexContent>\r
 370       <xs:extension base="core:OCIRequest">\r
 371         <xs:sequence>\r
 372           <xs:element name="userId" type="UserId"/>\r
 373         </xs:sequence>\r
 374       </xs:extension>\r
 375     </xs:complexContent>\r
 376   </xs:complexType>    \r
 377     \r
 378   <xs:complexType name="UserPersonalAssistantCallToNumberGetListResponse">\r
 379     <xs:annotation>\r
 380       <xs:appinfo>\r
 381         <asDataModeSupported>true</asDataModeSupported>\r
 382         <hssDataModeSupported>false</hssDataModeSupported>\r
 383       </xs:appinfo>\r
 384       <xs:documentation>\r
 385         Response to the UserPersonalAssistantCallToNumberGetListRequest.\r
 386         Contains a list of assigned Call to Numbers".\r
 387       </xs:documentation>\r
 388     </xs:annotation>\r
 389     <xs:complexContent>\r
 390       <xs:extension base="core:OCIDataResponse">\r
 391         <xs:sequence>\r
 392           <xs:element name="callToNumber" type="CallToNumber" minOccurs="0" maxOccurs="unbounded"/>\r
 393         </xs:sequence>\r
 394       </xs:extension>\r
 395     </xs:complexContent>\r
 396   </xs:complexType>    \r
 397     \r
 398   <xs:complexType name="UserPersonalAssistantCallToNumberModifyListRequest">\r
 399     <xs:annotation>\r
 400       <xs:appinfo>\r
 401         <asDataModeSupported>true</asDataModeSupported>\r
 402         <hssDataModeSupported>false</hssDataModeSupported>\r
 403       </xs:appinfo>\r
 404       <xs:documentation>\r
 405         Request to modify the user assigned Call to Number List information.\r
 406         The response is either a SuccessResponse or an ErrorResponse. \r
 407         For the callToNumbers in the callToNumberList, the extension element \r
 408         is not used and the number element is only used when the type is BroadWorks Mobility.\r
 409       </xs:documentation>\r
 410     </xs:annotation>\r
 411     <xs:complexContent>\r
 412       <xs:extension base="core:OCIRequest">\r
 413         <xs:sequence>\r
 414           <xs:element name="userId" type="UserId"/>\r
 415           <xs:element name="callToNumberList" type="ReplacementCallToNumberList" nillable="true" minOccurs="0"/>\r
 416         </xs:sequence>\r
 417       </xs:extension>\r
 418     </xs:complexContent>\r
 419   </xs:complexType>    \r
 420     \r
 421   <xs:simpleType name="PersonalAssistantPresence">\r
 422     <xs:annotation>\r
 423       <xs:documentation>Personal Assistant Presence.</xs:documentation>\r
 424     </xs:annotation>\r
 425     <xs:restriction base="xs:token">\r
 426       <xs:enumeration value="None"/>\r
 427       <xs:enumeration value="Business Trip"/>\r
 428       <xs:enumeration value="Gone for the Day"/>\r
 429       <xs:enumeration value="Lunch"/>\r
 430       <xs:enumeration value="Meeting"/>\r
 431       <xs:enumeration value="Out Of Office"/>\r
 432       <xs:enumeration value="Temporarily Out"/>\r
 433       <xs:enumeration value="Training"/>\r
 434       <xs:enumeration value="Unavailable"/>\r
 435       <xs:enumeration value="Vacation"/>\r
 436     </xs:restriction>\r
 437   </xs:simpleType>    \r
 438     \r
 439 </xs:schema>\r