share/OCISchemaAS/Services/OCISchemaServiceHotelingGuest.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 <!-- H O T E L I N G   G U E S T  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   <!-- H O T E L I N G   G U E S T    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     UserHotelingGuestGetAvailableUserListRequest    \r
  36     UserHotelingGuestGetRequest14sp4    \r
  37     UserHotelingGuestModifyRequest21    \r
  38     \r
  39   --> \r
  40   \r
  41   <xs:complexType name="UserHotelingGuestGetAvailableUserListRequest">\r
  42     <xs:annotation>\r
  43       <xs:documentation>\r
  44         Get a list of users that can be assigned as Hoteling Guests.\r
  45         The response is either UserHotelingGuestGetAvailableUserListResponse or ErrorResponse.\r
  46       </xs:documentation>\r
  47     </xs:annotation>\r
  48     <xs:complexContent>\r
  49       <xs:extension base="core:OCIRequest">\r
  50         <xs:sequence>\r
  51           <xs:element name="userId" type="UserId"/>\r
  52           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
  53           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
  54           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
  55           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
  56           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
  57           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
  58           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
  59         </xs:sequence>\r
  60       </xs:extension>\r
  61     </xs:complexContent>\r
  62   </xs:complexType>    \r
  63     \r
  64   <xs:complexType name="UserHotelingGuestGetAvailableUserListResponse">\r
  65     <xs:annotation>\r
  66       <xs:documentation>\r
  67         Response to the UserHotelingGuestGetAvailableUserListRequest.\r
  68         Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Association Limit Hours", "Enable Association Limit",\r
  69         "Phone Number", "Extension", "Department", "Email Address".\r
  70       </xs:documentation>\r
  71     </xs:annotation>\r
  72     <xs:complexContent>\r
  73       <xs:extension base="core:OCIDataResponse">\r
  74         <xs:sequence>\r
  75           <xs:element name="hostUserTable" type="core:OCITable"/>\r
  76         </xs:sequence>\r
  77       </xs:extension>\r
  78     </xs:complexContent>\r
  79   </xs:complexType>    \r
  80     \r
  81   <xs:complexType name="UserHotelingGuestGetRequest14sp4">\r
  82     <xs:annotation>\r
  83       <xs:documentation>\r
  84         Request the user level data associated with Hoteling Guest.\r
  85         The response is either a UserHotelingGuestGetResponse14sp4 or an ErrorResponse.\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="userId" type="UserId"/>\r
  92         </xs:sequence>\r
  93       </xs:extension>\r
  94     </xs:complexContent>\r
  95   </xs:complexType>    \r
  96     \r
  97   <xs:complexType name="UserHotelingGuestGetResponse14sp4">\r
  98     <xs:annotation>\r
  99       <xs:documentation>\r
 100         Response to UserHotelingGuestGetRequest14sp4\r
 101       </xs:documentation>\r
 102     </xs:annotation>\r
 103     <xs:complexContent>\r
 104       <xs:extension base="core:OCIDataResponse">\r
 105         <xs:sequence>\r
 106           <xs:element name="isActive" type="xs:boolean"/>\r
 107           <xs:element name="enableAssociationLimit" type="xs:boolean"/>\r
 108           <xs:element name="associationLimitHours" type="HotelingAssociationLimitHours"/>\r
 109           <xs:element name="hostUserId" type="UserId" minOccurs="0"/>\r
 110           <xs:element name="hostLastName" type="LastName" minOccurs="0"/>\r
 111           <xs:element name="hostFirstName" type="FirstName" minOccurs="0"/>\r
 112           <xs:element name="hostAssociationDateTime" type="xs:dateTime" minOccurs="0"/>\r
 113           <xs:element name="hostEnforcesAssociationLimit" type="xs:boolean" minOccurs="0"/>\r
 114           <xs:element name="hostAssociationLimitHours" type="HotelingAssociationLimitHours" minOccurs="0"/>\r
 115         </xs:sequence>\r
 116       </xs:extension>\r
 117     </xs:complexContent>\r
 118   </xs:complexType>    \r
 119     \r
 120   <xs:complexType name="UserHotelingGuestModifyRequest21">\r
 121     <xs:annotation>\r
 122       <xs:documentation>\r
 123         Modify the user level data associated with Hoteling Guest.\r
 124         Provisioning error will be given when setting hostUserId to not nil value while Hoteling Guest feature is not active.\r
 125         The response is either a SuccessResponse or an ErrorResponse.\r
 126       </xs:documentation>\r
 127     </xs:annotation>\r
 128     <xs:complexContent>\r
 129       <xs:extension base="core:OCIRequest">\r
 130         <xs:sequence>\r
 131           <xs:element name="userId" type="UserId"/>\r
 132           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
 133           <xs:element name="enableAssociationLimit" type="xs:boolean" minOccurs="0"/>\r
 134           <xs:element name="associationLimitHours" type="HotelingAssociationLimitHours" minOccurs="0"/>\r
 135           <xs:element name="hostUserId" type="UserId" nillable="true" minOccurs="0"/>\r
 136         </xs:sequence>\r
 137       </xs:extension>\r
 138     </xs:complexContent>\r
 139   </xs:complexType>    \r
 140     \r
 141 </xs:schema>\r