share/OCISchemaAS/Services/OCISchemaServiceEmergencyZones.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 <!-- E M E R G E N C Y   Z O N E S  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   <!-- E M E R G E N C Y   Z O N E S    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     GroupEmergencyZonesAddHomeZoneListRequest    \r
  35     GroupEmergencyZonesDeleteHomeZoneListRequest    \r
  36     GroupEmergencyZonesGetHomeZoneListRequest    \r
  37     GroupEmergencyZonesGetRequest    \r
  38     GroupEmergencyZonesModifyHomeZoneListRequest    \r
  39     GroupEmergencyZonesModifyRequest    \r
  40     SystemEmergencyZonesGetRequest    \r
  41     SystemEmergencyZonesModifyRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="GroupEmergencyZonesAddHomeZoneListRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Add a list of home zones and/or home zone ranges to the group.\r
  49         The response is either a SuccessResponse or 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:element name="serviceProviderId" type="ServiceProviderId"/>\r
  56           <xs:element name="groupId" type="GroupId"/>\r
  57           <xs:element name="homeZoneIpAddress" type="IPAddress" minOccurs="0" maxOccurs="unbounded"/>\r
  58           <xs:element name="homeZoneIpAddressRange" type="IPAddressRange" minOccurs="0" maxOccurs="unbounded"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="GroupEmergencyZonesDeleteHomeZoneListRequest">\r
  65     <xs:annotation>\r
  66       <xs:documentation>\r
  67         Delete a list of home zones and/or home zone ranges to the group.\r
  68         The response is either a SuccessResponse or an ErrorResponse.\r
  69       </xs:documentation>\r
  70     </xs:annotation>\r
  71     <xs:complexContent>\r
  72       <xs:extension base="core:OCIRequest">\r
  73         <xs:sequence>\r
  74           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  75           <xs:element name="groupId" type="GroupId"/>\r
  76           <xs:element name="homeZoneIpAddress" type="IPAddress" minOccurs="0" maxOccurs="unbounded"/>\r
  77           <xs:element name="homeZoneIpAddressRange" type="IPAddressRange" minOccurs="0" maxOccurs="unbounded"/>\r
  78         </xs:sequence>\r
  79       </xs:extension>\r
  80     </xs:complexContent>\r
  81   </xs:complexType>    \r
  82     \r
  83   <xs:complexType name="GroupEmergencyZonesGetHomeZoneListRequest">\r
  84     <xs:annotation>\r
  85       <xs:documentation>\r
  86         Request the group level data associated with Emergency Zones.\r
  87         The response is either a GroupEmergencyZonesGetResponse or an ErrorResponse.\r
  88       </xs:documentation>\r
  89     </xs:annotation>\r
  90     <xs:complexContent>\r
  91       <xs:extension base="core:OCIRequest">\r
  92         <xs:sequence>\r
  93           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
  94           <xs:element name="groupId" type="GroupId"/>\r
  95         </xs:sequence>\r
  96       </xs:extension>\r
  97     </xs:complexContent>\r
  98   </xs:complexType>    \r
  99     \r
 100   <xs:complexType name="GroupEmergencyZonesGetHomeZoneListResponse">\r
 101     <xs:annotation>\r
 102       <xs:documentation>\r
 103         Response to GroupEmergencyZonesGetHomeZoneListRequest.\r
 104       </xs:documentation>\r
 105     </xs:annotation>\r
 106     <xs:complexContent>\r
 107       <xs:extension base="core:OCIDataResponse">\r
 108         <xs:sequence>\r
 109           <xs:element name="homeZoneIpAddress" type="IPAddress" minOccurs="0" maxOccurs="unbounded"/>\r
 110           <xs:element name="homeZoneIpAddressRange" type="IPAddressRange" minOccurs="0" maxOccurs="unbounded"/>\r
 111         </xs:sequence>\r
 112       </xs:extension>\r
 113     </xs:complexContent>\r
 114   </xs:complexType>    \r
 115     \r
 116   <xs:complexType name="GroupEmergencyZonesGetRequest">\r
 117     <xs:annotation>\r
 118       <xs:documentation>\r
 119         Request the group level data associated with Emergency Zones.\r
 120         The response is either a GroupEmergencyZonesGetResponse or an ErrorResponse.\r
 121       </xs:documentation>\r
 122     </xs:annotation>\r
 123     <xs:complexContent>\r
 124       <xs:extension base="core:OCIRequest">\r
 125         <xs:sequence>\r
 126           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 127           <xs:element name="groupId" type="GroupId"/>\r
 128         </xs:sequence>\r
 129       </xs:extension>\r
 130     </xs:complexContent>\r
 131   </xs:complexType>    \r
 132     \r
 133   <xs:complexType name="GroupEmergencyZonesGetResponse">\r
 134     <xs:annotation>\r
 135       <xs:documentation>\r
 136         Response to GroupEmergencyZonesGetRequest.\r
 137       </xs:documentation>\r
 138     </xs:annotation>\r
 139     <xs:complexContent>\r
 140       <xs:extension base="core:OCIDataResponse">\r
 141         <xs:sequence>\r
 142           <xs:element name="isActive" type="xs:boolean"/>\r
 143           <xs:element name="emergencyZonesProhibition" type="EmergencyZonesProhibition"/>\r
 144           <xs:element name="sendEmergencyCallNotifyEmail" type="xs:boolean"/>\r
 145           <xs:element name="emergencyCallNotifyEmailAddress" type="EmailAddress" minOccurs="0"/>\r
 146         </xs:sequence>\r
 147       </xs:extension>\r
 148     </xs:complexContent>\r
 149   </xs:complexType>    \r
 150     \r
 151   <xs:complexType name="GroupEmergencyZonesModifyHomeZoneListRequest">\r
 152     <xs:annotation>\r
 153       <xs:documentation>\r
 154         Modify a list of home zones and/or home zone ranges.\r
 155         The response is either a SuccessResponse or an ErrorResponse.\r
 156       </xs:documentation>\r
 157     </xs:annotation>\r
 158     <xs:complexContent>\r
 159       <xs:extension base="core:OCIRequest">\r
 160         <xs:sequence>\r
 161           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 162           <xs:element name="groupId" type="GroupId"/>\r
 163           <xs:element name="homeZoneIpAddressList" minOccurs="0" maxOccurs="unbounded">\r
 164             <xs:complexType>\r
 165               <xs:annotation/>\r
 166               <xs:sequence>\r
 167                 <xs:element name="homeZoneIpAddress" type="IPAddress"/>\r
 168                 <xs:element name="newHomeZoneIpAddress" type="IPAddress"/>\r
 169               </xs:sequence>\r
 170             </xs:complexType>\r
 171           </xs:element>\r
 172           <xs:element name="homeZoneIpAddressRangeList" minOccurs="0" maxOccurs="unbounded">\r
 173             <xs:complexType>\r
 174               <xs:annotation/>\r
 175               <xs:sequence>\r
 176                 <xs:element name="homeZoneIpAddressRange" type="IPAddressRange"/>\r
 177                 <xs:element name="newHomeZoneIpAddressRange" type="IPAddressRange"/>\r
 178               </xs:sequence>\r
 179             </xs:complexType>\r
 180           </xs:element>\r
 181         </xs:sequence>\r
 182       </xs:extension>\r
 183     </xs:complexContent>\r
 184   </xs:complexType>    \r
 185     \r
 186   <xs:complexType name="GroupEmergencyZonesModifyRequest">\r
 187     <xs:annotation>\r
 188       <xs:documentation>\r
 189         Modify the group level data associated with Emergency Zones.\r
 190         The response is either a SuccessResponse or an ErrorResponse.\r
 191       </xs:documentation>\r
 192     </xs:annotation>\r
 193     <xs:complexContent>\r
 194       <xs:extension base="core:OCIRequest">\r
 195         <xs:sequence>\r
 196           <xs:element name="serviceProviderId" type="ServiceProviderId"/>\r
 197           <xs:element name="groupId" type="GroupId"/>\r
 198           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 199           <xs:element name="emergencyZonesProhibition" type="EmergencyZonesProhibition" minOccurs="0"/>\r
 200           <xs:element name="sendEmergencyCallNotifyEmail" type="xs:boolean" minOccurs="0"/>\r
 201           <xs:element name="emergencyCallNotifyEmailAddress" type="EmailAddress" nillable="true" minOccurs="0"/>\r
 202         </xs:sequence>\r
 203       </xs:extension>\r
 204     </xs:complexContent>\r
 205   </xs:complexType>    \r
 206     \r
 207   <xs:complexType name="SystemEmergencyZonesGetRequest">\r
 208     <xs:annotation>\r
 209       <xs:appinfo>\r
 210         <asDataModeSupported>true</asDataModeSupported>\r
 211         <hssDataModeSupported>false</hssDataModeSupported>\r
 212       </xs:appinfo>\r
 213       <xs:documentation>\r
 214         Request the system level data associated with Emergency Zones.\r
 215         The response is either a SystemEmergencyZonesGetResponse or an\r
 216         ErrorResponse.\r
 217       </xs:documentation>\r
 218     </xs:annotation>\r
 219     <xs:complexContent>\r
 220       <xs:extension base="core:OCIRequest">\r
 221         <xs:sequence/>\r
 222       </xs:extension>\r
 223     </xs:complexContent>\r
 224   </xs:complexType>    \r
 225     \r
 226   <xs:complexType name="SystemEmergencyZonesGetResponse">\r
 227     <xs:annotation>\r
 228       <xs:appinfo>\r
 229         <asDataModeSupported>true</asDataModeSupported>\r
 230         <hssDataModeSupported>false</hssDataModeSupported>\r
 231       </xs:appinfo>\r
 232       <xs:documentation>\r
 233         Response to SystemEmergencyZonesGetRequest.\r
 234       </xs:documentation>\r
 235     </xs:annotation>\r
 236     <xs:complexContent>\r
 237       <xs:extension base="core:OCIDataResponse">\r
 238         <xs:sequence>\r
 239           <xs:element name="defaultFromAddress" type="EmailAddress"/>\r
 240         </xs:sequence>\r
 241       </xs:extension>\r
 242     </xs:complexContent>\r
 243   </xs:complexType>    \r
 244     \r
 245   <xs:complexType name="SystemEmergencyZonesModifyRequest">\r
 246     <xs:annotation>\r
 247       <xs:appinfo>\r
 248         <asDataModeSupported>true</asDataModeSupported>\r
 249         <hssDataModeSupported>false</hssDataModeSupported>\r
 250       </xs:appinfo>\r
 251       <xs:documentation>\r
 252         Modify the system level data associated with Emergency Zones.\r
 253         The response is either a SuccessResponse or an ErrorResponse.\r
 254       </xs:documentation>\r
 255     </xs:annotation>\r
 256     <xs:complexContent>\r
 257       <xs:extension base="core:OCIRequest">\r
 258         <xs:sequence>\r
 259           <xs:element name="defaultFromAddress" type="EmailAddress" minOccurs="0"/>\r
 260         </xs:sequence>\r
 261       </xs:extension>\r
 262     </xs:complexContent>\r
 263   </xs:complexType>    \r
 264     \r
 265   <xs:simpleType name="EmergencyZonesProhibition">\r
 266     <xs:annotation>\r
 267       <xs:documentation>\r
 268         Emergency zone policy to specify what kind of calls will be prohibited by the service when\r
 269         originated from outside the home zone.\r
 270       </xs:documentation>\r
 271     </xs:annotation>\r
 272     <xs:restriction base="xs:token">\r
 273       <xs:enumeration value="Prohibit all registrations and call originations"/>\r
 274       <xs:enumeration value="Prohibit emergency call originations"/>\r
 275     </xs:restriction>\r
 276   </xs:simpleType>    \r
 277     \r
 278 </xs:schema>\r