initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceReceptionistSmallBusiness.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   S M A L L   B U S I N E S S  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   S M A L L   B U S I N E S S                              -->\r
28   <!-- R E Q U E S T S  A N D  R E S P O N S E S                                          -->\r
29   <!-- ********************************************************************************** -->\r
30   <!--\r
31   Requests and responses are listed here in alphabetical order.\r
32   The non-primitive attributes inside the commands are defined in another\r
33   section of the schema.\r
34 \r
35   Requests in this schema file:\r
36     UserBroadWorksReceptionistSmallBusinessGetAvailableUserListRequest    \r
37     UserBroadWorksReceptionistSmallBusinessGetRequest    \r
38     UserBroadWorksReceptionistSmallBusinessModifyRequest    \r
39     \r
40   --> \r
41   \r
42   <xs:complexType name="UserBroadWorksReceptionistSmallBusinessGetAvailableUserListRequest">\r
43     <xs:annotation>\r
44       <xs:documentation>\r
45         Get a list of available users for the Receptionist Small Business service.\r
46         The response is either UserBroadWorksReceptionistSmallBusinessGetAvailableUserListResponse or ErrorResponse.\r
47       </xs:documentation>\r
48     </xs:annotation>\r
49     <xs:complexContent>\r
50       <xs:extension base="core:OCIRequest">\r
51         <xs:sequence>\r
52           <xs:element name="userId" type="UserId"/>\r
53           <xs:element name="responseSizeLimit" type="ResponseSizeLimit" minOccurs="0"/>\r
54           <xs:element name="searchCriteriaUserLastName" type="SearchCriteriaUserLastName" minOccurs="0" maxOccurs="unbounded"/>\r
55           <xs:element name="searchCriteriaUserFirstName" type="SearchCriteriaUserFirstName" minOccurs="0" maxOccurs="unbounded"/>\r
56           <xs:element name="searchCriteriaExactUserDepartment" type="SearchCriteriaExactUserDepartment" minOccurs="0"/>\r
57           <xs:element name="searchCriteriaExactUserGroup" type="SearchCriteriaExactUserGroup" minOccurs="0"/>\r
58           <xs:element name="searchCriteriaUserId" type="SearchCriteriaUserId" minOccurs="0" maxOccurs="unbounded"/>\r
59           <xs:element name="searchCriteriaDn" type="SearchCriteriaDn" minOccurs="0" maxOccurs="unbounded"/>\r
60           <xs:element name="searchCriteriaExtension" type="SearchCriteriaExtension" minOccurs="0" maxOccurs="unbounded"/>\r
61           <xs:element name="searchCriteriaImpId" type="SearchCriteriaImpId" minOccurs="0" maxOccurs="unbounded"/>\r
62         </xs:sequence>\r
63       </xs:extension>\r
64     </xs:complexContent>\r
65   </xs:complexType>    \r
66     \r
67   <xs:complexType name="UserBroadWorksReceptionistSmallBusinessGetAvailableUserListResponse">\r
68     <xs:annotation>\r
69       <xs:documentation>\r
70         Response to the UserBroadWorksReceptionistSmallBusinessGetAvailableUserListRequest.\r
71         Returns a 11 column table with column headings:\r
72           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", \r
73           "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id".\r
74       </xs:documentation>\r
75     </xs:annotation>\r
76     <xs:complexContent>\r
77       <xs:extension base="core:OCIDataResponse">\r
78         <xs:sequence>\r
79           <xs:element name="userTable" type="core:OCITable"/>\r
80         </xs:sequence>\r
81       </xs:extension>\r
82     </xs:complexContent>\r
83   </xs:complexType>    \r
84     \r
85   <xs:complexType name="UserBroadWorksReceptionistSmallBusinessGetRequest">\r
86     <xs:annotation>\r
87       <xs:documentation>\r
88         Request the Receptionist Small Business parameters.\r
89         The response is either a UserBroadWorksReceptionistSmallBusinessGetResponse or an ErrorResponse.\r
90       </xs:documentation>\r
91     </xs:annotation>\r
92     <xs:complexContent>\r
93       <xs:extension base="core:OCIRequest">\r
94         <xs:sequence>\r
95           <xs:element name="userId" type="UserId"/>\r
96         </xs:sequence>\r
97       </xs:extension>\r
98     </xs:complexContent>\r
99   </xs:complexType>    \r
100     \r
101   <xs:complexType name="UserBroadWorksReceptionistSmallBusinessGetResponse">\r
102     <xs:annotation>\r
103       <xs:documentation>\r
104         Response to UserBroadWorksReceptionistSmallBusinessGetRequest.\r
105         Returns a 12 column table with column headings:\r
106           "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", \r
107           "Group Id", "Phone Number", "Extension", "Mobile", "Email Address", "Department", "IMP Id".\r
108       </xs:documentation>\r
109     </xs:annotation>\r
110     <xs:complexContent>\r
111       <xs:extension base="core:OCIDataResponse">\r
112         <xs:sequence>\r
113           <xs:element name="monitoredUserTable" type="core:OCITable"/>\r
114         </xs:sequence>\r
115       </xs:extension>\r
116     </xs:complexContent>\r
117   </xs:complexType>    \r
118     \r
119   <xs:complexType name="UserBroadWorksReceptionistSmallBusinessModifyRequest">\r
120     <xs:annotation>\r
121       <xs:documentation>\r
122         Replace the Receptionist Small Business monitored user list.\r
123         The response is either a SuccessResponse or an ErrorResponse.\r
124       </xs:documentation>\r
125     </xs:annotation>\r
126     <xs:complexContent>\r
127       <xs:extension base="core:OCIRequest">\r
128         <xs:sequence>\r
129           <xs:element name="userId" type="UserId"/>\r
130           <xs:element name="monitoredUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
131         </xs:sequence>\r
132       </xs:extension>\r
133     </xs:complexContent>\r
134   </xs:complexType>    \r
135     \r
136 </xs:schema>\r