share/OCISchemaAS/Services/OCISchemaServiceSpeedDial100.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 P E E D   D I A L 100 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 P E E D   D I A L 100   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     GroupSpeedDial100GetRequest17sp1    \r
  35     GroupSpeedDial100ModifyRequest    \r
  36     SystemSpeedDial100GetRequest17sp1    \r
  37     SystemSpeedDial100ModifyRequest    \r
  38     UserSpeedDial100AddListRequest    \r
  39     UserSpeedDial100DeleteListRequest    \r
  40     UserSpeedDial100GetListRequest17sp1    \r
  41     UserSpeedDial100GetRequest    \r
  42     UserSpeedDial100ModifyListRequest    \r
  43     \r
  44   --> \r
  45   \r
  46   <xs:complexType name="GroupSpeedDial100GetRequest17sp1">\r
  47     <xs:annotation>\r
  48       <xs:documentation>\r
  49         Get the speed dial 100 service settings for a group.\r
  50         The response is either a GroupSpeedDial100GetResponse17sp1 or an ErrorResponse.\r
  51       </xs:documentation>\r
  52     </xs:annotation>\r
  53     <xs:complexContent>\r
  54       <xs:extension base="core:OCIRequest">\r
  55         <xs:sequence>\r
  56           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  57           <xs:element name="groupId" type="GroupId"/>\r
  58         </xs:sequence>\r
  59       </xs:extension>\r
  60     </xs:complexContent>\r
  61   </xs:complexType>    \r
  62     \r
  63   <xs:complexType name="GroupSpeedDial100GetResponse17sp1">\r
  64     <xs:annotation>\r
  65       <xs:documentation>\r
  66         Response to the GroupSpeedDial100GetRequest17sp1.\r
  67       </xs:documentation>\r
  68     </xs:annotation>\r
  69     <xs:complexContent>\r
  70       <xs:extension base="core:OCIDataResponse">\r
  71         <xs:sequence>\r
  72           <xs:element name="prefix" type="SpeedDialPrefix" minOccurs="0"/>\r
  73         </xs:sequence>\r
  74       </xs:extension>\r
  75     </xs:complexContent>\r
  76   </xs:complexType>    \r
  77     \r
  78   <xs:complexType name="GroupSpeedDial100ModifyRequest">\r
  79     <xs:annotation>\r
  80       <xs:documentation>\r
  81         Modify the speed dial 100 prefix setting for a group.\r
  82         The response is either a SuccessResponse or an ErrorResponse.\r
  83       </xs:documentation>\r
  84     </xs:annotation>\r
  85     <xs:complexContent>\r
  86       <xs:extension base="core:OCIRequest">\r
  87         <xs:sequence>\r
  88           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  89           <xs:element name="groupId" type="GroupId"/>\r
  90           <xs:element name="prefix" type="SpeedDialPrefix" nillable="true" 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="SystemSpeedDial100GetRequest17sp1">\r
  97     <xs:annotation>\r
  98       <xs:documentation>\r
  99         Get the speed dial 100 system-wide default setting.\r
 100         The response is either a SystemSpeedDial100GetResponse17sp1 or an ErrorResponse.\r
 101       </xs:documentation>\r
 102     </xs:annotation>\r
 103     <xs:complexContent>\r
 104       <xs:extension base="core:OCIRequest">\r
 105         <xs:sequence/>\r
 106       </xs:extension>\r
 107     </xs:complexContent>\r
 108   </xs:complexType>    \r
 109     \r
 110   <xs:complexType name="SystemSpeedDial100GetResponse17sp1">\r
 111     <xs:annotation>\r
 112       <xs:documentation>\r
 113         Response to the SystemSpeedDial100GetRequest17sp1.\r
 114       </xs:documentation>\r
 115     </xs:annotation>\r
 116     <xs:complexContent>\r
 117       <xs:extension base="core:OCIDataResponse">\r
 118         <xs:sequence>\r
 119           <xs:element name="prefix" type="SpeedDialPrefix" minOccurs="0"/>\r
 120         </xs:sequence>\r
 121       </xs:extension>\r
 122     </xs:complexContent>\r
 123   </xs:complexType>    \r
 124     \r
 125   <xs:complexType name="SystemSpeedDial100ModifyRequest">\r
 126     <xs:annotation>\r
 127       <xs:documentation>\r
 128         Modify the speed dial 100 system-wide default prefix setting.\r
 129         The response is either a SuccessResponse or an ErrorResponse.\r
 130       </xs:documentation>\r
 131     </xs:annotation>\r
 132     <xs:complexContent>\r
 133       <xs:extension base="core:OCIRequest">\r
 134         <xs:sequence>\r
 135           <xs:element name="prefix" type="SpeedDialPrefix" nillable="true" minOccurs="0"/>\r
 136         </xs:sequence>\r
 137       </xs:extension>\r
 138     </xs:complexContent>\r
 139   </xs:complexType>    \r
 140     \r
 141   <xs:complexType name="UserSpeedDial100AddListRequest">\r
 142     <xs:annotation>\r
 143       <xs:documentation>\r
 144         Add one or more speed dial 100 settings for a user.\r
 145         The response is either a SuccessResponse or an ErrorResponse.\r
 146       </xs:documentation>\r
 147     </xs:annotation>\r
 148     <xs:complexContent>\r
 149       <xs:extension base="core:OCIRequest">\r
 150         <xs:sequence>\r
 151           <xs:element name="userId" type="UserId"/>\r
 152           <xs:element name="speedDialEntry" type="SpeedDial100Entry" minOccurs="1" maxOccurs="100"/>\r
 153         </xs:sequence>\r
 154       </xs:extension>\r
 155     </xs:complexContent>\r
 156   </xs:complexType>    \r
 157     \r
 158   <xs:complexType name="UserSpeedDial100DeleteListRequest">\r
 159     <xs:annotation>\r
 160       <xs:documentation>\r
 161         Delete one or more speed dial 100 settings for a user.\r
 162         The response is either a SuccessResponse or an ErrorResponse.\r
 163       </xs:documentation>\r
 164     </xs:annotation>\r
 165     <xs:complexContent>\r
 166       <xs:extension base="core:OCIRequest">\r
 167         <xs:sequence>\r
 168           <xs:element name="userId" type="UserId"/>\r
 169           <xs:element name="speedCode" type="SpeedDial100Code" minOccurs="0" maxOccurs="100"/>\r
 170         </xs:sequence>\r
 171       </xs:extension>\r
 172     </xs:complexContent>\r
 173   </xs:complexType>    \r
 174     \r
 175   <xs:complexType name="UserSpeedDial100GetListRequest17sp1">\r
 176     <xs:annotation>\r
 177       <xs:documentation>\r
 178         Get the speed dial 100 settings for a user.\r
 179         The response is either a UserSpeedDial100GetListResponse17sp1 or an ErrorResponse.\r
 180       </xs:documentation>\r
 181     </xs:annotation>\r
 182     <xs:complexContent>\r
 183       <xs:extension base="core:OCIRequest">\r
 184         <xs:sequence>\r
 185           <xs:element name="userId" type="UserId"/>\r
 186         </xs:sequence>\r
 187       </xs:extension>\r
 188     </xs:complexContent>\r
 189   </xs:complexType>    \r
 190     \r
 191   <xs:complexType name="UserSpeedDial100GetListResponse17sp1">\r
 192     <xs:annotation>\r
 193       <xs:documentation>\r
 194         Response to the UserSpeedDial100GetListRequest17sp1.\r
 195       </xs:documentation>\r
 196     </xs:annotation>\r
 197     <xs:complexContent>\r
 198       <xs:extension base="core:OCIDataResponse">\r
 199         <xs:sequence>\r
 200           <xs:element name="prefix" type="SpeedDialPrefix" minOccurs="0"/>\r
 201           <xs:element name="speedDialEntry" type="SpeedDial100Entry" minOccurs="0" maxOccurs="100"/>\r
 202         </xs:sequence>\r
 203       </xs:extension>\r
 204     </xs:complexContent>\r
 205   </xs:complexType>    \r
 206     \r
 207   <xs:complexType name="UserSpeedDial100GetRequest">\r
 208     <xs:annotation>\r
 209       <xs:documentation>\r
 210         Get speed dial 100 settings for a speed code.\r
 211         The response is either a SuccessResponse or an ErrorResponse.\r
 212       </xs:documentation>\r
 213     </xs:annotation>\r
 214     <xs:complexContent>\r
 215       <xs:extension base="core:OCIRequest">\r
 216         <xs:sequence>\r
 217           <xs:element name="userId" type="UserId"/>\r
 218           <xs:element name="speedCode" type="SpeedDial100Code"/>\r
 219         </xs:sequence>\r
 220       </xs:extension>\r
 221     </xs:complexContent>\r
 222   </xs:complexType>    \r
 223     \r
 224   <xs:complexType name="UserSpeedDial100GetResponse">\r
 225     <xs:annotation>\r
 226       <xs:documentation>\r
 227         Response to the UserSpeedDial100GetRequest.\r
 228       </xs:documentation>\r
 229     </xs:annotation>\r
 230     <xs:complexContent>\r
 231       <xs:extension base="core:OCIDataResponse">\r
 232         <xs:sequence>\r
 233           <xs:element name="phoneNumber" type="OutgoingDNorSIPURI"/>\r
 234           <xs:element name="description" type="SpeedDialDescription" minOccurs="0"/>\r
 235         </xs:sequence>\r
 236       </xs:extension>\r
 237     </xs:complexContent>\r
 238   </xs:complexType>    \r
 239     \r
 240   <xs:complexType name="UserSpeedDial100ModifyListRequest">\r
 241     <xs:annotation>\r
 242       <xs:documentation>\r
 243         Modify the speed dial 100 settings for a user.\r
 244         The response is either a SuccessResponse or an ErrorResponse.\r
 245         Engineering Note: This command is used internally by Call Processing.\r
 246       </xs:documentation>\r
 247     </xs:annotation>\r
 248     <xs:complexContent>\r
 249       <xs:extension base="core:OCIRequest">\r
 250         <xs:sequence>\r
 251           <xs:element name="userId" type="UserId"/>\r
 252           <xs:element name="speedDialEntry" type="SpeedDial100EntryModify" minOccurs="0" maxOccurs="100"/>\r
 253         </xs:sequence>\r
 254       </xs:extension>\r
 255     </xs:complexContent>\r
 256   </xs:complexType>    \r
 257     \r
 258   <xs:complexType name="SpeedDial100Entry">\r
 259     <xs:annotation>\r
 260       <xs:documentation>\r
 261         Modify the speed dial 100 prefix setting for a group.\r
 262         The response is either a SuccessResponse or an ErrorResponse.\r
 263       </xs:documentation>\r
 264     </xs:annotation>\r
 265     <xs:sequence>\r
 266       <xs:element name="speedCode" type="SpeedDial100Code"/>\r
 267       <xs:element name="phoneNumber" type="OutgoingDNorSIPURI"/>\r
 268       <xs:element name="description" type="SpeedDialDescription" minOccurs="0"/>\r
 269     </xs:sequence>\r
 270   </xs:complexType>    \r
 271     \r
 272   <xs:complexType name="SpeedDial100EntryModify">\r
 273     <xs:annotation>\r
 274       <xs:documentation>\r
 275         Modify the speed dial 100 prefix setting for a group.\r
 276         The response is either a SuccessResponse or an ErrorResponse.\r
 277       </xs:documentation>\r
 278     </xs:annotation>\r
 279     <xs:sequence>\r
 280       <xs:element name="speedCode" type="SpeedDial100Code"/>\r
 281       <xs:element name="phoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 282       <xs:element name="description" type="SpeedDialDescription" nillable="true" minOccurs="0"/>\r
 283     </xs:sequence>\r
 284   </xs:complexType>    \r
 285     \r
 286   <xs:simpleType name="SpeedDial100Code">\r
 287     <xs:annotation>\r
 288       <xs:documentation>\r
 289         Speed Dial 100 codes.\r
 290       </xs:documentation>\r
 291     </xs:annotation>\r
 292     <xs:restriction base="xs:int">\r
 293       <xs:minInclusive value="0"/>\r
 294       <xs:maxInclusive value="99"/>\r
 295     </xs:restriction>\r
 296   </xs:simpleType>    \r
 297     \r
 298 </xs:schema>\r