share/OCISchemaAS/Services/OCISchemaServiceLegacyAutomaticCallback.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 <!-- L E G A C Y   A U T O M A T I C   C A L L B A C 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   <!-- L E G A C Y   A U T O M A T I C   C A L L B A C 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     SystemLegacyAutomaticCallbackGetLineTypeListRequest    \r
  36     SystemLegacyAutomaticCallbackGetRequest    \r
  37     SystemLegacyAutomaticCallbackModifyLineTypeRequest    \r
  38     SystemLegacyAutomaticCallbackModifyRequest    \r
  39     UserLegacyAutomaticCallbackGetRequest    \r
  40     UserLegacyAutomaticCallbackModifyRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="SystemLegacyAutomaticCallbackGetLineTypeListRequest">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47         Request the system's legacy automatic callback line type settings.\r
  48         The response is either a SystemLegacyAutomaticCallbackGetTypeLineListResponse or \r
  49         an ErrorResponse.\r
  50       </xs:documentation>\r
  51     </xs:annotation>\r
  52     <xs:complexContent>\r
  53       <xs:extension base="core:OCIRequest">\r
  54         <xs:sequence/>\r
  55       </xs:extension>\r
  56     </xs:complexContent>\r
  57   </xs:complexType>    \r
  58     \r
  59   <xs:complexType name="SystemLegacyAutomaticCallbackGetLineTypeListResponse">\r
  60     <xs:annotation>\r
  61       <xs:documentation>\r
  62         Response to SystemLegacyAutomaticCallbackGetLineTypeListRequest. Returns a 3 column\r
  63         table with column headings: "Line Type", "Match" and "No Match". The possible values\r
  64         for the "Match" and "No Match" columns are "Accept" and "Deny".\r
  65       </xs:documentation>\r
  66     </xs:annotation>\r
  67     <xs:complexContent>\r
  68       <xs:extension base="core:OCIDataResponse">\r
  69         <xs:sequence>\r
  70           <xs:element name="lineTypeTable" type="core:OCITable"/>\r
  71         </xs:sequence>\r
  72       </xs:extension>\r
  73     </xs:complexContent>\r
  74   </xs:complexType>    \r
  75     \r
  76   <xs:complexType name="SystemLegacyAutomaticCallbackGetRequest">\r
  77     <xs:annotation>\r
  78       <xs:documentation>\r
  79         Request the system's legacy automatic callback attributes.\r
  80         The response is either a SystemLegacyAutomaticCallbackGetResponse or an ErrorResponse.\r
  81       </xs:documentation>\r
  82     </xs:annotation>\r
  83     <xs:complexContent>\r
  84       <xs:extension base="core:OCIRequest">\r
  85         <xs:sequence/>\r
  86       </xs:extension>\r
  87     </xs:complexContent>\r
  88   </xs:complexType>    \r
  89     \r
  90   <xs:complexType name="SystemLegacyAutomaticCallbackGetResponse">\r
  91     <xs:annotation>\r
  92       <xs:documentation>\r
  93         Response to SystemLegacyAutomaticCallbackGetRequest.\r
  94       </xs:documentation>\r
  95     </xs:annotation>\r
  96     <xs:complexContent>\r
  97       <xs:extension base="core:OCIDataResponse">\r
  98         <xs:sequence>\r
  99           <xs:element name="maxMonitorsPerOriginator" type="LegacyAutomaticCallbackMaxMonitorsPerOriginator"/>\r
 100           <xs:element name="maxMonitorsPerTerminator" type="LegacyAutomaticCallbackMaxMonitorsPerTerminator"/>\r
 101           <xs:element name="t2Minutes" type="LegacyAutomaticCallbackT2Minutes"/>\r
 102           <xs:element name="t4Seconds" type="LegacyAutomaticCallbackT4Seconds"/>\r
 103           <xs:element name="t5Seconds" type="LegacyAutomaticCallbackT5Seconds"/>\r
 104           <xs:element name="t6Minutes" type="LegacyAutomaticCallbackT6Minutes"/>\r
 105           <xs:element name="t7Minutes" type="LegacyAutomaticCallbackT7Minutes"/>\r
 106           <xs:element name="t8Seconds" type="LegacyAutomaticCallbackT8Seconds"/>\r
 107           <xs:element name="tRingSeconds" type="LegacyAutomaticCallbackTRingSeconds"/>\r
 108           <xs:element name="t10OMinutes" type="LegacyAutomaticCallbackT10OMinutes"/>\r
 109           <xs:element name="t10TMinutes" type="LegacyAutomaticCallbackT10TMinutes"/>\r
 110         </xs:sequence>\r
 111       </xs:extension>\r
 112     </xs:complexContent>\r
 113   </xs:complexType>    \r
 114     \r
 115   <xs:complexType name="SystemLegacyAutomaticCallbackModifyLineTypeRequest">\r
 116     <xs:annotation>\r
 117       <xs:documentation>\r
 118         Modifies the system's legacy automatic callback line type attributes.\r
 119         The response is either a SuccessResponse or an ErrorResponse.\r
 120       </xs:documentation>\r
 121     </xs:annotation>\r
 122     <xs:complexContent>\r
 123       <xs:extension base="core:OCIRequest">\r
 124         <xs:sequence>\r
 125           <xs:element name="lineType" type="LegacyAutomaticCallbackLineType"/>\r
 126           <xs:element name="matchAction" type="LegacyAutomaticCallbackLineMatchAction" minOccurs="0"/>\r
 127           <xs:element name="noMatchAction" type="LegacyAutomaticCallbackLineMatchAction" minOccurs="0"/>\r
 128         </xs:sequence>\r
 129       </xs:extension>\r
 130     </xs:complexContent>\r
 131   </xs:complexType>    \r
 132     \r
 133   <xs:complexType name="SystemLegacyAutomaticCallbackModifyRequest">\r
 134     <xs:annotation>\r
 135       <xs:documentation>\r
 136         Modifies the system's legacy automatic callback attributes.\r
 137         The response is either a SuccessResponse or an ErrorResponse.\r
 138       </xs:documentation>\r
 139     </xs:annotation>\r
 140     <xs:complexContent>\r
 141       <xs:extension base="core:OCIRequest">\r
 142         <xs:sequence>\r
 143           <xs:element name="maxMonitorsPerOriginator" type="LegacyAutomaticCallbackMaxMonitorsPerOriginator" minOccurs="0"/>\r
 144           <xs:element name="maxMonitorsPerTerminator" type="LegacyAutomaticCallbackMaxMonitorsPerTerminator" minOccurs="0"/>\r
 145           <xs:element name="t2Minutes" type="LegacyAutomaticCallbackT2Minutes" minOccurs="0"/>\r
 146           <xs:element name="t4Seconds" type="LegacyAutomaticCallbackT4Seconds" minOccurs="0"/>\r
 147           <xs:element name="t5Seconds" type="LegacyAutomaticCallbackT5Seconds" minOccurs="0"/>\r
 148           <xs:element name="t6Minutes" type="LegacyAutomaticCallbackT6Minutes" minOccurs="0"/>\r
 149           <xs:element name="t7Minutes" type="LegacyAutomaticCallbackT7Minutes" minOccurs="0"/>\r
 150           <xs:element name="t8Seconds" type="LegacyAutomaticCallbackT8Seconds" minOccurs="0"/>\r
 151           <xs:element name="tRingSeconds" type="LegacyAutomaticCallbackTRingSeconds" minOccurs="0"/>\r
 152           <xs:element name="t10OMinutes" type="LegacyAutomaticCallbackT10OMinutes" minOccurs="0"/>\r
 153           <xs:element name="t10TMinutes" type="LegacyAutomaticCallbackT10TMinutes" minOccurs="0"/>\r
 154         </xs:sequence>\r
 155       </xs:extension>\r
 156     </xs:complexContent>\r
 157   </xs:complexType>    \r
 158     \r
 159   <xs:complexType name="UserLegacyAutomaticCallbackGetRequest">\r
 160     <xs:annotation>\r
 161       <xs:documentation>\r
 162         Request the user level data associated with Legacy Automatic Callback.\r
 163         The response is either a UserLegacyAutomaticCallbackGetResponse or an\r
 164         ErrorResponse.\r
 165       </xs:documentation>\r
 166     </xs:annotation>\r
 167     <xs:complexContent>\r
 168       <xs:extension base="core:OCIRequest">\r
 169         <xs:sequence>\r
 170           <xs:element name="userId" type="UserId"/>\r
 171         </xs:sequence>\r
 172       </xs:extension>\r
 173     </xs:complexContent>\r
 174   </xs:complexType>    \r
 175     \r
 176   <xs:complexType name="UserLegacyAutomaticCallbackGetResponse">\r
 177     <xs:annotation>\r
 178       <xs:documentation>\r
 179         Response to UserLegacyAutomaticCallbackGetRequest.\r
 180       </xs:documentation>\r
 181     </xs:annotation>\r
 182     <xs:complexContent>\r
 183       <xs:extension base="core:OCIDataResponse">\r
 184         <xs:sequence>\r
 185           <xs:element name="isActive" type="xs:boolean"/>\r
 186         </xs:sequence>\r
 187       </xs:extension>\r
 188     </xs:complexContent>\r
 189   </xs:complexType>    \r
 190     \r
 191   <xs:complexType name="UserLegacyAutomaticCallbackModifyRequest">\r
 192     <xs:annotation>\r
 193       <xs:documentation>\r
 194         Modify the user level data associated with Legacy Automatic Callback.\r
 195         The response is either a SuccessResponse or an ErrorResponse.\r
 196       </xs:documentation>\r
 197     </xs:annotation>\r
 198     <xs:complexContent>\r
 199       <xs:extension base="core:OCIRequest">\r
 200         <xs:sequence>\r
 201           <xs:element name="userId" type="UserId"/>\r
 202           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 203         </xs:sequence>\r
 204       </xs:extension>\r
 205     </xs:complexContent>\r
 206   </xs:complexType>    \r
 207     \r
 208   <xs:simpleType name="LegacyAutomaticCallbackLineType">\r
 209     <xs:annotation>\r
 210       <xs:documentation>\r
 211         Legacy Automatic Callback line type.\r
 212       </xs:documentation>\r
 213     </xs:annotation>\r
 214     <xs:restriction base="xs:token">\r
 215       <xs:enumeration value="Individual"/>\r
 216       <xs:enumeration value="Coin"/>\r
 217       <xs:enumeration value="Series"/>\r
 218       <xs:enumeration value="Hunt"/>\r
 219       <xs:enumeration value="Unassigned"/>\r
 220       <xs:enumeration value="PBX"/>\r
 221       <xs:enumeration value="Multiparty"/>\r
 222       <xs:enumeration value="Choke"/>\r
 223       <xs:enumeration value="Oos"/>\r
 224       <xs:enumeration value="Nonspecific"/>\r
 225       <xs:enumeration value="Telecampus"/>\r
 226       <xs:enumeration value="ISDN"/>\r
 227       <xs:enumeration value="Telekibutz"/>\r
 228       <xs:enumeration value="Spare"/>\r
 229     </xs:restriction>\r
 230   </xs:simpleType>    \r
 231     \r
 232   <xs:simpleType name="LegacyAutomaticCallbackLineMatchAction">\r
 233     <xs:annotation>\r
 234       <xs:documentation>\r
 235         Legacy Automatic Callback line type match action.\r
 236       </xs:documentation>\r
 237     </xs:annotation>\r
 238     <xs:restriction base="xs:token">\r
 239       <xs:enumeration value="Accept"/>\r
 240       <xs:enumeration value="Deny"/>\r
 241     </xs:restriction>\r
 242   </xs:simpleType>    \r
 243     \r
 244   <xs:simpleType name="LegacyAutomaticCallbackMaxMonitorsPerOriginator">\r
 245     <xs:annotation>\r
 246       <xs:documentation>\r
 247         Maximum monitors per originator.\r
 248       </xs:documentation>\r
 249     </xs:annotation>\r
 250     <xs:restriction base="xs:int">\r
 251       <xs:minInclusive value="1"/>\r
 252       <xs:maxInclusive value="30"/>\r
 253     </xs:restriction>\r
 254   </xs:simpleType>    \r
 255     \r
 256   <xs:simpleType name="LegacyAutomaticCallbackMaxMonitorsPerTerminator">\r
 257     <xs:annotation>\r
 258       <xs:documentation>\r
 259         Maximum monitors per terminator.\r
 260       </xs:documentation>\r
 261     </xs:annotation>\r
 262     <xs:restriction base="xs:int">\r
 263       <xs:minInclusive value="1"/>\r
 264       <xs:maxInclusive value="30"/>\r
 265     </xs:restriction>\r
 266   </xs:simpleType>    \r
 267     \r
 268   <xs:simpleType name="LegacyAutomaticCallbackT10OMinutes">\r
 269     <xs:annotation>\r
 270       <xs:documentation>\r
 271         Legacy Automatic Callback T10_O timer in minutes.\r
 272       </xs:documentation>\r
 273     </xs:annotation>\r
 274     <xs:restriction base="xs:int">\r
 275       <xs:minInclusive value="1"/>\r
 276       <xs:maxInclusive value="120"/>\r
 277     </xs:restriction>\r
 278   </xs:simpleType>    \r
 279     \r
 280   <xs:simpleType name="LegacyAutomaticCallbackT10TMinutes">\r
 281     <xs:annotation>\r
 282       <xs:documentation>\r
 283         Legacy Automatic Callback T10_T timer in minutes.\r
 284       </xs:documentation>\r
 285     </xs:annotation>\r
 286     <xs:restriction base="xs:int">\r
 287       <xs:minInclusive value="1"/>\r
 288       <xs:maxInclusive value="120"/>\r
 289     </xs:restriction>\r
 290   </xs:simpleType>    \r
 291     \r
 292   <xs:simpleType name="LegacyAutomaticCallbackT2Minutes">\r
 293     <xs:annotation>\r
 294       <xs:documentation>\r
 295         Legacy Automatic Callback T2 timer in minutes.\r
 296       </xs:documentation>\r
 297     </xs:annotation>\r
 298     <xs:restriction base="xs:int">\r
 299       <xs:minInclusive value="1"/>\r
 300       <xs:maxInclusive value="20"/>\r
 301     </xs:restriction>\r
 302   </xs:simpleType>    \r
 303     \r
 304   <xs:simpleType name="LegacyAutomaticCallbackT4Seconds">\r
 305     <xs:annotation>\r
 306       <xs:documentation>\r
 307         Legacy Automatic Callback T4 timer in seconds.\r
 308       </xs:documentation>\r
 309     </xs:annotation>\r
 310     <xs:restriction base="xs:int">\r
 311       <xs:minInclusive value="0"/>\r
 312       <xs:maxInclusive value="15"/>\r
 313     </xs:restriction>\r
 314   </xs:simpleType>    \r
 315     \r
 316   <xs:simpleType name="LegacyAutomaticCallbackT5Seconds">\r
 317     <xs:annotation>\r
 318       <xs:documentation>\r
 319         Legacy Automatic Callback T5 timer in seconds.\r
 320       </xs:documentation>\r
 321     </xs:annotation>\r
 322     <xs:restriction base="xs:int">\r
 323       <xs:minInclusive value="2"/>\r
 324       <xs:maxInclusive value="10"/>\r
 325     </xs:restriction>\r
 326   </xs:simpleType>    \r
 327     \r
 328   <xs:simpleType name="LegacyAutomaticCallbackT6Minutes">\r
 329     <xs:annotation>\r
 330       <xs:documentation>\r
 331         Legacy Automatic Callback T6 timer in minutes.\r
 332       </xs:documentation>\r
 333     </xs:annotation>\r
 334     <xs:restriction base="xs:int">\r
 335       <xs:minInclusive value="1"/>\r
 336       <xs:maxInclusive value="60"/>\r
 337     </xs:restriction>\r
 338   </xs:simpleType>    \r
 339     \r
 340   <xs:simpleType name="LegacyAutomaticCallbackT7Minutes">\r
 341     <xs:annotation>\r
 342       <xs:documentation>\r
 343         Legacy Automatic Callback T7 timer in minutes.\r
 344       </xs:documentation>\r
 345     </xs:annotation>\r
 346     <xs:restriction base="xs:int">\r
 347       <xs:minInclusive value="5"/>\r
 348       <xs:maxInclusive value="180"/>\r
 349     </xs:restriction>\r
 350   </xs:simpleType>    \r
 351     \r
 352   <xs:simpleType name="LegacyAutomaticCallbackT8Seconds">\r
 353     <xs:annotation>\r
 354       <xs:documentation>\r
 355         Legacy Automatic Callback T8 timer in seconds.\r
 356       </xs:documentation>\r
 357     </xs:annotation>\r
 358     <xs:restriction base="xs:int">\r
 359       <xs:minInclusive value="0"/>\r
 360       <xs:maxInclusive value="120"/>\r
 361     </xs:restriction>\r
 362   </xs:simpleType>    \r
 363     \r
 364   <xs:simpleType name="LegacyAutomaticCallbackTRingSeconds">\r
 365     <xs:annotation>\r
 366       <xs:documentation>\r
 367         Legacy Automatic Callback TRing timer in seconds.\r
 368       </xs:documentation>\r
 369     </xs:annotation>\r
 370     <xs:restriction base="xs:int">\r
 371       <xs:minInclusive value="1"/>\r
 372       <xs:maxInclusive value="120"/>\r
 373     </xs:restriction>\r
 374   </xs:simpleType>    \r
 375     \r
 376 </xs:schema>\r