share/OCISchemaAS/Services/OCISchemaServiceCommunicationBarringUserControl.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 <!-- C O M M U N I C A T I O N   B A R R I N G   U S E R                    -->\r
   9 <!-- C O N T R O L  S E R V I C E                                           -->\r
  10 <!--                                                                        -->\r
  11 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
  12 <!-- Open Client Interface (OCI).                                           -->\r
  13 <!-- ********************************************************************** -->\r
  14 \r
  15 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
  16            xmlns:core           = "C"\r
  17            xmlns                = ""\r
  18            attributeFormDefault = "qualified"\r
  19            elementFormDefault   = "qualified">\r
  20   \r
  21   <xs:import namespace      = "C"\r
  22              schemaLocation = "../OCISchemaBASE.xsd"/>\r
  23   \r
  24   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- C O M M U N I C A T I O N   B A R R I N G   U S E R   C O N T R O L                -->\r
  28   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
  29   <!-- ********************************************************************************** -->\r
  30   <!--\r
  31   Requests and responses are listed here in alphabetical order.\r
  32   The non-primitive attributes inside the commands are defined in another\r
  33   section of the schema.\r
  34 \r
  35   Requests in this schema file:\r
  36     SystemCommunicationBarringUserControlGetRequest    \r
  37     SystemCommunicationBarringUserControlModifyRequest    \r
  38     UserCommunicationBarringUserControlGetRequest    \r
  39     UserCommunicationBarringUserControlModifyRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="SystemCommunicationBarringUserControlGetRequest">\r
  44     <xs:annotation>\r
  45       <xs:documentation>\r
  46         Gets the Communication Barring system level settings.\r
  47         The response is either SystemCommunicationBarringUserControlGetResponse or ErrorResponse.\r
  48       </xs:documentation>\r
  49     </xs:annotation>\r
  50     <xs:complexContent>\r
  51       <xs:extension base="core:OCIRequest">\r
  52         <xs:sequence/>\r
  53       </xs:extension>\r
  54     </xs:complexContent>\r
  55   </xs:complexType>    \r
  56     \r
  57   <xs:complexType name="SystemCommunicationBarringUserControlGetResponse">\r
  58     <xs:annotation>\r
  59       <xs:documentation>\r
  60         Response to the SystemCommunicationBarringUserControlGetRequest.\r
  61         Contains the settings to whole system for Communication Barring User-Control\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="enableLockout" type="xs:boolean"/>\r
  68           <xs:element name="maxNumberOfFailedAttempts" type="CommunicationBarringUserControlNumberOfAttempts"/>\r
  69           <xs:element name="lockoutMinutes" type="CommunicationBarringUserControlLockoutMinutes"/>\r
  70         </xs:sequence>\r
  71       </xs:extension>\r
  72     </xs:complexContent>\r
  73   </xs:complexType>    \r
  74     \r
  75   <xs:complexType name="SystemCommunicationBarringUserControlModifyRequest">\r
  76     <xs:annotation>\r
  77       <xs:documentation>\r
  78         Modifies the system's Communication Barring User-Control settings.\r
  79         The response is either SuccessResponse or ErrorResponse.\r
  80       </xs:documentation>\r
  81     </xs:annotation>\r
  82     <xs:complexContent>\r
  83       <xs:extension base="core:OCIRequest">\r
  84         <xs:sequence>\r
  85           <xs:element name="enableLockout" type="xs:boolean" minOccurs="0"/>\r
  86           <xs:element name="maxNumberOfFailedAttempts" type="CommunicationBarringUserControlNumberOfAttempts" minOccurs="0"/>\r
  87           <xs:element name="lockoutMinutes" type="CommunicationBarringUserControlLockoutMinutes" minOccurs="0"/>\r
  88         </xs:sequence>\r
  89       </xs:extension>\r
  90     </xs:complexContent>\r
  91   </xs:complexType>    \r
  92     \r
  93   <xs:complexType name="UserCommunicationBarringUserControlGetRequest">\r
  94     <xs:annotation>\r
  95       <xs:documentation>\r
  96         Lists the Communication Barring profiles available to a user and\r
  97         indicates which profile if any is currently active for the user..\r
  98         The response is either UserCommunicationBarringUserControlGetResponse or ErrorResponse.\r
  99       </xs:documentation>\r
 100     </xs:annotation>\r
 101     <xs:complexContent>\r
 102       <xs:extension base="core:OCIRequest">\r
 103         <xs:sequence>\r
 104           <xs:element name="userId" type="UserId"/>\r
 105         </xs:sequence>\r
 106       </xs:extension>\r
 107     </xs:complexContent>\r
 108   </xs:complexType>    \r
 109     \r
 110   <xs:complexType name="UserCommunicationBarringUserControlGetResponse">\r
 111     <xs:annotation>\r
 112       <xs:documentation>\r
 113         Response to the UserCommunicationBarringUserControlGetRequest.\r
 114         Identifies the profiles available to the user and which one if any\r
 115         is active as well as the lockout status.\r
 116         Contains a table with column headings: "Name", "Code", "Activated" and "Primary".\r
 117       </xs:documentation>\r
 118     </xs:annotation>\r
 119     <xs:complexContent>\r
 120       <xs:extension base="core:OCIDataResponse">\r
 121         <xs:sequence>\r
 122           <xs:element name="lockoutStatus" type="xs:boolean"/>\r
 123           <xs:element name="profileTable" type="core:OCITable"/>\r
 124         </xs:sequence>\r
 125       </xs:extension>\r
 126     </xs:complexContent>\r
 127   </xs:complexType>    \r
 128     \r
 129   <xs:complexType name="UserCommunicationBarringUserControlModifyRequest">\r
 130     <xs:annotation>\r
 131       <xs:documentation>\r
 132         Enabling a profile automatically disables the currently active profile.\r
 133         Also allows the passcode for the service to be modified and the lockout to be reset.\r
 134         Admins only need to populate the newPasscode field when changing the passcode.  \r
 135         Users must populate both the oldPasscode and new Passcode fields when changing the passcode.\r
 136         The response is either SuccessResponse or 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="userId" type="UserId"/>\r
 143           <xs:element name="enableProfile" type="CommunicationBarringUserControlProfileCode" nillable="true" minOccurs="0"/>\r
 144           <xs:element name="oldPasscode" type="Passcode" minOccurs="0"/>\r
 145           <xs:element name="newPasscode" type="Passcode" minOccurs="0"/>\r
 146           <xs:element name="resetLockout" type="xs:boolean" fixed="true" minOccurs="0"/>\r
 147         </xs:sequence>\r
 148       </xs:extension>\r
 149     </xs:complexContent>\r
 150   </xs:complexType>    \r
 151     \r
 152   <xs:simpleType name="CommunicationBarringUserControlLockoutMinutes">\r
 153     <xs:annotation>\r
 154       <xs:documentation>Communication Barring User-Control lockout time in minutes.</xs:documentation>\r
 155     </xs:annotation>\r
 156     <xs:restriction base="xs:int">\r
 157       <xs:minInclusive value="1"/>\r
 158       <xs:maxInclusive value="600"/>\r
 159     </xs:restriction>\r
 160   </xs:simpleType>    \r
 161     \r
 162   <xs:simpleType name="CommunicationBarringUserControlNumberOfAttempts">\r
 163     <xs:annotation>\r
 164       <xs:documentation>Communication Barring User-Control number of attempts to get pin code correct.</xs:documentation>\r
 165     </xs:annotation>\r
 166     <xs:restriction base="xs:int">\r
 167       <xs:minInclusive value="1"/>\r
 168       <xs:maxInclusive value="10"/>\r
 169     </xs:restriction>\r
 170   </xs:simpleType>    \r
 171     \r
 172   <xs:simpleType name="CommunicationBarringUserControlProfileCode">\r
 173     <xs:annotation>\r
 174       <xs:documentation>Communication Barring Profile code identifying a profile within a Network Class of Service.</xs:documentation>\r
 175     </xs:annotation>\r
 176     <xs:restriction base="xs:int">\r
 177       <xs:minInclusive value="0"/>\r
 178       <xs:maxInclusive value="9"/>\r
 179     </xs:restriction>\r
 180   </xs:simpleType>    \r
 181     \r
 182 </xs:schema>\r