share/OCISchemaAS/Services/OCISchemaServiceSecurityClassification.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 <!-- S E C U R I T Y   C L A S S I F I C A T I O N  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   <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>\r
  25   \r
  26   <!-- ********************************************************************************** -->\r
  27   <!-- S E C U R I T Y   C L A S S I F I C A T I O N                                      -->\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     GroupTrunkGroupSecurityClassificationGetRequest    \r
  37     GroupTrunkGroupSecurityClassificationModifyRequest    \r
  38     SystemSecurityClassificationGetClassificationRequest    \r
  39     SystemSecurityClassificationAddClassificationRequest    \r
  40     SystemSecurityClassificationDeleteClassificationRequest    \r
  41     SystemSecurityClassificationGetRequest21    \r
  42     SystemSecurityClassificationModifyRequest    \r
  43     SystemSecurityClassificationModifyClassificationRequest    \r
  44     UserSecurityClassificationGetRequest    \r
  45     UserSecurityClassificationModifyRequest    \r
  46     SystemSecurityClassificationGetClassificationUserUsageListRequest    \r
  47     SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest    \r
  48     \r
  49   --> \r
  50   \r
  51   <xs:complexType name="GroupTrunkGroupSecurityClassificationGetRequest">\r
  52     <xs:annotation>\r
  53       <xs:appinfo>\r
  54         <asDataModeSupported>true</asDataModeSupported>\r
  55         <hssDataModeSupported>false</hssDataModeSupported>\r
  56       </xs:appinfo>\r
  57       <xs:documentation>\r
  58         Get a trunk group's Security Classifications configuration.\r
  59         The response is either GroupTrunkGroupSecurityClassificationGetResponse or ErrorResponse.\r
  60       </xs:documentation>\r
  61     </xs:annotation>\r
  62     <xs:complexContent>\r
  63       <xs:extension base="core:OCIRequest">\r
  64         <xs:sequence>\r
  65           <xs:element name="trunkGroupKey" type="TrunkGroupKey"/>\r
  66         </xs:sequence>\r
  67       </xs:extension>\r
  68     </xs:complexContent>\r
  69   </xs:complexType>    \r
  70     \r
  71   <xs:complexType name="GroupTrunkGroupSecurityClassificationGetResponse">\r
  72     <xs:annotation>\r
  73       <xs:appinfo>\r
  74         <asDataModeSupported>true</asDataModeSupported>\r
  75         <hssDataModeSupported>false</hssDataModeSupported>\r
  76       </xs:appinfo>\r
  77       <xs:documentation>\r
  78         Response to the GroupTrunkGroupSecurityClassificationGetRequest.\r
  79       </xs:documentation>\r
  80     </xs:annotation>\r
  81     <xs:complexContent>\r
  82       <xs:extension base="core:OCIDataResponse">\r
  83         <xs:sequence>\r
  84           <xs:element name="defaultSecurityClassification" type="SecurityClassificationName" minOccurs="0"/>\r
  85         </xs:sequence>\r
  86       </xs:extension>\r
  87     </xs:complexContent>\r
  88   </xs:complexType>    \r
  89     \r
  90   <xs:complexType name="GroupTrunkGroupSecurityClassificationModifyRequest">\r
  91     <xs:annotation>\r
  92       <xs:appinfo>\r
  93         <asDataModeSupported>true</asDataModeSupported>\r
  94         <hssDataModeSupported>false</hssDataModeSupported>\r
  95       </xs:appinfo>\r
  96       <xs:documentation>\r
  97         Modify a trunk group's Security Classification configuration\r
  98         The response is either a SuccessResponse or an 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="trunkGroupKey" type="TrunkGroupKey"/>\r
 105           <xs:element name="defaultSecurityClassification" type="SecurityClassificationName" nillable="true"/>\r
 106         </xs:sequence>\r
 107       </xs:extension>\r
 108     </xs:complexContent>\r
 109   </xs:complexType>    \r
 110     \r
 111   <xs:complexType name="SystemSecurityClassificationGetClassificationRequest">\r
 112     <xs:annotation>\r
 113       <xs:appinfo>\r
 114         <asDataModeSupported>true</asDataModeSupported>\r
 115         <hssDataModeSupported>false</hssDataModeSupported>\r
 116       </xs:appinfo>\r
 117       <xs:documentation>\r
 118         Get a system Security Classification.\r
 119         The response is either SystemSecurityClassificationGetClassificationResponse or 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="securityClassificationName" type="SecurityClassificationName"/>\r
 126         </xs:sequence>\r
 127       </xs:extension>\r
 128     </xs:complexContent>\r
 129   </xs:complexType>    \r
 130     \r
 131   <xs:complexType name="SystemSecurityClassificationGetClassificationResponse">\r
 132     <xs:annotation>\r
 133       <xs:appinfo>\r
 134         <asDataModeSupported>true</asDataModeSupported>\r
 135         <hssDataModeSupported>false</hssDataModeSupported>\r
 136       </xs:appinfo>\r
 137       <xs:documentation>\r
 138         Response to the SystemSecurityClassificationGetClassificationRequest.\r
 139       </xs:documentation>\r
 140     </xs:annotation>\r
 141     <xs:complexContent>\r
 142       <xs:extension base="core:OCIDataResponse">\r
 143         <xs:sequence>\r
 144           <xs:element name="audioAnnouncementFileDescription" type="FileDescription"/>\r
 145           <xs:element name="audioAnnouncementFileType" type="MediaFileType"/>\r
 146         </xs:sequence>\r
 147       </xs:extension>\r
 148     </xs:complexContent>\r
 149   </xs:complexType>    \r
 150     \r
 151   <xs:complexType name="SystemSecurityClassificationAddClassificationRequest">\r
 152     <xs:annotation>\r
 153       <xs:appinfo>\r
 154         <asDataModeSupported>true</asDataModeSupported>\r
 155         <hssDataModeSupported>false</hssDataModeSupported>\r
 156       </xs:appinfo>\r
 157       <xs:documentation>\r
 158         Add a new Security Classification\r
 159         The response is either a SuccessResponse or an ErrorResponse.\r
 160       </xs:documentation>\r
 161     </xs:annotation>\r
 162     <xs:complexContent>\r
 163       <xs:extension base="core:OCIRequest">\r
 164         <xs:sequence>\r
 165           <xs:element name="securityClassificationName" type="SecurityClassificationName"/>\r
 166           <xs:element name="audioFile" type="LabeledMediaFileResource"/>\r
 167         </xs:sequence>\r
 168       </xs:extension>\r
 169     </xs:complexContent>\r
 170   </xs:complexType>    \r
 171     \r
 172   <xs:complexType name="SystemSecurityClassificationDeleteClassificationRequest">\r
 173     <xs:annotation>\r
 174       <xs:appinfo>\r
 175         <asDataModeSupported>true</asDataModeSupported>\r
 176         <hssDataModeSupported>false</hssDataModeSupported>\r
 177       </xs:appinfo>\r
 178       <xs:documentation>\r
 179         Delete a System Security Classification\r
 180         The response is either a SuccessResponse or an ErrorResponse.\r
 181       </xs:documentation>\r
 182     </xs:annotation>\r
 183     <xs:complexContent>\r
 184       <xs:extension base="core:OCIRequest">\r
 185         <xs:sequence>\r
 186           <xs:element name="securityClassificationName" type="SecurityClassificationName"/>\r
 187         </xs:sequence>\r
 188       </xs:extension>\r
 189     </xs:complexContent>\r
 190   </xs:complexType>    \r
 191     \r
 192   <xs:complexType name="SystemSecurityClassificationGetRequest21">\r
 193     <xs:annotation>\r
 194       <xs:appinfo>\r
 195         <asDataModeSupported>true</asDataModeSupported>\r
 196         <hssDataModeSupported>false</hssDataModeSupported>\r
 197       </xs:appinfo>\r
 198       <xs:documentation>\r
 199         Get system Security Classifications parameters.\r
 200         The response is either SystemSecurityClassificationGetResponse21 or ErrorResponse.\r
 201       </xs:documentation>\r
 202     </xs:annotation>\r
 203     <xs:complexContent>\r
 204       <xs:extension base="core:OCIRequest"/>\r
 205     </xs:complexContent>\r
 206   </xs:complexType>    \r
 207     \r
 208   <xs:complexType name="SystemSecurityClassificationGetResponse21">\r
 209     <xs:annotation>\r
 210       <xs:appinfo>\r
 211         <asDataModeSupported>true</asDataModeSupported>\r
 212         <hssDataModeSupported>false</hssDataModeSupported>\r
 213       </xs:appinfo>\r
 214       <xs:documentation>\r
 215         Response to the SystemSecurityClassificationGetRequest21.\r
 216         Contains a table with column headings:\r
 217         "Name", "Priority".\r
 218       </xs:documentation>\r
 219     </xs:annotation>\r
 220     <xs:complexContent>\r
 221       <xs:extension base="core:OCIDataResponse">\r
 222         <xs:sequence>\r
 223           <xs:element name="meetMeAnncThreshold" type="SecurityClassificationMeetMeConferenceAnnouncementThresholdSeconds"/>\r
 224           <xs:element name="playTrunkUserSecurityClassificationAnnouncement" type="xs:boolean"/>\r
 225           <xs:element name="SecurityClassificationTable" type="core:OCITable"/>\r
 226         </xs:sequence>\r
 227       </xs:extension>\r
 228     </xs:complexContent>\r
 229   </xs:complexType>    \r
 230     \r
 231   <xs:complexType name="SystemSecurityClassificationModifyRequest">\r
 232     <xs:annotation>\r
 233       <xs:appinfo>\r
 234         <asDataModeSupported>true</asDataModeSupported>\r
 235         <hssDataModeSupported>false</hssDataModeSupported>\r
 236       </xs:appinfo>\r
 237       <xs:documentation>\r
 238         Modify security classification parameters.\r
 239         The response is either a SuccessResponse or an ErrorResponse.\r
 240         NOTE: The security classifications must be specified in order of priority. The command fails if all the security classifications defined for the system are not provided.\r
 241       </xs:documentation>\r
 242     </xs:annotation>\r
 243     <xs:complexContent>\r
 244       <xs:extension base="core:OCIRequest">\r
 245         <xs:sequence>\r
 246           <xs:element name="meetMeAnncThreshold" type="SecurityClassificationMeetMeConferenceAnnouncementThresholdSeconds" minOccurs="0"/>\r
 247           <xs:element name="playTrunkUserSecurityClassificationAnnouncement" type="xs:boolean" minOccurs="0"/>\r
 248           <xs:element name="securityClassificationName" type="SecurityClassificationName" minOccurs="0" maxOccurs="20"/>\r
 249         </xs:sequence>\r
 250       </xs:extension>\r
 251     </xs:complexContent>\r
 252   </xs:complexType>    \r
 253     \r
 254   <xs:complexType name="SystemSecurityClassificationModifyClassificationRequest">\r
 255     <xs:annotation>\r
 256       <xs:appinfo>\r
 257         <asDataModeSupported>true</asDataModeSupported>\r
 258         <hssDataModeSupported>false</hssDataModeSupported>\r
 259       </xs:appinfo>\r
 260       <xs:documentation>\r
 261         Modify a Security Classification\r
 262         The response is either a SuccessResponse or an ErrorResponse.\r
 263       </xs:documentation>\r
 264     </xs:annotation>\r
 265     <xs:complexContent>\r
 266       <xs:extension base="core:OCIRequest">\r
 267         <xs:sequence>\r
 268           <xs:element name="securityClassificationName" type="SecurityClassificationName"/>\r
 269           <xs:element name="newSecurityClassificationName" type="SecurityClassificationName" minOccurs="0"/>\r
 270           <xs:element name="audioFile" type="LabeledMediaFileResource" minOccurs="0"/>\r
 271         </xs:sequence>\r
 272       </xs:extension>\r
 273     </xs:complexContent>\r
 274   </xs:complexType>    \r
 275     \r
 276   <xs:complexType name="UserSecurityClassificationGetRequest">\r
 277     <xs:annotation>\r
 278       <xs:appinfo>\r
 279         <asDataModeSupported>true</asDataModeSupported>\r
 280         <hssDataModeSupported>false</hssDataModeSupported>\r
 281       </xs:appinfo>\r
 282       <xs:documentation>\r
 283         Get a user's Security Classifications configuration.\r
 284         The response is either UserSecurityClassificationGetResponse or ErrorResponse.\r
 285       </xs:documentation>\r
 286     </xs:annotation>\r
 287     <xs:complexContent>\r
 288       <xs:extension base="core:OCIRequest">\r
 289         <xs:sequence>\r
 290           <xs:element name="userId" type="UserId"/>\r
 291         </xs:sequence>\r
 292       </xs:extension>\r
 293     </xs:complexContent>\r
 294   </xs:complexType>    \r
 295     \r
 296   <xs:complexType name="UserSecurityClassificationGetResponse">\r
 297     <xs:annotation>\r
 298       <xs:documentation>\r
 299         Response to the UserSecurityClassificationGetRequest.\r
 300       </xs:documentation>\r
 301     </xs:annotation>\r
 302     <xs:complexContent>\r
 303       <xs:extension base="core:OCIDataResponse">\r
 304         <xs:sequence>\r
 305           <xs:element name="securityClassification" type="SecurityClassificationName" minOccurs="0"/>\r
 306         </xs:sequence>\r
 307       </xs:extension>\r
 308     </xs:complexContent>\r
 309   </xs:complexType>    \r
 310     \r
 311   <xs:complexType name="UserSecurityClassificationModifyRequest">\r
 312     <xs:annotation>\r
 313       <xs:appinfo>\r
 314         <asDataModeSupported>true</asDataModeSupported>\r
 315         <hssDataModeSupported>false</hssDataModeSupported>\r
 316       </xs:appinfo>\r
 317       <xs:documentation>\r
 318         Modify a user's Security Classification configuration\r
 319         The response is either a SuccessResponse or an ErrorResponse.\r
 320       </xs:documentation>\r
 321     </xs:annotation>\r
 322     <xs:complexContent>\r
 323       <xs:extension base="core:OCIRequest">\r
 324         <xs:sequence>\r
 325           <xs:element name="userId" type="UserId"/>\r
 326           <xs:element name="securityClassification" type="SecurityClassificationName" nillable="true"/>\r
 327         </xs:sequence>\r
 328       </xs:extension>\r
 329     </xs:complexContent>\r
 330   </xs:complexType>    \r
 331     \r
 332   <xs:complexType name="SystemSecurityClassificationGetClassificationUserUsageListRequest">\r
 333     <xs:annotation>\r
 334       <xs:appinfo>\r
 335         <asDataModeSupported>true</asDataModeSupported>\r
 336         <hssDataModeSupported>false</hssDataModeSupported>\r
 337       </xs:appinfo>\r
 338       <xs:documentation>\r
 339         Get a list of users that currently have the specified Security Classification assigned.\r
 340         The response is either SystemSecurityClassificationGetClassificationUserUsageListResponse or ErrorResponse.\r
 341       </xs:documentation>\r
 342     </xs:annotation>\r
 343     <xs:complexContent>\r
 344       <xs:extension base="core:OCIRequest">\r
 345         <xs:sequence>\r
 346           <xs:element name="securityClassification" type="SecurityClassificationName"/>\r
 347           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 348           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 349           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 350           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 351           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 352           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 353         </xs:sequence>\r
 354       </xs:extension>\r
 355     </xs:complexContent>\r
 356   </xs:complexType>    \r
 357     \r
 358   <xs:complexType name="SystemSecurityClassificationGetClassificationUserUsageListResponse">\r
 359     <xs:annotation>\r
 360       <xs:documentation>\r
 361         Response to the SystemSecurityClassificationGetClassificationUserUsageListRequest.\r
 362         Contains a table with column headings:\r
 363         "User ID", "Last Name", "First Name", "Phone Number", "Extension", "Service Provider Id", "Group Id".\r
 364       </xs:documentation>\r
 365     </xs:annotation>\r
 366     <xs:complexContent>\r
 367       <xs:extension base="core:OCIDataResponse">\r
 368         <xs:sequence>\r
 369           <xs:element name="usageTable" type="core:OCITable"/>\r
 370         </xs:sequence>\r
 371       </xs:extension>\r
 372     </xs:complexContent>\r
 373   </xs:complexType>    \r
 374     \r
 375   <xs:complexType name="SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest">\r
 376     <xs:annotation>\r
 377       <xs:appinfo>\r
 378         <asDataModeSupported>true</asDataModeSupported>\r
 379         <hssDataModeSupported>false</hssDataModeSupported>\r
 380       </xs:appinfo>\r
 381       <xs:documentation>\r
 382         Get a list of users that currently have the specified Security Classification assigned.\r
 383         The response is either SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse or ErrorResponse.\r
 384       </xs:documentation>\r
 385     </xs:annotation>\r
 386     <xs:complexContent>\r
 387       <xs:extension base="core:OCIRequest">\r
 388         <xs:sequence>\r
 389           <xs:element name="securityClassification" type="SecurityClassificationName"/>\r
 390           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 391           <xs:element name="searchCriteriaTrunkGroupName" type="SearchCriteriaTrunkGroupName" minOccurs="0" maxOccurs="unbounded"/>\r
 392           <xs:element name="searchCriteriaGroupId" type="SearchCriteriaGroupId" minOccurs="0" maxOccurs="unbounded"/>\r
 393           <xs:element name="searchCriteriaServiceProviderId" type="SearchCriteriaServiceProviderId" minOccurs="0" maxOccurs="unbounded"/>\r
 394           <xs:element name="searchCriteriaExactOrganizationType" type="SearchCriteriaExactOrganizationType" minOccurs="0"/>\r
 395         </xs:sequence>\r
 396       </xs:extension>\r
 397     </xs:complexContent>\r
 398   </xs:complexType>    \r
 399     \r
 400   <xs:complexType name="SystemSecurityClassificationGetClassificationTrunkGroupUsageListResponse">\r
 401     <xs:annotation>\r
 402       <xs:documentation>\r
 403         Response to the SystemSecurityClassificationGetClassificationTrunkGroupUsageListRequest.\r
 404         Contains a table with column headings:\r
 405         "Trunk Group Name","Group ID","Organization ID" and "Organization Type"\r
 406       </xs:documentation>\r
 407     </xs:annotation>\r
 408     <xs:complexContent>\r
 409       <xs:extension base="core:OCIDataResponse">\r
 410         <xs:sequence>\r
 411           <xs:element name="usageTable" type="core:OCITable"/>\r
 412         </xs:sequence>\r
 413       </xs:extension>\r
 414     </xs:complexContent>\r
 415   </xs:complexType>    \r
 416     \r
 417 </xs:schema>\r