share/OCISchemaAS/Services/OCISchemaServiceReceptionistEnterprise.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 <!-- R E C E P T I O N I S T   E N T E R P R I S E  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   <!-- R E C E P T I O N I S T   E N T E R P R I S E                                      -->\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     SystemBroadWorksReceptionistEnterpriseGetRequest    \r
  37     SystemBroadWorksReceptionistEnterpriseModifyRequest    \r
  38     UserBroadWorksReceptionistEnterpriseAddUserListRequest    \r
  39     UserBroadWorksReceptionistEnterpriseDeleteUserListRequest    \r
  40     UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest    \r
  41     UserBroadWorksReceptionistEnterpriseGetRequest    \r
  42     UserBroadWorksReceptionistEnterpriseModifyRequest    \r
  43     \r
  44   --> \r
  45   \r
  46   <xs:complexType name="SystemBroadWorksReceptionistEnterpriseGetRequest">\r
  47     <xs:annotation>\r
  48       <xs:documentation>\r
  49         Request to get the list of BroadWorks Receptionist - Enterprise parameters.\r
  50         The response is either SystemBroadWorksReceptionistEnterpriseGetResponse or ErrorResponse.\r
  51       </xs:documentation>\r
  52     </xs:annotation>\r
  53     <xs:complexContent>\r
  54       <xs:extension base="core:OCIRequest">\r
  55         <xs:sequence/>\r
  56       </xs:extension>\r
  57     </xs:complexContent>\r
  58   </xs:complexType>    \r
  59     \r
  60   <xs:complexType name="SystemBroadWorksReceptionistEnterpriseGetResponse">\r
  61     <xs:annotation>\r
  62       <xs:documentation>\r
  63         Response to SystemBroadWorksReceptionistEnterpriseGetRequest.\r
  64         Contains a list of BroadWorks Receptionist - Enterprise parameters.\r
  65       </xs:documentation>\r
  66     </xs:annotation>\r
  67     <xs:complexContent>\r
  68       <xs:extension base="core:OCIDataResponse">\r
  69         <xs:sequence>\r
  70           <xs:element name="maxMonitoredUsers" type="MaximumMonitoredUsers"/>\r
  71         </xs:sequence>\r
  72       </xs:extension>\r
  73     </xs:complexContent>\r
  74   </xs:complexType>    \r
  75     \r
  76   <xs:complexType name="SystemBroadWorksReceptionistEnterpriseModifyRequest">\r
  77     <xs:annotation>\r
  78       <xs:documentation>\r
  79         Request to modify BroadWorks Receptionist - Enterprise settings.\r
  80         The response is either a SuccessResponse or an ErrorResponse.\r
  81       </xs:documentation>\r
  82     </xs:annotation>\r
  83     <xs:complexContent>\r
  84       <xs:extension base="core:OCIRequest">\r
  85         <xs:sequence>\r
  86           <xs:element name="maxMonitoredUsers" type="MaximumMonitoredUsers" minOccurs="0"/>\r
  87         </xs:sequence>\r
  88       </xs:extension>\r
  89     </xs:complexContent>\r
  90   </xs:complexType>    \r
  91     \r
  92   <xs:complexType name="UserBroadWorksReceptionistEnterpriseAddUserListRequest">\r
  93     <xs:annotation>\r
  94       <xs:documentation>\r
  95         Add users to the BroadWorks Receptionist - Enterprise monitored user list.\r
  96         The response is either a SuccessResponse or an ErrorResponse.\r
  97       </xs:documentation>\r
  98     </xs:annotation>\r
  99     <xs:complexContent>\r
 100       <xs:extension base="core:OCIRequest">\r
 101         <xs:sequence>\r
 102           <xs:element name="userId" type="UserId"/>\r
 103           <xs:element name="monitoredUserId" type="UserId" minOccurs="1" maxOccurs="unbounded"/>\r
 104         </xs:sequence>\r
 105       </xs:extension>\r
 106     </xs:complexContent>\r
 107   </xs:complexType>    \r
 108     \r
 109   <xs:complexType name="UserBroadWorksReceptionistEnterpriseDeleteUserListRequest">\r
 110     <xs:annotation>\r
 111       <xs:documentation>\r
 112         Remove selected users from the BroadWorks Receptionist - Enterprise monitored user list.\r
 113         The response is either a SuccessResponse or an ErrorResponse.\r
 114       </xs:documentation>\r
 115     </xs:annotation>\r
 116     <xs:complexContent>\r
 117       <xs:extension base="core:OCIRequest">\r
 118         <xs:sequence>\r
 119           <xs:element name="userId" type="UserId"/>\r
 120           <xs:element name="monitoredUserId" type="UserId" minOccurs="1" maxOccurs="unbounded"/>\r
 121         </xs:sequence>\r
 122       </xs:extension>\r
 123     </xs:complexContent>\r
 124   </xs:complexType>    \r
 125     \r
 126   <xs:complexType name="UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest">\r
 127     <xs:annotation>\r
 128       <xs:documentation>\r
 129         Get a list of available users for BroadWorks Receptionist - Enterprise monitoring.\r
 130         The response is either UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse or ErrorResponse.\r
 131       </xs:documentation>\r
 132     </xs:annotation>\r
 133     <xs:complexContent>\r
 134       <xs:extension base="core:OCIRequest">\r
 135         <xs:sequence>\r
 136           <xs:element name="userId" type="UserId"/>\r
 137           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 138           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 139           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 140           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
 141           <xs:element name="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>\r
 142           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 143           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 144           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 145           <xs:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
 146         </xs:sequence>\r
 147       </xs:extension>\r
 148     </xs:complexContent>\r
 149   </xs:complexType>    \r
 150     \r
 151   <xs:complexType name="UserBroadWorksReceptionistEnterpriseGetAvailableUserListResponse">\r
 152     <xs:annotation>\r
 153       <xs:documentation>\r
 154         Response to the UserBroadWorksReceptionistEnterpriseGetAvailableUserListRequest.\r
 155         Returns a 12 column table with column headings:\r
 156           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", \r
 157           "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id".\r
 158       </xs:documentation>\r
 159     </xs:annotation>\r
 160     <xs:complexContent>\r
 161       <xs:extension base="core:OCIDataResponse">\r
 162         <xs:sequence>\r
 163           <xs:element name="userTable" type="core:OCITable"/>\r
 164         </xs:sequence>\r
 165       </xs:extension>\r
 166     </xs:complexContent>\r
 167   </xs:complexType>    \r
 168     \r
 169   <xs:complexType name="UserBroadWorksReceptionistEnterpriseGetRequest">\r
 170     <xs:annotation>\r
 171       <xs:documentation>\r
 172         Request the monitored users list for the BroadWorks Receptionist - Enterprise service.\r
 173         The response is either a UserBroadWorksReceptionistEnterpriseGetResponse or an ErrorResponse.\r
 174       </xs:documentation>\r
 175     </xs:annotation>\r
 176     <xs:complexContent>\r
 177       <xs:extension base="core:OCIRequest">\r
 178         <xs:sequence>\r
 179           <xs:element name="userId" type="UserId"/>\r
 180         </xs:sequence>\r
 181       </xs:extension>\r
 182     </xs:complexContent>\r
 183   </xs:complexType>    \r
 184     \r
 185   <xs:complexType name="UserBroadWorksReceptionistEnterpriseGetResponse">\r
 186     <xs:annotation>\r
 187       <xs:documentation>\r
 188         Response to UserBroadWorksReceptionistEnterpriseGetRequest.\r
 189         Returns a 12 column table with column headings:\r
 190           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", \r
 191           "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id".\r
 192       </xs:documentation>\r
 193     </xs:annotation>\r
 194     <xs:complexContent>\r
 195       <xs:extension base="core:OCIDataResponse">\r
 196         <xs:sequence>\r
 197           <xs:element name="monitoredUserTable" type="core:OCITable"/>\r
 198         </xs:sequence>\r
 199       </xs:extension>\r
 200     </xs:complexContent>\r
 201   </xs:complexType>    \r
 202     \r
 203   <xs:complexType name="UserBroadWorksReceptionistEnterpriseModifyRequest">\r
 204     <xs:annotation>\r
 205       <xs:documentation>\r
 206         Replace the BroadWorks Receptionist - Enterprise monitored user list.\r
 207         The response is either a SuccessResponse or an ErrorResponse.\r
 208       </xs:documentation>\r
 209     </xs:annotation>\r
 210     <xs:complexContent>\r
 211       <xs:extension base="core:OCIRequest">\r
 212         <xs:sequence>\r
 213           <xs:element name="userId" type="UserId"/>\r
 214           <xs:element name="monitoredUserIdList" 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