share/OCISchemaAS/Services/OCISchemaServicePrivacy.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 <!-- P R I V A C Y  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   <!-- P R I V A C Y    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     GroupServiceInstancePrivacyGetRequest17sp4    \r
  36     GroupServiceInstancePrivacyModifyRequest    \r
  37     UserPrivacyGetAvailableMonitorsUserListRequest    \r
  38     UserPrivacyGetRequest13mp17    \r
  39     UserPrivacyModifyRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="GroupServiceInstancePrivacyGetRequest17sp4">\r
  44     <xs:annotation>\r
  45       <xs:appinfo>\r
  46         <asDataModeSupported>true</asDataModeSupported>\r
  47         <hssDataModeSupported>false</hssDataModeSupported>\r
  48       </xs:appinfo>\r
  49       <xs:documentation>\r
  50         Request the data associated with Privacy for a service instance.\r
  51         The response is either a GroupServiceInstancePrivacyGetResponse17sp4\r
  52         or an 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:element name="serviceUserId" type="UserId"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="GroupServiceInstancePrivacyGetResponse17sp4">\r
  65     <xs:annotation>\r
  66       <xs:appinfo>\r
  67         <asDataModeSupported>true</asDataModeSupported>\r
  68         <hssDataModeSupported>false</hssDataModeSupported>\r
  69       </xs:appinfo>\r
  70       <xs:documentation>\r
  71         Response to GroupServiceInstancePrivacyGetRequest17sp4.\r
  72       </xs:documentation>\r
  73     </xs:annotation>\r
  74     <xs:complexContent>\r
  75       <xs:extension base="core:OCIDataResponse">\r
  76         <xs:sequence>\r
  77           <xs:element name="enableDirectoryPrivacy" type="xs:boolean"/>\r
  78           <xs:element name="enableAutoAttendantExtensionDialingPrivacy" type="xs:boolean"/>\r
  79           <xs:element name="enableAutoAttendantNameDialingPrivacy" type="xs:boolean"/>\r
  80         </xs:sequence>\r
  81       </xs:extension>\r
  82     </xs:complexContent>\r
  83   </xs:complexType>    \r
  84     \r
  85   <xs:complexType name="GroupServiceInstancePrivacyModifyRequest">\r
  86     <xs:annotation>\r
  87       <xs:appinfo>\r
  88         <asDataModeSupported>true</asDataModeSupported>\r
  89         <hssDataModeSupported>false</hssDataModeSupported>\r
  90       </xs:appinfo>\r
  91       <xs:documentation>\r
  92         Modify the data associated with Privacy for a service instance.\r
  93         The response is either a SuccessResponse or an ErrorResponse.\r
  94       </xs:documentation>\r
  95     </xs:annotation>\r
  96     <xs:complexContent>\r
  97       <xs:extension base="core:OCIRequest">\r
  98         <xs:sequence>\r
  99           <xs:element name="serviceUserId" type="UserId"/>\r
 100           <xs:element name="enableDirectoryPrivacy" type="xs:boolean" minOccurs="0"/>\r
 101           <xs:element name="enableAutoAttendantExtensionDialingPrivacy" type="xs:boolean" minOccurs="0"/>\r
 102           <xs:element name="enableAutoAttendantNameDialingPrivacy" type="xs:boolean" minOccurs="0"/>\r
 103         </xs:sequence>\r
 104       </xs:extension>\r
 105     </xs:complexContent>\r
 106   </xs:complexType>    \r
 107     \r
 108   <xs:complexType name="UserPrivacyGetAvailableMonitorsUserListRequest">\r
 109     <xs:annotation>\r
 110       <xs:documentation>\r
 111         Retrieves a list of users in the enterprise or group available\r
 112         for phone status monitoring the user specified in the userId\r
 113         element.  The response is either\r
 114         UserPrivacyGetAvailableMonitorsUserListResponse or ErrorResponse.\r
 115       </xs:documentation>\r
 116     </xs:annotation>\r
 117     <xs:complexContent>\r
 118       <xs:extension base="core:OCIRequest">\r
 119         <xs:sequence>\r
 120           <xs:element name="userId" type="UserId"/>\r
 121           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 122           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 123           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 124           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
 125           <xs:element name="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>\r
 126           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 127           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 128           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 129           <xs:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
 130         </xs:sequence>\r
 131       </xs:extension>\r
 132     </xs:complexContent>\r
 133   </xs:complexType>    \r
 134     \r
 135   <xs:complexType name="UserPrivacyGetAvailableMonitorsUserListResponse">\r
 136     <xs:annotation>\r
 137       <xs:documentation>\r
 138         Response to the UserPrivacyGetAvailableMonitorsUserListRequest.\r
 139         Returns a 10 column table with column headings:\r
 140         "User Id", "Last Name", "First Name", "Hiragana Last Name",\r
 141         "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 142       </xs:documentation>\r
 143     </xs:annotation>\r
 144     <xs:complexContent>\r
 145       <xs:extension base="core:OCIDataResponse">\r
 146         <xs:sequence>\r
 147           <xs:element name="availableMonitorsTable" type="core:OCITable"/>\r
 148         </xs:sequence>\r
 149       </xs:extension>\r
 150     </xs:complexContent>\r
 151   </xs:complexType>    \r
 152     \r
 153   <xs:complexType name="UserPrivacyGetRequest13mp17">\r
 154     <xs:annotation>\r
 155       <xs:documentation>\r
 156         Request the user level data associated with Privacy.\r
 157         This command is supported for regular users only.\r
 158         The response is either a UserPrivacyGetResponse13mp17\r
 159         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="userId" type="UserId"/>\r
 166         </xs:sequence>\r
 167       </xs:extension>\r
 168     </xs:complexContent>\r
 169   </xs:complexType>    \r
 170     \r
 171   <xs:complexType name="UserPrivacyGetResponse13mp17">\r
 172     <xs:annotation>\r
 173       <xs:documentation>\r
 174         Response to UserPrivacyGetRequest13mp17.  The\r
 175         permittedMonitorUserIdTable contains the members of\r
 176         the enterprise or group allowed to monitor the phone\r
 177         status of the user specified in the request.  Members\r
 178         of this table are allowed to monitor the user even if\r
 179         enablePhoneStatusPrivacy is set to true.  The table\r
 180         contains column headings: "User Id", "Last Name",\r
 181         "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 182         "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 183       </xs:documentation>\r
 184     </xs:annotation>\r
 185     <xs:complexContent>\r
 186       <xs:extension base="core:OCIDataResponse">\r
 187         <xs:sequence>\r
 188           <xs:element name="enableDirectoryPrivacy" type="xs:boolean"/>\r
 189           <xs:element name="enableAutoAttendantExtensionDialingPrivacy" type="xs:boolean"/>\r
 190           <xs:element name="enableAutoAttendantNameDialingPrivacy" type="xs:boolean"/>\r
 191           <xs:element name="enablePhoneStatusPrivacy" type="xs:boolean"/>\r
 192           <xs:element name="permittedMonitorUserIdTable" type="core:OCITable"/>\r
 193         </xs:sequence>\r
 194       </xs:extension>\r
 195     </xs:complexContent>\r
 196   </xs:complexType>    \r
 197     \r
 198   <xs:complexType name="UserPrivacyModifyRequest">\r
 199     <xs:annotation>\r
 200       <xs:documentation>\r
 201         Modify the user level data associated with Privacy.\r
 202         This command is supported for regular users only.\r
 203         The response is either a SuccessResponse or an ErrorResponse.\r
 204       </xs:documentation>\r
 205     </xs:annotation>\r
 206     <xs:complexContent>\r
 207       <xs:extension base="core:OCIRequest">\r
 208         <xs:sequence>\r
 209           <xs:element name="userId" type="UserId"/>\r
 210           <xs:element name="enableDirectoryPrivacy" type="xs:boolean" minOccurs="0"/>\r
 211           <xs:element name="enableAutoAttendantExtensionDialingPrivacy" type="xs:boolean" minOccurs="0"/>\r
 212           <xs:element name="enableAutoAttendantNameDialingPrivacy" type="xs:boolean" minOccurs="0"/>\r
 213           <xs:element name="enablePhoneStatusPrivacy" type="xs:boolean" minOccurs="0"/>\r
 214           <xs:element name="permittedMonitorUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 215         </xs:sequence>\r
 216       </xs:extension>\r
 217     </xs:complexContent>\r
 218   </xs:complexType>    \r
 219     \r
 220 </xs:schema>\r