share/OCISchemaAS/Services/OCISchemaServiceGroupNightForwarding.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 <!-- G R O U P   N I G H T   F O R W A R D I N G  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   <!-- G R O U P   N I G H T   F O R W A R D I N G                                        -->\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     SystemGroupNightForwardingGetRequest    \r
  36     SystemGroupNightForwardingModifyRequest    \r
  37     GroupGroupNightForwardingGetRequest    \r
  38     GroupGroupNightForwardingModifyRequest    \r
  39     UserGroupNightForwardingGetRequest    \r
  40     UserGroupNightForwardingModifyRequest    \r
  41     \r
  42   --> \r
  43   \r
  44   <xs:complexType name="SystemGroupNightForwardingGetRequest">\r
  45     <xs:annotation>\r
  46       <xs:appinfo>\r
  47         <asDataModeSupported>true</asDataModeSupported>\r
  48         <hssDataModeSupported>false</hssDataModeSupported>\r
  49       </xs:appinfo>\r
  50       <xs:documentation>\r
  51         Request to get the Group Night Forwarding system parameters.\r
  52         The response is either SystemGroupNightForwardingGetResponse or ErrorResponse.\r
  53       </xs:documentation>\r
  54     </xs:annotation>\r
  55     <xs:complexContent>\r
  56       <xs:extension base="core:OCIRequest">\r
  57         <xs:sequence/>\r
  58       </xs:extension>\r
  59     </xs:complexContent>\r
  60   </xs:complexType>    \r
  61     \r
  62   <xs:complexType name="SystemGroupNightForwardingGetResponse">\r
  63     <xs:annotation>\r
  64       <xs:appinfo>\r
  65         <asDataModeSupported>true</asDataModeSupported>\r
  66         <hssDataModeSupported>false</hssDataModeSupported>\r
  67       </xs:appinfo>\r
  68       <xs:documentation>\r
  69         Response to SystemGroupNightForwardingGetRequest.\r
  70       </xs:documentation>\r
  71     </xs:annotation>\r
  72     <xs:complexContent>\r
  73       <xs:extension base="core:OCIDataResponse">\r
  74         <xs:sequence>\r
  75           <xs:element name="nightForwardInterGroupCallsWithinEnterprise" type="xs:boolean"/>\r
  76         </xs:sequence>\r
  77       </xs:extension>\r
  78     </xs:complexContent>\r
  79   </xs:complexType>    \r
  80     \r
  81   <xs:complexType name="SystemGroupNightForwardingModifyRequest">\r
  82     <xs:annotation>\r
  83       <xs:appinfo>\r
  84         <asDataModeSupported>true</asDataModeSupported>\r
  85         <hssDataModeSupported>false</hssDataModeSupported>\r
  86       </xs:appinfo>\r
  87       <xs:documentation>\r
  88         Request to modify the Group Night Forwarding system parameters.\r
  89         The response is either a SuccessResponse or an ErrorResponse.\r
  90       </xs:documentation>\r
  91     </xs:annotation>\r
  92     <xs:complexContent>\r
  93       <xs:extension base="core:OCIRequest">\r
  94         <xs:sequence>\r
  95           <xs:element name="nightForwardGroupCallsWithinEnterprise" type="xs:boolean" minOccurs="0"/>\r
  96         </xs:sequence>\r
  97       </xs:extension>\r
  98     </xs:complexContent>\r
  99   </xs:complexType>    \r
 100     \r
 101   <xs:complexType name="GroupGroupNightForwardingGetRequest">\r
 102     <xs:annotation>\r
 103       <xs:documentation>\r
 104         Request to get the Group Night Forwarding group parameters.\r
 105         The response is either GroupGroupNightForwardingGetResponse or ErrorResponse.\r
 106       </xs:documentation>\r
 107     </xs:annotation>\r
 108     <xs:complexContent>\r
 109       <xs:extension base="core:OCIRequest">\r
 110         <xs:sequence>\r
 111           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 112           <xs:element name="groupId" type="GroupId"/>\r
 113         </xs:sequence>\r
 114       </xs:extension>\r
 115     </xs:complexContent>\r
 116   </xs:complexType>    \r
 117     \r
 118   <xs:complexType name="GroupGroupNightForwardingGetResponse">\r
 119     <xs:annotation>\r
 120       <xs:documentation>\r
 121         Response to GroupGroupNightForwardingGetRequest.\r
 122       </xs:documentation>\r
 123     </xs:annotation>\r
 124     <xs:complexContent>\r
 125       <xs:extension base="core:OCIDataResponse">\r
 126         <xs:sequence>\r
 127           <xs:element name="nightForwarding" type="GroupNightForwardingGroupServiceActivationMode"/>\r
 128           <xs:element name="businessHours" type="TimeSchedule" minOccurs="0"/>\r
 129           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 130           <xs:element name="forwardToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>\r
 131         </xs:sequence>\r
 132       </xs:extension>\r
 133     </xs:complexContent>\r
 134   </xs:complexType>    \r
 135     \r
 136   <xs:complexType name="GroupGroupNightForwardingModifyRequest">\r
 137     <xs:annotation>\r
 138       <xs:documentation>\r
 139         Request to modify the Group Night Forwarding group parameters.\r
 140         The response is either SuccessResponse or ErrorResponse.\r
 141       </xs:documentation>\r
 142     </xs:annotation>\r
 143     <xs:complexContent>\r
 144       <xs:extension base="core:OCIRequest">\r
 145         <xs:sequence>\r
 146           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 147           <xs:element name="groupId" type="GroupId"/>\r
 148           <xs:element name="nightForwarding" type="GroupNightForwardingGroupServiceActivationMode" minOccurs="0"/>\r
 149           <xs:element name="businessHours" type="TimeSchedule" minOccurs="0" nillable="true"/>\r
 150           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0" nillable="true"/>\r
 151           <xs:element name="forwardToPhoneNumber" type="OutgoingDNorSIPURI" minOccurs="0" nillable="true"/>\r
 152         </xs:sequence>\r
 153       </xs:extension>\r
 154     </xs:complexContent>\r
 155   </xs:complexType>    \r
 156     \r
 157   <xs:complexType name="UserGroupNightForwardingGetRequest">\r
 158     <xs:annotation>\r
 159       <xs:documentation>\r
 160         Request to get the Group Night Forwarding user parameters.\r
 161         The response is either UserGroupNightForwardingGetResponse or ErrorResponse.\r
 162       </xs:documentation>\r
 163     </xs:annotation>\r
 164     <xs:complexContent>\r
 165       <xs:extension base="core:OCIRequest">\r
 166         <xs:sequence>\r
 167           <xs:element name="userId" type="UserId"/>\r
 168         </xs:sequence>\r
 169       </xs:extension>\r
 170     </xs:complexContent>\r
 171   </xs:complexType>    \r
 172     \r
 173   <xs:complexType name="UserGroupNightForwardingGetResponse">\r
 174     <xs:annotation>\r
 175       <xs:documentation>\r
 176         Response to UserGroupNightForwardingGetRequest.\r
 177         businessHours and holidaySchedule are returned in the response only when groupNightForwarding is ‘Auto On’.\r
 178       </xs:documentation>\r
 179     </xs:annotation>\r
 180     <xs:complexContent>\r
 181       <xs:extension base="core:OCIDataResponse">\r
 182         <xs:sequence>\r
 183           <xs:element name="nightForwarding" type="GroupNightForwardingUserServiceActivationMode"/>\r
 184           <xs:element name="groupNightForwarding" type="GroupNightForwardingGroupServiceActivationMode"/>\r
 185           <xs:element name="businessHours" type="TimeSchedule" minOccurs="0"/>\r
 186           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
 187         </xs:sequence>\r
 188       </xs:extension>\r
 189     </xs:complexContent>\r
 190   </xs:complexType>    \r
 191     \r
 192   <xs:complexType name="UserGroupNightForwardingModifyRequest">\r
 193     <xs:annotation>\r
 194       <xs:documentation>\r
 195         Request to modify the Group Night Forwarding user parameters.\r
 196         The response is either SuccessResponse or ErrorResponse.\r
 197       </xs:documentation>\r
 198     </xs:annotation>\r
 199     <xs:complexContent>\r
 200       <xs:extension base="core:OCIRequest">\r
 201         <xs:sequence>\r
 202           <xs:element name="userId" type="UserId"/>\r
 203           <xs:element name="nightForwarding" type="GroupNightForwardingUserServiceActivationMode" minOccurs="0"/>\r
 204         </xs:sequence>\r
 205       </xs:extension>\r
 206     </xs:complexContent>\r
 207   </xs:complexType>    \r
 208     \r
 209   <xs:simpleType name="GroupNightForwardingGroupServiceActivationMode">\r
 210     <xs:annotation>\r
 211       <xs:documentation>\r
 212         Choices for the Group Night Forwarding Service Activation for a group.\r
 213       </xs:documentation>\r
 214     </xs:annotation>\r
 215     <xs:restriction base="xs:token">\r
 216       <xs:enumeration value="Auto On"/>\r
 217       <xs:enumeration value="On"/>\r
 218       <xs:enumeration value="Off"/>\r
 219     </xs:restriction>\r
 220   </xs:simpleType>    \r
 221     \r
 222   <xs:simpleType name="GroupNightForwardingUserServiceActivationMode">\r
 223     <xs:annotation>\r
 224       <xs:documentation>\r
 225         Choices for the Group Night Forwarding Service Activation for a user.\r
 226       </xs:documentation>\r
 227     </xs:annotation>\r
 228     <xs:restriction base="xs:token">\r
 229       <xs:enumeration value="Use Group"/>\r
 230       <xs:enumeration value="On"/>\r
 231       <xs:enumeration value="Off"/>\r
 232     </xs:restriction>\r
 233   </xs:simpleType>    \r
 234     \r
 235 </xs:schema>\r