initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceSimultaneousRingPersonal.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 <!-- S I M U L T A N E O U S   R I N G   P E R S O N A L  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   \r
25   <!-- ********************************************************************************** -->\r
26   <!-- S I M U L T A N E O U S   R I N G   P E R S O N A L                                -->\r
27   <!-- 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     UserSimultaneousRingPersonalAddCriteriaRequest    \r
36     UserSimultaneousRingPersonalDeleteCriteriaRequest    \r
37     UserSimultaneousRingPersonalGetCriteriaRequest    \r
38     UserSimultaneousRingPersonalGetRequest17    \r
39     UserSimultaneousRingPersonalModifyCriteriaRequest    \r
40     UserSimultaneousRingPersonalModifyRequest17    \r
41     \r
42   --> \r
43   \r
44   <xs:complexType name="UserSimultaneousRingPersonalAddCriteriaRequest">\r
45     <xs:annotation>\r
46       <xs:documentation>\r
47         Add a criteria to the user's simultaneous ring personal service.\r
48         The response is either a SuccessResponse 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:element name="userId" type="UserId"/>\r
55           <xs:element name="criteriaName" type="CriteriaName"/>\r
56           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
57           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
58           <xs:element name="blacklisted" type="xs:boolean"/>\r
59           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
60         </xs:sequence>\r
61       </xs:extension>\r
62     </xs:complexContent>\r
63   </xs:complexType>    \r
64     \r
65   <xs:complexType name="UserSimultaneousRingPersonalDeleteCriteriaRequest">\r
66     <xs:annotation>\r
67       <xs:documentation>\r
68         Delete a criteria from the user's simultaneous ring personal service.\r
69         The response is either a SuccessResponse or an ErrorResponse.\r
70       </xs:documentation>\r
71     </xs:annotation>\r
72     <xs:complexContent>\r
73       <xs:extension base="core:OCIRequest">\r
74         <xs:sequence>\r
75           <xs:element name="userId" type="UserId"/>\r
76           <xs:element name="criteriaName" type="CriteriaName"/>\r
77         </xs:sequence>\r
78       </xs:extension>\r
79     </xs:complexContent>\r
80   </xs:complexType>    \r
81     \r
82   <xs:complexType name="UserSimultaneousRingPersonalGetCriteriaRequest">\r
83     <xs:annotation>\r
84       <xs:documentation>\r
85         Get a criteria for the user's simultaneous ring personal service.\r
86         The response is either a UserSimultaneousRingPersonalGetCriteriaResponse or an ErrorResponse.\r
87       </xs:documentation>\r
88     </xs:annotation>\r
89     <xs:complexContent>\r
90       <xs:extension base="core:OCIRequest">\r
91         <xs:sequence>\r
92           <xs:element name="userId" type="UserId"/>\r
93           <xs:element name="criteriaName" type="CriteriaName"/>\r
94         </xs:sequence>\r
95       </xs:extension>\r
96     </xs:complexContent>\r
97   </xs:complexType>    \r
98     \r
99   <xs:complexType name="UserSimultaneousRingPersonalGetCriteriaResponse">\r
100     <xs:annotation>\r
101       <xs:documentation>\r
102         Response to the UserSimultaneousRingPersonalGetCriteriaRequest.\r
103       </xs:documentation>\r
104     </xs:annotation>\r
105     <xs:complexContent>\r
106       <xs:extension base="core:OCIDataResponse">\r
107         <xs:sequence>\r
108           <xs:element name="timeSchedule" type="TimeSchedule" minOccurs="0"/>\r
109           <xs:element name="holidaySchedule" type="HolidaySchedule" minOccurs="0"/>\r
110           <xs:element name="blacklisted" type="xs:boolean"/>\r
111           <xs:element name="fromDnCriteria" type="CriteriaFromDn"/>\r
112         </xs:sequence>\r
113       </xs:extension>\r
114     </xs:complexContent>\r
115   </xs:complexType>    \r
116     \r
117   <xs:complexType name="UserSimultaneousRingPersonalGetRequest17">\r
118     <xs:annotation>\r
119       <xs:documentation>\r
120         Get the user's simultaneous ring personal service setting.\r
121         The response is either a UserSimultaneousRingPersonalGetResponse17 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:sequence>\r
129       </xs:extension>\r
130     </xs:complexContent>\r
131   </xs:complexType>    \r
132     \r
133   <xs:complexType name="UserSimultaneousRingPersonalGetResponse17">\r
134     <xs:annotation>\r
135       <xs:documentation>\r
136         Response to the UserSimultaneousRingPersonalGetRequest17.\r
137         Contains a criteria table with column heading: "Is Active", "Criteria Name", "Time Schedule", "Holiday Schedule", "Calls From" and "Blacklisted".\r
138       </xs:documentation>\r
139     </xs:annotation>\r
140     <xs:complexContent>\r
141       <xs:extension base="core:OCIDataResponse">\r
142         <xs:sequence>\r
143           <xs:element name="isActive" type="xs:boolean"/>\r
144           <xs:element name="doNotRingIfOnCall" type="xs:boolean"/>\r
145           <xs:element name="simultaneousRingNumber" type="SimultaneousRingNumber" minOccurs="0" maxOccurs="10"/>\r
146           <xs:element name="criteriaTable" type="core:OCITable"/>\r
147         </xs:sequence>\r
148       </xs:extension>\r
149     </xs:complexContent>\r
150   </xs:complexType>    \r
151     \r
152   <xs:complexType name="UserSimultaneousRingPersonalModifyCriteriaRequest">\r
153     <xs:annotation>\r
154       <xs:documentation>\r
155         Modify a criteria for the user's simultaneous ring personal service.\r
156         The response is either a SuccessResponse or an ErrorResponse.\r
157       </xs:documentation>\r
158     </xs:annotation>\r
159     <xs:complexContent>\r
160       <xs:extension base="core:OCIRequest">\r
161         <xs:sequence>\r
162           <xs:element name="userId" type="UserId"/>\r
163           <xs:element name="criteriaName" type="CriteriaName"/>\r
164           <xs:element name="newCriteriaName" type="CriteriaName" minOccurs="0"/>\r
165           <xs:element name="timeSchedule" type="TimeSchedule" nillable="true" minOccurs="0"/>\r
166           <xs:element name="holidaySchedule" type="HolidaySchedule" nillable="true" minOccurs="0"/>\r
167           <xs:element name="blacklisted" type="xs:boolean" minOccurs="0"/>\r
168           <xs:element name="fromDnCriteria" type="CriteriaFromDnModify" minOccurs="0"/>\r
169         </xs:sequence>\r
170       </xs:extension>\r
171     </xs:complexContent>\r
172   </xs:complexType>    \r
173     \r
174   <xs:complexType name="UserSimultaneousRingPersonalModifyRequest17">\r
175     <xs:annotation>\r
176       <xs:documentation>\r
177         Modify the user's simultaneous ring personal service setting.\r
178         The response is either a SuccessResponse or an ErrorResponse.\r
179       </xs:documentation>\r
180     </xs:annotation>\r
181     <xs:complexContent>\r
182       <xs:extension base="core:OCIRequest">\r
183         <xs:sequence>\r
184           <xs:element name="userId" type="UserId"/>\r
185           <xs:element name="isActive" type="xs:boolean" minOccurs="0"/>\r
186           <xs:element name="doNotRingIfOnCall" type="xs:boolean" minOccurs="0"/>\r
187           <xs:element name="simultaneousRingNumberList" type="SimultaneousRingReplacementNumberList" nillable="true" minOccurs="0"/>\r
188           <xs:element name="criteriaActivation" type="CriteriaActivation" minOccurs="0" maxOccurs="unbounded"/>\r
189         </xs:sequence>\r
190       </xs:extension>\r
191     </xs:complexContent>\r
192   </xs:complexType>    \r
193     \r
194 </xs:schema>\r