initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceReceptionistOffice.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   O F F I C 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   O F F I C 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     UserBroadWorksReceptionistOfficeGetAvailableUserListRequest    \r
36     UserBroadWorksReceptionistOfficeGetRequest    \r
37     UserBroadWorksReceptionistOfficeModifyRequest    \r
38     \r
39   --> \r
40   \r
41   <xs:complexType name="UserBroadWorksReceptionistOfficeGetAvailableUserListRequest">\r
42     <xs:annotation>\r
43       <xs:documentation>\r
44         Get the Receptionist Office available user list.\r
45         The response is either UserBroadWorksReceptionistOfficeGetAvailableUserListResponse 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:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
60         </xs:sequence>\r
61       </xs:extension>\r
62     </xs:complexContent>\r
63   </xs:complexType>    \r
64     \r
65   <xs:complexType name="UserBroadWorksReceptionistOfficeGetAvailableUserListResponse">\r
66     <xs:annotation>\r
67       <xs:documentation>\r
68         Response to the UserBroadWorksReceptionistOfficeGetAvailableUserListRequest.\r
69         Returns a 12 column table with column headings:\r
70           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", \r
71           "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id".\r
72       </xs:documentation>\r
73     </xs:annotation>\r
74     <xs:complexContent>\r
75       <xs:extension base="core:OCIDataResponse">\r
76         <xs:sequence>\r
77           <xs:element name="userTable" type="core:OCITable"/>\r
78         </xs:sequence>\r
79       </xs:extension>\r
80     </xs:complexContent>\r
81   </xs:complexType>    \r
82     \r
83   <xs:complexType name="UserBroadWorksReceptionistOfficeGetRequest">\r
84     <xs:annotation>\r
85       <xs:documentation>\r
86         Request the Receptionist Office parameters.\r
87         The response is either a UserBroadWorksReceptionistOfficeGetResponse or an ErrorResponse.\r
88       </xs:documentation>\r
89     </xs:annotation>\r
90     <xs:complexContent>\r
91       <xs:extension base="core:OCIRequest">\r
92         <xs:sequence>\r
93           <xs:element name="userId" type="UserId"/>\r
94         </xs:sequence>\r
95       </xs:extension>\r
96     </xs:complexContent>\r
97   </xs:complexType>    \r
98     \r
99   <xs:complexType name="UserBroadWorksReceptionistOfficeGetResponse">\r
100     <xs:annotation>\r
101       <xs:documentation>\r
102         Response to UserBroadWorksReceptionistOfficeGetRequest.\r
103         Returns a 11 column table with column headings:\r
104           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", \r
105           "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id".\r
106       </xs:documentation>\r
107     </xs:annotation>\r
108     <xs:complexContent>\r
109       <xs:extension base="core:OCIDataResponse">\r
110         <xs:sequence>\r
111           <xs:element name="monitoredUserTable" type="core:OCITable"/>\r
112         </xs:sequence>\r
113       </xs:extension>\r
114     </xs:complexContent>\r
115   </xs:complexType>    \r
116     \r
117   <xs:complexType name="UserBroadWorksReceptionistOfficeModifyRequest">\r
118     <xs:annotation>\r
119       <xs:documentation>\r
120         Replace the Receptionist Office monitored user list.\r
121         The response is either a SuccessResponse or an ErrorResponse.\r
122       </xs:documentation>\r
123     </xs:annotation>\r
124     <xs:complexContent>\r
125       <xs:extension base="core:OCIRequest">\r
126         <xs:sequence>\r
127           <xs:element name="userId" type="UserId"/>\r
128           <xs:element name="monitoredUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
129         </xs:sequence>\r
130       </xs:extension>\r
131     </xs:complexContent>\r
132   </xs:complexType>    \r
133     \r
134 </xs:schema>\r