share/OCISchemaAS/Services/OCISchemaServiceAttendantConsole.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 <!-- A T T E N D A N T   C O N S O L 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   <!-- A T T E N D A N T   C O N S O L E    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     SystemAttendantConsoleGetRequest    \r
  36     SystemAttendantConsoleModifyRequest    \r
  37     UserAttendantConsoleAddUserListRequest    \r
  38     UserAttendantConsoleDeleteUserListRequest    \r
  39     UserAttendantConsoleGetAvailableUserListRequest    \r
  40     UserAttendantConsoleGetRequest14sp2    \r
  41     UserAttendantConsoleModifyRequest    \r
  42     \r
  43   --> \r
  44   \r
  45   <xs:complexType name="SystemAttendantConsoleGetRequest">\r
  46     <xs:annotation>\r
  47       <xs:documentation>\r
  48         Request to get the list of Attendant Console parameters.\r
  49         The response is either SystemAttendantConsoleGetResponse or 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:extension>\r
  56     </xs:complexContent>\r
  57   </xs:complexType>    \r
  58     \r
  59   <xs:complexType name="SystemAttendantConsoleGetResponse">\r
  60     <xs:annotation>\r
  61       <xs:documentation>\r
  62         Response to SystemAttendantConsoleGetRequest.\r
  63         Contains a list of Attendant Console parameters.\r
  64       </xs:documentation>\r
  65     </xs:annotation>\r
  66     <xs:complexContent>\r
  67       <xs:extension base="core:OCIDataResponse">\r
  68         <xs:sequence>\r
  69           <xs:element name="maxMonitoredUsers" type="MaximumMonitoredUsers"/>\r
  70         </xs:sequence>\r
  71       </xs:extension>\r
  72     </xs:complexContent>\r
  73   </xs:complexType>    \r
  74     \r
  75   <xs:complexType name="SystemAttendantConsoleModifyRequest">\r
  76     <xs:annotation>\r
  77       <xs:documentation>\r
  78         Modify Attendant Console settings.\r
  79         The response is either a SuccessResponse or an ErrorResponse.\r
  80       </xs:documentation>\r
  81     </xs:annotation>\r
  82     <xs:complexContent>\r
  83       <xs:extension base="core:OCIRequest">\r
  84         <xs:sequence>\r
  85           <xs:element name="maxMonitoredUsers" type="MaximumMonitoredUsers" minOccurs="0"/>\r
  86         </xs:sequence>\r
  87       </xs:extension>\r
  88     </xs:complexContent>\r
  89   </xs:complexType>    \r
  90     \r
  91   <xs:complexType name="UserAttendantConsoleAddUserListRequest">\r
  92     <xs:annotation>\r
  93       <xs:documentation>\r
  94         Add users to the Attendant Console monitored users list.\r
  95         The response is either a SuccessResponse or an ErrorResponse.\r
  96       </xs:documentation>\r
  97     </xs:annotation>\r
  98     <xs:complexContent>\r
  99       <xs:extension base="core:OCIRequest">\r
 100         <xs:sequence>\r
 101           <xs:element name="userId" type="UserId"/>\r
 102           <xs:element name="monitoredUserId" type="UserId" minOccurs="1" maxOccurs="unbounded"/>\r
 103         </xs:sequence>\r
 104       </xs:extension>\r
 105     </xs:complexContent>\r
 106   </xs:complexType>    \r
 107     \r
 108   <xs:complexType name="UserAttendantConsoleDeleteUserListRequest">\r
 109     <xs:annotation>\r
 110       <xs:documentation>\r
 111         Remove users from the Attendant Console monitored users list.\r
 112         The response is either a SuccessResponse or an ErrorResponse.\r
 113       </xs:documentation>\r
 114     </xs:annotation>\r
 115     <xs:complexContent>\r
 116       <xs:extension base="core:OCIRequest">\r
 117         <xs:sequence>\r
 118           <xs:element name="userId" type="UserId"/>\r
 119           <xs:element name="monitoredUserId" type="UserId" minOccurs="1" maxOccurs="unbounded"/>\r
 120         </xs:sequence>\r
 121       </xs:extension>\r
 122     </xs:complexContent>\r
 123   </xs:complexType>    \r
 124     \r
 125   <xs:complexType name="UserAttendantConsoleGetAvailableUserListRequest">\r
 126     <xs:annotation>\r
 127       <xs:documentation>\r
 128         Get a list of available users for the Attendant Console service.\r
 129         The response is either UserAttendantConsoleGetAvailableUserListResponse or ErrorResponse.\r
 130       </xs:documentation>\r
 131     </xs:annotation>\r
 132     <xs:complexContent>\r
 133       <xs:extension base="core:OCIRequest">\r
 134         <xs:sequence>\r
 135           <xs:element name="userId" type="UserId"/>\r
 136           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 137           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 138           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 139           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
 140           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 141           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 142           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 143           <xs:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
 144         </xs:sequence>\r
 145       </xs:extension>\r
 146     </xs:complexContent>\r
 147   </xs:complexType>    \r
 148     \r
 149   <xs:complexType name="UserAttendantConsoleGetAvailableUserListResponse">\r
 150     <xs:annotation>\r
 151       <xs:documentation>\r
 152         Response to UserAttendantConsoleGetAvailableUserListRequest.\r
 153         Returns a 10 column table with column headings:\r
 154           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 155           "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 156       </xs:documentation>\r
 157     </xs:annotation>\r
 158     <xs:complexContent>\r
 159       <xs:extension base="core:OCIDataResponse">\r
 160         <xs:sequence>\r
 161           <xs:element name="userTable" type="core:OCITable"/>\r
 162         </xs:sequence>\r
 163       </xs:extension>\r
 164     </xs:complexContent>\r
 165   </xs:complexType>    \r
 166     \r
 167   <xs:complexType name="UserAttendantConsoleGetRequest14sp2">\r
 168     <xs:annotation>\r
 169       <xs:documentation>\r
 170         Request user's attendant console settings.\r
 171         The response is either a UserAttendantConsoleGetResponse14sp2 or an ErrorResponse.\r
 172       </xs:documentation>\r
 173     </xs:annotation>\r
 174     <xs:complexContent>\r
 175       <xs:extension base="core:OCIRequest">\r
 176         <xs:sequence>\r
 177           <xs:element name="userId" type="UserId"/>\r
 178         </xs:sequence>\r
 179       </xs:extension>\r
 180     </xs:complexContent>\r
 181   </xs:complexType>    \r
 182     \r
 183   <xs:complexType name="UserAttendantConsoleGetResponse14sp2">\r
 184     <xs:annotation>\r
 185       <xs:documentation>\r
 186         Response to UserAttendantConsoleGetRequest14sp2.\r
 187         Returns a 9 column table with column headings:\r
 188           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 189           "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 190       </xs:documentation>\r
 191     </xs:annotation>\r
 192     <xs:complexContent>\r
 193       <xs:extension base="core:OCIDataResponse">\r
 194         <xs:sequence>\r
 195           <xs:element name="launchOnLogin" type="xs:boolean"/>\r
 196           <xs:element name="allowUserConfigCallDetails" type="xs:boolean"/>\r
 197           <xs:element name="allowUserViewCallDetails" type="xs:boolean"/>\r
 198           <xs:element name="displayColumn" type="AttendantConsoleDisplayColumn" minOccurs="0" maxOccurs="10"/>\r
 199           <xs:element name="monitoredUserTable" type="core:OCITable"/>\r
 200         </xs:sequence>\r
 201       </xs:extension>\r
 202     </xs:complexContent>\r
 203   </xs:complexType>    \r
 204     \r
 205   <xs:complexType name="UserAttendantConsoleModifyRequest">\r
 206     <xs:annotation>\r
 207       <xs:documentation>\r
 208         Modify user's attendant console settings.\r
 209         The response is either a SuccessResponse or an ErrorResponse.\r
 210       </xs:documentation>\r
 211     </xs:annotation>\r
 212     <xs:complexContent>\r
 213       <xs:extension base="core:OCIRequest">\r
 214         <xs:sequence>\r
 215           <xs:element name="userId" type="UserId"/>\r
 216           <xs:element name="launchOnLogin" type="xs:boolean" minOccurs="0"/>\r
 217           <xs:element name="allowUserConfigCallDetails" type="xs:boolean" minOccurs="0"/>\r
 218           <xs:element name="allowUserViewCallDetails" type="xs:boolean" minOccurs="0"/>\r
 219           <xs:element name="displayColumnList" type="AttendantConsoleReplacementDisplayColumnList" nillable="true" minOccurs="0"/>\r
 220           <xs:element name="monitoredUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 221         </xs:sequence>\r
 222       </xs:extension>\r
 223     </xs:complexContent>\r
 224   </xs:complexType>    \r
 225     \r
 226   <xs:simpleType name="AttendantConsoleDisplayColumn">\r
 227     <xs:annotation>\r
 228       <xs:documentation>\r
 229         Attendant Console Display Columns.\r
 230       </xs:documentation>\r
 231     </xs:annotation>\r
 232     <xs:restriction base="xs:token">\r
 233       <xs:enumeration value="Action"/>\r
 234       <xs:enumeration value="Department"/>\r
 235       <xs:enumeration value="Email"/>\r
 236       <xs:enumeration value="Extension"/>\r
 237       <xs:enumeration value="Mobile"/>\r
 238       <xs:enumeration value="Name"/>\r
 239       <xs:enumeration value="Phone Number"/>\r
 240       <xs:enumeration value="Pager"/>\r
 241       <xs:enumeration value="Status"/>\r
 242       <xs:enumeration value="Title"/>\r
 243     </xs:restriction>\r
 244   </xs:simpleType>    \r
 245     \r
 246   <xs:complexType name="AttendantConsoleReplacementDisplayColumnList">\r
 247     <xs:annotation>\r
 248       <xs:documentation>\r
 249         A list of attendant console display columns that replaces a previously configured list.\r
 250         By convention, an element of this type may be set nil to clear the list.\r
 251       </xs:documentation>\r
 252     </xs:annotation>\r
 253     <xs:sequence>\r
 254       <xs:element name="displayColumn" type="AttendantConsoleDisplayColumn" minOccurs="1" maxOccurs="10"/>\r
 255     </xs:sequence>\r
 256   </xs:complexType>    \r
 257     \r
 258 </xs:schema>\r