share/OCISchemaAS/Services/OCISchemaServiceSMDIMessageDesk.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   M   D   I   M E S S A G E   D E S K  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   M   D   I   M E S S A G E   D E S K                                            -->\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     SystemSMDIMessageDeskAddServerRequest    \r
  36     SystemSMDIMessageDeskDeleteServerRequest    \r
  37     SystemSMDIMessageDeskGetServerListRequest    \r
  38     SystemSMDIMessageDeskModifyServerRequest    \r
  39     SystemSMDIMessageDeskAddServerRouteRequest    \r
  40     SystemSMDIMessageDeskDeleteServerRouteRequest    \r
  41     SystemSMDIMessageDeskGetServerRouteListRequest    \r
  42     SystemSMDIMessageDeskModifyServerRouteRequest    \r
  43     UserSMDIMessageDeskAddServerRequest    \r
  44     UserSMDIMessageDeskDeleteServerListRequest    \r
  45     UserSMDIMessageDeskGetRequest    \r
  46     UserSMDIMessageDeskGetServerListRequest    \r
  47     UserSMDIMessageDeskModifyRequest    \r
  48     \r
  49   --> \r
  50   \r
  51   <xs:complexType name="SystemSMDIMessageDeskAddServerRequest">\r
  52     <xs:annotation>\r
  53       <xs:documentation>\r
  54         Request to add a SMDI Server to the system.\r
  55         The response is either a SuccessResponse or an ErrorResponse.\r
  56       </xs:documentation>\r
  57     </xs:annotation>\r
  58     <xs:complexContent>\r
  59       <xs:extension base="core:OCIRequest">\r
  60         <xs:sequence>\r
  61           <xs:element name="deviceName" type="SMDIDeviceName"/>\r
  62           <xs:element name="netAddress" type="NetAddress"/>\r
  63           <xs:element name="port" type="Port"/>\r
  64           <xs:element name="description" type="SMDIServerDescription" minOccurs="0"/>\r
  65         </xs:sequence>\r
  66       </xs:extension>\r
  67     </xs:complexContent>\r
  68   </xs:complexType>    \r
  69     \r
  70   <xs:complexType name="SystemSMDIMessageDeskDeleteServerRequest">\r
  71     <xs:annotation>\r
  72       <xs:documentation>\r
  73         Request to delete a SMDI Server from the system.\r
  74         The response is either a SuccessResponse or an ErrorResponse.\r
  75       </xs:documentation>\r
  76     </xs:annotation>\r
  77     <xs:complexContent>\r
  78       <xs:extension base="core:OCIRequest">\r
  79         <xs:sequence>\r
  80           <xs:element name="deviceName" type="SMDIDeviceName"/>\r
  81         </xs:sequence>\r
  82       </xs:extension>\r
  83     </xs:complexContent>\r
  84   </xs:complexType>    \r
  85     \r
  86   <xs:complexType name="SystemSMDIMessageDeskGetServerListRequest">\r
  87     <xs:annotation>\r
  88       <xs:documentation>\r
  89         Request to get a list of SMDI Servers defined in the system.\r
  90         The response is either a SystemSMDIMessageDeskGetServerListResponse or an ErrorResponse.\r
  91       </xs:documentation>\r
  92     </xs:annotation>\r
  93     <xs:complexContent>\r
  94       <xs:extension base="core:OCIRequest">\r
  95         <xs:sequence/>\r
  96       </xs:extension>\r
  97     </xs:complexContent>\r
  98   </xs:complexType>    \r
  99     \r
 100   <xs:complexType name="SystemSMDIMessageDeskGetServerListResponse">\r
 101     <xs:annotation>\r
 102       <xs:documentation>\r
 103         Response to SystemMediaServerGetListRequest. The SMDI Server table column\r
 104         headings are: "Device Name", "Net Address", "Port" and "Description".\r
 105       </xs:documentation>\r
 106     </xs:annotation>\r
 107     <xs:complexContent>\r
 108       <xs:extension base="core:OCIDataResponse">\r
 109         <xs:sequence>\r
 110           <xs:element name="smdiServerTable" type="core:OCITable"/>\r
 111         </xs:sequence>\r
 112       </xs:extension>\r
 113     </xs:complexContent>\r
 114   </xs:complexType>    \r
 115     \r
 116   <xs:complexType name="SystemSMDIMessageDeskModifyServerRequest">\r
 117     <xs:annotation>\r
 118       <xs:documentation>\r
 119         Request to modify a SMDI Server in the system.\r
 120         The response is either a SuccessResponse or an ErrorResponse.\r
 121       </xs:documentation>\r
 122     </xs:annotation>\r
 123     <xs:complexContent>\r
 124       <xs:extension base="core:OCIRequest">\r
 125         <xs:sequence>\r
 126           <xs:element name="deviceName" type="SMDIDeviceName"/>\r
 127           <xs:element name="netAddress" type="NetAddress" minOccurs="0"/>\r
 128           <xs:element name="port" type="Port" minOccurs="0"/>\r
 129           <xs:element name="description" type="SMDIServerDescription" nillable="true" minOccurs="0"/>\r
 130         </xs:sequence>\r
 131       </xs:extension>\r
 132     </xs:complexContent>\r
 133   </xs:complexType>    \r
 134     \r
 135   <xs:complexType name="SystemSMDIMessageDeskAddServerRouteRequest">\r
 136     <xs:annotation>\r
 137       <xs:documentation>\r
 138         Request to add a SMDI Server route to the system.\r
 139         The response is either a SuccessResponse or an ErrorResponse.\r
 140       </xs:documentation>\r
 141     </xs:annotation>\r
 142     <xs:complexContent>\r
 143       <xs:extension base="core:OCIRequest">\r
 144         <xs:sequence>\r
 145           <xs:element name="routeDestination" type="SMDIServerRouteDestination"/>\r
 146           <xs:element name="deviceName" type="SMDIDeviceName" maxOccurs="unbounded"/>\r
 147         </xs:sequence>\r
 148       </xs:extension>\r
 149     </xs:complexContent>\r
 150   </xs:complexType>    \r
 151     \r
 152   <xs:complexType name="SystemSMDIMessageDeskDeleteServerRouteRequest">\r
 153     <xs:annotation>\r
 154       <xs:documentation>\r
 155         Request to delete a SMDI Server route from the system.\r
 156         The response is either a SuccessResponse or an ErrorResponse.\r
 157       </xs:documentation>\r
 158     </xs:annotation>\r
 159     <xs:complexContent>\r
 160       <xs:extension base="core:OCIRequest">\r
 161         <xs:sequence>\r
 162           <xs:element name="routeDestination" type="SMDIServerRouteDestination"/>\r
 163         </xs:sequence>\r
 164       </xs:extension>\r
 165     </xs:complexContent>\r
 166   </xs:complexType>    \r
 167     \r
 168   <xs:complexType name="SystemSMDIMessageDeskGetServerRouteListRequest">\r
 169     <xs:annotation>\r
 170       <xs:documentation>\r
 171         Request to get a list of SMDI Servers routes in the system.\r
 172         The response is either a SystemSMDIMessageDeskGetServerRouteListResponse or an ErrorResponse.\r
 173       </xs:documentation>\r
 174     </xs:annotation>\r
 175     <xs:complexContent>\r
 176       <xs:extension base="core:OCIRequest">\r
 177         <xs:sequence/>\r
 178       </xs:extension>\r
 179     </xs:complexContent>\r
 180   </xs:complexType>    \r
 181     \r
 182   <xs:complexType name="SystemSMDIMessageDeskGetServerRouteListResponse">\r
 183     <xs:annotation>\r
 184       <xs:documentation>\r
 185         Response to SystemSMDIMessageDeskGetServerRouteListRequest.\r
 186         The SMDI Server route table column headings are: "Destination" and "SMDI Servers".\r
 187       </xs:documentation>\r
 188     </xs:annotation>\r
 189     <xs:complexContent>\r
 190       <xs:extension base="core:OCIDataResponse">\r
 191         <xs:sequence>\r
 192           <xs:element name="smdiServerRouteTable" type="core:OCITable"/>\r
 193         </xs:sequence>\r
 194       </xs:extension>\r
 195     </xs:complexContent>\r
 196   </xs:complexType>    \r
 197     \r
 198   <xs:complexType name="SystemSMDIMessageDeskModifyServerRouteRequest">\r
 199     <xs:annotation>\r
 200       <xs:documentation>\r
 201         Replace the list of devices associated with a SMDI server route destination.\r
 202         There must be at least one device in the list.\r
 203         The response is either a SuccessResponse or an ErrorResponse.\r
 204       </xs:documentation>\r
 205     </xs:annotation>\r
 206     <xs:complexContent>\r
 207       <xs:extension base="core:OCIRequest">\r
 208         <xs:sequence>\r
 209           <xs:element name="routeDestination" type="SMDIServerRouteDestination"/>\r
 210           <xs:element name="deviceNameList" minOccurs="0">\r
 211             <xs:complexType>\r
 212               <xs:annotation/>\r
 213               <xs:sequence>\r
 214                 <xs:element name="deviceName" type="SMDIDeviceName" minOccurs="1" maxOccurs="unbounded"/>\r
 215               </xs:sequence>\r
 216             </xs:complexType>\r
 217           </xs:element>\r
 218         </xs:sequence>\r
 219       </xs:extension>\r
 220     </xs:complexContent>\r
 221   </xs:complexType>    \r
 222     \r
 223   <xs:complexType name="UserSMDIMessageDeskAddServerRequest">\r
 224     <xs:annotation>\r
 225       <xs:documentation>\r
 226         Request to add a SMDI Server for a user.\r
 227         The response is either a SuccessResponse or an ErrorResponse.\r
 228       </xs:documentation>\r
 229     </xs:annotation>\r
 230     <xs:complexContent>\r
 231       <xs:extension base="core:OCIRequest">\r
 232         <xs:sequence>\r
 233           <xs:element name="userId" type="UserId"/>\r
 234           <xs:element name="deviceName" type="SMDIDeviceName"/>\r
 235           <xs:element name="netAddress" type="NetAddress"/>\r
 236           <xs:element name="port" type="Port"/>\r
 237         </xs:sequence>\r
 238       </xs:extension>\r
 239     </xs:complexContent>\r
 240   </xs:complexType>    \r
 241     \r
 242   <xs:complexType name="UserSMDIMessageDeskDeleteServerListRequest">\r
 243     <xs:annotation>\r
 244       <xs:documentation>\r
 245         Request to delete a list of SMDI Servers for a user.\r
 246         The response is either a SuccessResponse or an ErrorResponse.\r
 247       </xs:documentation>\r
 248     </xs:annotation>\r
 249     <xs:complexContent>\r
 250       <xs:extension base="core:OCIRequest">\r
 251         <xs:sequence>\r
 252           <xs:element name="userId" type="UserId"/>\r
 253           <xs:element name="deviceName" type="SMDIDeviceName" minOccurs="1" maxOccurs="unbounded"/>\r
 254         </xs:sequence>\r
 255       </xs:extension>\r
 256     </xs:complexContent>\r
 257   </xs:complexType>    \r
 258     \r
 259   <xs:complexType name="UserSMDIMessageDeskGetRequest">\r
 260     <xs:annotation>\r
 261       <xs:documentation>\r
 262         Get the user's SMDI Message Desk service personal setting.\r
 263         The response is either a UserSMDIMessageDeskGetResponse or an ErrorResponse.\r
 264       </xs:documentation>\r
 265     </xs:annotation>\r
 266     <xs:complexContent>\r
 267       <xs:extension base="core:OCIRequest">\r
 268         <xs:sequence>\r
 269           <xs:element name="userId" type="UserId"/>\r
 270         </xs:sequence>\r
 271       </xs:extension>\r
 272     </xs:complexContent>\r
 273   </xs:complexType>    \r
 274     \r
 275   <xs:complexType name="UserSMDIMessageDeskGetResponse">\r
 276     <xs:annotation>\r
 277       <xs:documentation>\r
 278         Response to the UserSMDIMessageDeskGetRequest.\r
 279       </xs:documentation>\r
 280     </xs:annotation>\r
 281     <xs:complexContent>\r
 282       <xs:extension base="core:OCIDataResponse">\r
 283         <xs:sequence>\r
 284           <xs:element name="isActive" type="xs:boolean"/>\r
 285           <xs:element name="messageDeskNumber" type="SMDIMessageDeskNumber" minOccurs="0"/>\r
 286         </xs:sequence>\r
 287       </xs:extension>\r
 288     </xs:complexContent>\r
 289   </xs:complexType>    \r
 290     \r
 291   <xs:complexType name="UserSMDIMessageDeskGetServerListRequest">\r
 292     <xs:annotation>\r
 293       <xs:documentation>\r
 294         Request to get a list of SMDI Servers defined for a user.\r
 295         The response is either a UserSMDIMessageDeskGetServerListResponse or an ErrorResponse.\r
 296       </xs:documentation>\r
 297     </xs:annotation>\r
 298     <xs:complexContent>\r
 299       <xs:extension base="core:OCIRequest">\r
 300         <xs:sequence>\r
 301           <xs:element name="userId" type="UserId"/>\r
 302         </xs:sequence>\r
 303       </xs:extension>\r
 304     </xs:complexContent>\r
 305   </xs:complexType>    \r
 306     \r
 307   <xs:complexType name="UserSMDIMessageDeskGetServerListResponse">\r
 308     <xs:annotation>\r
 309       <xs:documentation>\r
 310         Response to the UserSMDIMessageDeskGetServerListRequest.\r
 311         The SMDI Server table column headings are: "Device Name", "Net Address", "Port".\r
 312       </xs:documentation>\r
 313     </xs:annotation>\r
 314     <xs:complexContent>\r
 315       <xs:extension base="core:OCIDataResponse">\r
 316         <xs:sequence>\r
 317           <xs:element name="smdiServerTable" type="core:OCITable"/>\r
 318         </xs:sequence>\r
 319       </xs:extension>\r
 320     </xs:complexContent>\r
 321   </xs:complexType>    \r
 322     \r
 323   <xs:complexType name="UserSMDIMessageDeskModifyRequest">\r
 324     <xs:annotation>\r
 325       <xs:documentation>\r
 326         Modify the user's SMDI Message Desk service setting.\r
 327         The response is either a SuccessResponse 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:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 335           <xs:element name="messageDeskNumber" type="SMDIMessageDeskNumber" nillable="true" minOccurs="0"/>\r
 336         </xs:sequence>\r
 337       </xs:extension>\r
 338     </xs:complexContent>\r
 339   </xs:complexType>    \r
 340     \r
 341   <xs:simpleType name="SMDIDeviceName">\r
 342     <xs:annotation>\r
 343       <xs:documentation>\r
 344         SMDI device name.\r
 345       </xs:documentation>\r
 346     </xs:annotation>\r
 347     <xs:restriction base="xs:token">\r
 348       <xs:minLength value="1"/>\r
 349       <xs:maxLength value="40"/>\r
 350     </xs:restriction>\r
 351   </xs:simpleType>    \r
 352     \r
 353   <xs:simpleType name="SMDIMessageDeskNumber">\r
 354     <xs:annotation>\r
 355       <xs:documentation>\r
 356         SMDI Message Desk number.\r
 357       </xs:documentation>\r
 358     </xs:annotation>\r
 359     <xs:restriction base="xs:token">\r
 360       <xs:minLength value="1"/>\r
 361       <xs:maxLength value="3"/>\r
 362     </xs:restriction>\r
 363   </xs:simpleType>    \r
 364     \r
 365   <xs:simpleType name="SMDIServerDescription">\r
 366     <xs:annotation>\r
 367       <xs:documentation>\r
 368         SMDI server description.\r
 369       </xs:documentation>\r
 370     </xs:annotation>\r
 371     <xs:restriction base="xs:token">\r
 372       <xs:minLength value="1"/>\r
 373       <xs:maxLength value="80"/>\r
 374     </xs:restriction>\r
 375   </xs:simpleType>    \r
 376     \r
 377   <xs:simpleType name="SMDIServerRouteDestination">\r
 378     <xs:annotation>\r
 379       <xs:documentation>\r
 380         SMDI server route destination, a 3 to 10 digits number\r
 381       </xs:documentation>\r
 382     </xs:annotation>\r
 383     <xs:restriction base="xs:token">\r
 384       <xs:minLength value="1"/>\r
 385       <xs:maxLength value="10"/>\r
 386     </xs:restriction>\r
 387   </xs:simpleType>    \r
 388     \r
 389 </xs:schema>\r