share/OCISchemaAS/Services/OCISchemaServiceBusyLampField.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 <!-- B U S Y   L A M P   F I E L D  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   <!-- B U S Y   L A M P   F I E L D    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     SystemBusyLampFieldGetRequest18    \r
  36     SystemBusyLampFieldModifyRequest    \r
  37     UserBusyLampFieldGetAvailableUserListRequest    \r
  38     UserBusyLampFieldGetRequest16sp2    \r
  39     UserBusyLampFieldModifyRequest    \r
  40     \r
  41   --> \r
  42   \r
  43   <xs:complexType name="SystemBusyLampFieldGetRequest18">\r
  44     <xs:annotation>\r
  45       <xs:documentation>\r
  46         Request the system level data associated with the Busy Lamp\r
  47         Field service. The response is either a \r
  48         SystemBusyLampFieldGetResponse18 or an ErrorResponse.\r
  49       </xs:documentation>\r
  50     </xs:annotation>\r
  51     <xs:complexContent>\r
  52       <xs:extension base="core:OCIRequest">\r
  53         <xs:sequence/>\r
  54       </xs:extension>\r
  55     </xs:complexContent>\r
  56   </xs:complexType>    \r
  57     \r
  58   <xs:complexType name="SystemBusyLampFieldGetResponse18">\r
  59     <xs:annotation>\r
  60       <xs:documentation>\r
  61         Response to SystemBusyLampFieldGetRequest18.\r
  62         \r
  63         The following elements are only used in AS data mode:\r
  64          forceUseOfTCP\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="displayLocalUserIdentityLastNameFirst" type="xs:boolean"/>\r
  71           <xs:element name="forceUseOfTCP" type="xs:boolean"/>\r
  72         </xs:sequence>\r
  73       </xs:extension>\r
  74     </xs:complexContent>\r
  75   </xs:complexType>    \r
  76     \r
  77   <xs:complexType name="SystemBusyLampFieldModifyRequest">\r
  78     <xs:annotation>\r
  79       <xs:documentation>\r
  80         Modify the system level data associated with the Busy Lamp Field\r
  81         Service. The response is either a SuccessResponse or an \r
  82         ErrorResponse.\r
  83         \r
  84         The following elements are only used in AS data mode:\r
  85          forceUseOfTCP\r
  86       </xs:documentation>\r
  87     </xs:annotation>\r
  88     <xs:complexContent>\r
  89       <xs:extension base="core:OCIRequest">\r
  90         <xs:sequence>\r
  91           <xs:element name="displayLocalUserIdentityLastNameFirst" type="xs:boolean" minOccurs="0"/>\r
  92           <xs:element name="forceUseOfTCP" type="xs:boolean" minOccurs="0"/>\r
  93         </xs:sequence>\r
  94       </xs:extension>\r
  95     </xs:complexContent>\r
  96   </xs:complexType>    \r
  97     \r
  98   <xs:complexType name="UserBusyLampFieldGetAvailableUserListRequest">\r
  99     <xs:annotation>\r
 100       <xs:documentation>\r
 101         Get a list of available users for the busy lamp field service.\r
 102         The response is either UserBusyLampFieldGetAvailableUserListResponse or ErrorResponse.\r
 103       </xs:documentation>\r
 104     </xs:annotation>\r
 105     <xs:complexContent>\r
 106       <xs:extension base="core:OCIRequest">\r
 107         <xs:sequence>\r
 108           <xs:element name="userId" type="UserId"/>\r
 109           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
 110           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
 111           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
 112           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
 113           <xs:element name="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>\r
 114           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
 115           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
 116           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
 117           <xs:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
 118         </xs:sequence>\r
 119       </xs:extension>\r
 120     </xs:complexContent>\r
 121   </xs:complexType>    \r
 122     \r
 123   <xs:complexType name="UserBusyLampFieldGetAvailableUserListResponse">\r
 124     <xs:annotation>\r
 125       <xs:documentation>\r
 126         Response to the BusyLampFieldGetAvailableUserListRequest.\r
 127         Returns a table with column headings:\r
 128           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 129           "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 130       </xs:documentation>\r
 131     </xs:annotation>\r
 132     <xs:complexContent>\r
 133       <xs:extension base="core:OCIDataResponse">\r
 134         <xs:sequence>\r
 135           <xs:element name="userTable" type="core:OCITable"/>\r
 136         </xs:sequence>\r
 137       </xs:extension>\r
 138     </xs:complexContent>\r
 139   </xs:complexType>    \r
 140     \r
 141   <xs:complexType name="UserBusyLampFieldGetRequest16sp2">\r
 142     <xs:annotation>\r
 143       <xs:documentation>\r
 144         Request the settings for the busy lamp field service.\r
 145         The response is either a UserBusyLampFieldGetResponse16sp2 or an ErrorResponse.\r
 146       </xs:documentation>\r
 147     </xs:annotation>\r
 148     <xs:complexContent>\r
 149       <xs:extension base="core:OCIRequest">\r
 150         <xs:sequence>\r
 151           <xs:element name="userId" type="UserId"/>\r
 152         </xs:sequence>\r
 153       </xs:extension>\r
 154     </xs:complexContent>\r
 155   </xs:complexType>    \r
 156     \r
 157   <xs:complexType name="UserBusyLampFieldGetResponse16sp2">\r
 158     <xs:annotation>\r
 159       <xs:documentation>\r
 160         Response to UserBusyLampFieldGetRequest16sp2.\r
 161         The table has column headings:\r
 162           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 163           "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 164       </xs:documentation>\r
 165     </xs:annotation>\r
 166     <xs:complexContent>\r
 167       <xs:extension base="core:OCIDataResponse">\r
 168         <xs:sequence>\r
 169           <xs:element name="listURI" type="SIPURI" minOccurs="0"/>\r
 170           <xs:element name="enableCallParkNotification" type="xs:boolean"/>\r
 171           <xs:element name="monitoredUserTable" type="core:OCITable"/>\r
 172         </xs:sequence>\r
 173       </xs:extension>\r
 174     </xs:complexContent>\r
 175   </xs:complexType>    \r
 176     \r
 177   <xs:complexType name="UserBusyLampFieldModifyRequest">\r
 178     <xs:annotation>\r
 179       <xs:documentation>\r
 180         Modify the settings for the busy lamp field service.\r
 181         The response is either a SuccessResponse or an ErrorResponse.\r
 182       </xs:documentation>\r
 183     </xs:annotation>\r
 184     <xs:complexContent>\r
 185       <xs:extension base="core:OCIRequest">\r
 186         <xs:sequence>\r
 187           <xs:element name="userId" type="UserId"/>\r
 188           <xs:element name="listURI" type="SIPURI" nillable="true" minOccurs="0"/>\r
 189           <xs:element name="monitoredUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
 190           <xs:element name="enableCallParkNotification" type="xs:boolean" minOccurs="0"/>\r
 191         </xs:sequence>\r
 192       </xs:extension>\r
 193     </xs:complexContent>\r
 194   </xs:complexType>    \r
 195     \r
 196 </xs:schema>\r