share/OCISchemaAS/Services/OCISchemaServicePushToTalk.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 U S H   T O   T A L K  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 U S H   T O   T A L K    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     UserPushToTalkGetAvailableUserListRequest    \r
  36     UserPushToTalkGetRequest    \r
  37     UserPushToTalkModifyRequest    \r
  38     \r
  39   --> \r
  40   \r
  41   <xs:complexType name="UserPushToTalkGetAvailableUserListRequest">\r
  42     <xs:annotation>\r
  43       <xs:documentation>\r
  44         Get a list of available users for the push to talk service.\r
  45         The response is either UserPushToTalkGetAvailableUserListResponse 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="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>\r
  57           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
  58           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
  59           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
  60           <xs:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
  61         </xs:sequence>\r
  62       </xs:extension>\r
  63     </xs:complexContent>\r
  64   </xs:complexType>    \r
  65     \r
  66   <xs:complexType name="UserPushToTalkGetAvailableUserListResponse">\r
  67     <xs:annotation>\r
  68       <xs:documentation>\r
  69         Response to the UserPushToTalkGetAvailableUserListRequest.\r
  70         Returns a 10 column table with column headings:\r
  71           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
  72           "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
  73       </xs:documentation>\r
  74     </xs:annotation>\r
  75     <xs:complexContent>\r
  76       <xs:extension base="core:OCIDataResponse">\r
  77         <xs:sequence>\r
  78           <xs:element name="userTable" type="core:OCITable"/>\r
  79         </xs:sequence>\r
  80       </xs:extension>\r
  81     </xs:complexContent>\r
  82   </xs:complexType>    \r
  83     \r
  84   <xs:complexType name="UserPushToTalkGetRequest">\r
  85     <xs:annotation>\r
  86       <xs:documentation>\r
  87         Request the push to talk service setting.\r
  88         The response is either a UserPushToTalkGetResponse or an ErrorResponse.\r
  89       </xs:documentation>\r
  90     </xs:annotation>\r
  91     <xs:complexContent>\r
  92       <xs:extension base="core:OCIRequest">\r
  93         <xs:sequence>\r
  94           <xs:element name="userId" type="UserId"/>\r
  95         </xs:sequence>\r
  96       </xs:extension>\r
  97     </xs:complexContent>\r
  98   </xs:complexType>    \r
  99     \r
 100   <xs:complexType name="UserPushToTalkGetResponse">\r
 101     <xs:annotation>\r
 102       <xs:documentation>\r
 103         Response to UserPushToTalkGetRequest.  It returns the service settings and a\r
 104         9 column selected user table with the following column headings:\r
 105           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name",\r
 106           "Phone Number", "Extension", "Department", "Email Address", "IMP Id".\r
 107       </xs:documentation>\r
 108     </xs:annotation>\r
 109     <xs:complexContent>\r
 110       <xs:extension base="core:OCIDataResponse">\r
 111         <xs:sequence>\r
 112           <xs:element name="allowAutoAnswer" type="xs:boolean"/>\r
 113           <xs:element name="outgoingConnectionSelection" type="PushToTalkOutgoingConnectionSelection"/>\r
 114           <xs:element name="accessListSelection" type="PushToTalkAccessListSelection"/>\r
 115           <xs:element name="selectedUserTable" type="core:OCITable"/>\r
 116         </xs:sequence>\r
 117       </xs:extension>\r
 118     </xs:complexContent>\r
 119   </xs:complexType>    \r
 120     \r
 121   <xs:complexType name="UserPushToTalkModifyRequest">\r
 122     <xs:annotation>\r
 123       <xs:documentation>\r
 124         Change the push to talk service settings.\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="allowAutoAnswer" type="xs:boolean" minOccurs="0"/>\r
 133           <xs:element name="outgoingConnectionSelection" type="PushToTalkOutgoingConnectionSelection" minOccurs="0"/>\r
 134           <xs:element name="accessListSelection" type="PushToTalkAccessListSelection" minOccurs="0"/>\r
 135           <xs:element name="selectedUserIdList" type="ReplacementUserIdList" 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:simpleType name="PushToTalkOutgoingConnectionSelection">\r
 142     <xs:annotation>\r
 143       <xs:documentation>\r
 144         Push to talk outgoing connection type.\r
 145       </xs:documentation>\r
 146     </xs:annotation>\r
 147     <xs:restriction base="xs:token">\r
 148       <xs:enumeration value="One Way"/>\r
 149       <xs:enumeration value="Two Way"/>\r
 150     </xs:restriction>\r
 151   </xs:simpleType>    \r
 152     \r
 153   <xs:simpleType name="PushToTalkAccessListSelection">\r
 154     <xs:annotation>\r
 155       <xs:documentation>\r
 156         Push to talk access list.\r
 157       </xs:documentation>\r
 158     </xs:annotation>\r
 159     <xs:restriction base="xs:token">\r
 160       <xs:enumeration value="Allow Calls From Selected Users"/>\r
 161       <xs:enumeration value="Allow Calls From Everyone Except Selected Users"/>\r
 162     </xs:restriction>\r
 163   </xs:simpleType>    \r
 164     \r
 165 </xs:schema>\r