share/OCISchemaAS/Services/OCISchemaServiceAutomaticCallback.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 <!-- 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   <!-- A U T O M A T I C   C A L L B A C K    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     SystemAutomaticCallbackGetRequest17    \r
  35     SystemAutomaticCallbackModifyRequest15    \r
  36     SystemAutomaticCallbackGetReleaseCauseListRequest    \r
  37     SystemAutomaticCallbackAddReleaseCauseListRequest    \r
  38     SystemAutomaticCallbackDeleteReleaseCauseListRequest    \r
  39     UserAutomaticCallbackGetRequest    \r
  40     UserAutomaticCallbackModifyRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="SystemAutomaticCallbackGetRequest17">\r
  45     <xs:annotation>\r
  46       <xs:documentation>\r
  47         Request the system's automatic callback attributes.\r
  48         The response is either a SystemAutomaticCallbackGetResponse17 or an ErrorResponse.\r
  49       </xs:documentation>\r
  50     </xs:annotation>\r
  51     <xs:complexContent>\r
  52       <xs:extension base="core:OCIRequest">\r
  53         <xs:sequence/>\r
  54       </xs:extension>\r
  55     </xs:complexContent>\r
  56   </xs:complexType>    \r
  57     \r
  58   <xs:complexType name="SystemAutomaticCallbackGetResponse17">\r
  59     <xs:annotation>\r
  60       <xs:documentation>\r
  61         Response to SystemAutomaticCallbackGetRequest17.\r
  62       </xs:documentation>\r
  63     </xs:annotation>\r
  64     <xs:complexContent>\r
  65       <xs:extension base="core:OCIDataResponse">\r
  66         <xs:sequence>\r
  67           <xs:element name="monitorMinutes" type="AutomaticCallbackMonitorMinutes"/>\r
  68           <xs:element name="maxMonitorsPerOriginator" type="AutomaticCallbackMaxMonitorsPerOriginator"/>\r
  69           <xs:element name="maxCallbackRings" type="AutomaticCallbackMaxCallbackRings"/>\r
  70           <xs:element name="maxMonitorsPerTerminator" type="AutomaticCallbackMaxMonitorsPerTerminator"/>\r
  71           <xs:element name="terminatorIdleGuardSeconds" type="AutomaticCallbackTerminatorIdleGuardSeconds"/>\r
  72           <xs:element name="callbackMethod" type="AutomaticCallbackMethod"/>\r
  73           <xs:element name="pollingIntervalSeconds" type="AutomaticCallbackPollingIntervalSeconds"/>\r
  74           <xs:element name="activationDigit" type="AutomaticCallbackActivationDigit"/>\r
  75         </xs:sequence>\r
  76       </xs:extension>\r
  77     </xs:complexContent>\r
  78   </xs:complexType>    \r
  79     \r
  80   <xs:complexType name="SystemAutomaticCallbackModifyRequest15">\r
  81     <xs:annotation>\r
  82       <xs:documentation>\r
  83         Modifies the system's automatic callback attributes.\r
  84         The response is either a SuccessResponse or an ErrorResponse.\r
  85       </xs:documentation>\r
  86     </xs:annotation>\r
  87     <xs:complexContent>\r
  88       <xs:extension base="core:OCIRequest">\r
  89         <xs:sequence>\r
  90           <xs:element name="monitorMinutes" type="AutomaticCallbackMonitorMinutes" minOccurs="0"/>\r
  91           <xs:element name="maxMonitorsPerOriginator" type="AutomaticCallbackMaxMonitorsPerOriginator" minOccurs="0"/>\r
  92           <xs:element name="maxCallbackRings" type="AutomaticCallbackMaxCallbackRings" minOccurs="0"/>\r
  93           <xs:element name="maxMonitorsPerTerminator" type="AutomaticCallbackMaxMonitorsPerTerminator" minOccurs="0"/>\r
  94           <xs:element name="terminatorIdleGuardSeconds" type="AutomaticCallbackTerminatorIdleGuardSeconds" minOccurs="0"/>\r
  95           <xs:element name="callbackMethod" type="AutomaticCallbackMethod" minOccurs="0"/>\r
  96           <xs:element name="pollingIntervalSeconds" type="AutomaticCallbackPollingIntervalSeconds" minOccurs="0"/>\r
  97           <xs:element name="activationDigit" type="AutomaticCallbackActivationDigit" minOccurs="0"/>\r
  98         </xs:sequence>\r
  99       </xs:extension>\r
 100     </xs:complexContent>\r
 101   </xs:complexType>    \r
 102     \r
 103   <xs:complexType name="SystemAutomaticCallbackGetReleaseCauseListRequest">\r
 104     <xs:annotation>\r
 105       <xs:documentation>\r
 106         Request the system's automatic callback attributes.\r
 107         The response is either a SystemAutomaticCallbackGetReleaseCauseListResponse or an ErrorResponse.\r
 108       </xs:documentation>\r
 109     </xs:annotation>\r
 110     <xs:complexContent>\r
 111       <xs:extension base="core:OCIRequest">\r
 112         <xs:sequence/>\r
 113       </xs:extension>\r
 114     </xs:complexContent>\r
 115   </xs:complexType>    \r
 116     \r
 117   <xs:complexType name="SystemAutomaticCallbackGetReleaseCauseListResponse">\r
 118     <xs:annotation>\r
 119       <xs:documentation>\r
 120         Response to SystemAutomaticCallbackGetReleaseCauseListRequest.\r
 121       </xs:documentation>\r
 122     </xs:annotation>\r
 123     <xs:complexContent>\r
 124       <xs:extension base="core:OCIDataResponse">\r
 125         <xs:sequence>\r
 126           <xs:element name="releaseCause" type="AutomaticCallbackReleaseCause" minOccurs="0" maxOccurs="unbounded"/>\r
 127         </xs:sequence>\r
 128       </xs:extension>\r
 129     </xs:complexContent>\r
 130   </xs:complexType>    \r
 131     \r
 132   <xs:complexType name="SystemAutomaticCallbackAddReleaseCauseListRequest">\r
 133     <xs:annotation>\r
 134       <xs:documentation>\r
 135         Adds automatic callback release cause to the releaseCause attribute.\r
 136         The response is either a SuccessResponse or an ErrorResponse.\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:complexContent>\r
 140       <xs:extension base="core:OCIRequest">\r
 141         <xs:sequence>\r
 142           <xs:element name="releaseCause" type="AutomaticCallbackReleaseCause" minOccurs="0" maxOccurs="unbounded"/>\r
 143         </xs:sequence>\r
 144       </xs:extension>\r
 145     </xs:complexContent>\r
 146   </xs:complexType>    \r
 147     \r
 148   <xs:complexType name="SystemAutomaticCallbackDeleteReleaseCauseListRequest">\r
 149     <xs:annotation>\r
 150       <xs:documentation>\r
 151         Deletes automatic callback release causes from the release cause attribute.\r
 152         The response is either a SuccessResponse or an ErrorResponse.\r
 153       </xs:documentation>\r
 154     </xs:annotation>\r
 155     <xs:complexContent>\r
 156       <xs:extension base="core:OCIRequest">\r
 157         <xs:sequence>\r
 158           <xs:element name="releaseCause" type="AutomaticCallbackReleaseCause" minOccurs="0" maxOccurs="unbounded"/>\r
 159         </xs:sequence>\r
 160       </xs:extension>\r
 161     </xs:complexContent>\r
 162   </xs:complexType>    \r
 163     \r
 164   <xs:complexType name="UserAutomaticCallbackGetRequest">\r
 165     <xs:annotation>\r
 166       <xs:documentation>\r
 167         Request the user level data associated with Automatic Callback.\r
 168         The response is either a UserAutomaticCallbackGetResponse or an\r
 169         ErrorResponse.\r
 170       </xs:documentation>\r
 171     </xs:annotation>\r
 172     <xs:complexContent>\r
 173       <xs:extension base="core:OCIRequest">\r
 174         <xs:sequence>\r
 175           <xs:element name="userId" type="UserId"/>\r
 176         </xs:sequence>\r
 177       </xs:extension>\r
 178     </xs:complexContent>\r
 179   </xs:complexType>    \r
 180     \r
 181   <xs:complexType name="UserAutomaticCallbackGetResponse">\r
 182     <xs:annotation>\r
 183       <xs:documentation>\r
 184         Response to UserAutomaticCallbackGetRequest.\r
 185       </xs:documentation>\r
 186     </xs:annotation>\r
 187     <xs:complexContent>\r
 188       <xs:extension base="core:OCIDataResponse">\r
 189         <xs:sequence>\r
 190           <xs:element name="isActive" type="xs:boolean"/>\r
 191         </xs:sequence>\r
 192       </xs:extension>\r
 193     </xs:complexContent>\r
 194   </xs:complexType>    \r
 195     \r
 196   <xs:complexType name="UserAutomaticCallbackModifyRequest">\r
 197     <xs:annotation>\r
 198       <xs:documentation>\r
 199         Modify the user level data associated with Automatic Callback.\r
 200         The response is either a SuccessResponse or an ErrorResponse.\r
 201       </xs:documentation>\r
 202     </xs:annotation>\r
 203     <xs:complexContent>\r
 204       <xs:extension base="core:OCIRequest">\r
 205         <xs:sequence>\r
 206           <xs:element name="userId" type="UserId"/>\r
 207           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 208         </xs:sequence>\r
 209       </xs:extension>\r
 210     </xs:complexContent>\r
 211   </xs:complexType>    \r
 212     \r
 213   <xs:simpleType name="AutomaticCallbackMethod">\r
 214     <xs:annotation>\r
 215       <xs:documentation>\r
 216         Automatic Callback methods.\r
 217       </xs:documentation>\r
 218     </xs:annotation>\r
 219     <xs:restriction base="xs:token">\r
 220       <xs:enumeration value="Notify Only"/>\r
 221       <xs:enumeration value="Notify If Possible And Polling Otherwise"/>\r
 222     </xs:restriction>\r
 223   </xs:simpleType>    \r
 224     \r
 225   <xs:simpleType name="AutomaticCallbackMaxCallbackRings">\r
 226     <xs:annotation>\r
 227       <xs:documentation>\r
 228         Maximum callback rings.\r
 229       </xs:documentation>\r
 230     </xs:annotation>\r
 231     <xs:restriction base="xs:int">\r
 232       <xs:minInclusive value="3"/>\r
 233       <xs:maxInclusive value="8"/>\r
 234     </xs:restriction>\r
 235   </xs:simpleType>    \r
 236     \r
 237   <xs:simpleType name="AutomaticCallbackMaxMonitorsPerOriginator">\r
 238     <xs:annotation>\r
 239       <xs:documentation>\r
 240         Maximum monitors per originator.\r
 241       </xs:documentation>\r
 242     </xs:annotation>\r
 243     <xs:restriction base="xs:int">\r
 244       <xs:minInclusive value="1"/>\r
 245       <xs:maxInclusive value="30"/>\r
 246     </xs:restriction>\r
 247   </xs:simpleType>    \r
 248     \r
 249   <xs:simpleType name="AutomaticCallbackMaxMonitorsPerTerminator">\r
 250     <xs:annotation>\r
 251       <xs:documentation>\r
 252         Maximum monitors per terminator.\r
 253       </xs:documentation>\r
 254     </xs:annotation>\r
 255     <xs:restriction base="xs:int">\r
 256       <xs:minInclusive value="1"/>\r
 257       <xs:maxInclusive value="30"/>\r
 258     </xs:restriction>\r
 259   </xs:simpleType>    \r
 260     \r
 261   <xs:simpleType name="AutomaticCallbackMonitorMinutes">\r
 262     <xs:annotation>\r
 263       <xs:documentation>\r
 264         Automatic Callback monitor minutes.\r
 265       </xs:documentation>\r
 266     </xs:annotation>\r
 267     <xs:restriction base="xs:int">\r
 268       <xs:minInclusive value="5"/>\r
 269       <xs:maxInclusive value="180"/>\r
 270     </xs:restriction>\r
 271   </xs:simpleType>    \r
 272     \r
 273   <xs:simpleType name="AutomaticCallbackPollingIntervalSeconds">\r
 274     <xs:annotation>\r
 275       <xs:documentation>\r
 276         Polling interval seconds.\r
 277       </xs:documentation>\r
 278     </xs:annotation>\r
 279     <xs:restriction base="xs:int">\r
 280       <xs:minInclusive value="60"/>\r
 281       <xs:maxInclusive value="900"/>\r
 282     </xs:restriction>\r
 283   </xs:simpleType>    \r
 284     \r
 285   <xs:simpleType name="AutomaticCallbackTerminatorIdleGuardSeconds">\r
 286     <xs:annotation>\r
 287       <xs:documentation>\r
 288         Idle guard timer seconds.\r
 289       </xs:documentation>\r
 290     </xs:annotation>\r
 291     <xs:restriction base="xs:int">\r
 292       <xs:minInclusive value="5"/>\r
 293       <xs:maxInclusive value="300"/>\r
 294     </xs:restriction>\r
 295   </xs:simpleType>    \r
 296     \r
 297   <xs:simpleType name="AutomaticCallbackActivationDigit">\r
 298     <xs:annotation>\r
 299       <xs:documentation>\r
 300         Callback Activation Digit.\r
 301       </xs:documentation>\r
 302     </xs:annotation>\r
 303     <xs:restriction base="xs:int">\r
 304       <xs:minInclusive value="0"/>\r
 305       <xs:maxInclusive value="9"/>\r
 306     </xs:restriction>\r
 307   </xs:simpleType>    \r
 308     \r
 309   <xs:simpleType name="AutomaticCallbackReleaseCause">\r
 310     <xs:annotation>\r
 311       <xs:documentation>\r
 312         Callback Release Cause.\r
 313       </xs:documentation>\r
 314     </xs:annotation>\r
 315     <xs:restriction base="xs:token">\r
 316       <xs:enumeration value="Busy"/>\r
 317       <xs:enumeration value="Forbidden"/>\r
 318       <xs:enumeration value="Global Failure"/>\r
 319       <xs:enumeration value="Request Failure"/>\r
 320       <xs:enumeration value="Server Failure"/>\r
 321       <xs:enumeration value="Translation Failure"/>\r
 322       <xs:enumeration value="Temporarily Unavailable"/>\r
 323       <xs:enumeration value="User Not Found"/>\r
 324       <xs:enumeration value="Request Timeout"/>\r
 325     </xs:restriction>\r
 326   </xs:simpleType>    \r
 327     \r
 328 </xs:schema>\r