initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceCallTransfer.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 <!-- C A L L   T R A N S F E R  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   <!-- C A L L   T R A N S F E R    R E Q U E S T S  A N D  R E S P O N S E S             -->\r
27   <!-- ********************************************************************************** -->\r
28   <!--\r
29   Requests and responses are listed here in alphabetical order.\r
30   The non-primitive attributes inside the commands are defined in another\r
31   section of the schema.\r
32 \r
33   Requests in this schema file:\r
34     UserCallTransferGetRequest14sp4    \r
35     UserCallTransferModifyRequest    \r
36     \r
37   --> \r
38   \r
39   <xs:complexType name="UserCallTransferGetRequest14sp4">\r
40     <xs:annotation>\r
41       <xs:documentation>\r
42         Request the user level data associated with Call Transfer.\r
43         The response is either a UserCallTransferGetResponse14sp4 or an\r
44         ErrorResponse.\r
45       </xs:documentation>\r
46     </xs:annotation>\r
47     <xs:complexContent>\r
48       <xs:extension base="core:OCIRequest">\r
49         <xs:sequence>\r
50           <xs:element name="userId" type="UserId"/>\r
51         </xs:sequence>\r
52       </xs:extension>\r
53     </xs:complexContent>\r
54   </xs:complexType>    \r
55     \r
56   <xs:complexType name="UserCallTransferGetResponse14sp4">\r
57     <xs:annotation>\r
58       <xs:documentation>\r
59         Response to UserCallTransferGetRequest14sp4.\r
60       </xs:documentation>\r
61     </xs:annotation>\r
62     <xs:complexContent>\r
63       <xs:extension base="core:OCIDataResponse">\r
64         <xs:sequence>\r
65           <xs:element name="isRecallActive" type="xs:boolean"/>\r
66           <xs:element name="recallNumberOfRings" type="CallTransferRecallNumberOfRings"/>\r
67           <xs:element name="useDiversionInhibitorForBlindTransfer" type="xs:boolean"/>\r
68           <xs:element name="useDiversionInhibitorForConsultativeCalls" type="xs:boolean"/>\r
69           <xs:element name="enableBusyCampOn" type="xs:boolean"/>\r
70           <xs:element name="busyCampOnSeconds" type="CallTransferBusyCampOnSeconds"/>\r
71         </xs:sequence>\r
72       </xs:extension>\r
73     </xs:complexContent>\r
74   </xs:complexType>    \r
75     \r
76   <xs:complexType name="UserCallTransferModifyRequest">\r
77     <xs:annotation>\r
78       <xs:documentation>\r
79         Modify the user level data associated with Call Transfer.\r
80         The response is either a SuccessResponse or an ErrorResponse.\r
81       </xs:documentation>\r
82     </xs:annotation>\r
83     <xs:complexContent>\r
84       <xs:extension base="core:OCIRequest">\r
85         <xs:sequence>\r
86           <xs:element name="userId" type="UserId"/>\r
87           <xs:element name="isRecallActive" type="xs:boolean" minOccurs="0"/>\r
88           <xs:element name="recallNumberOfRings" type="CallTransferRecallNumberOfRings" minOccurs="0"/>\r
89           <xs:element name="useDiversionInhibitorForBlindTransfer" type="xs:boolean" minOccurs="0"/>\r
90           <xs:element name="useDiversionInhibitorForConsultativeCalls" type="xs:boolean" minOccurs="0"/>\r
91           <xs:element name="enableBusyCampOn" type="xs:boolean" minOccurs="0"/>\r
92           <xs:element name="busyCampOnSeconds" type="CallTransferBusyCampOnSeconds" minOccurs="0"/>\r
93         </xs:sequence>\r
94       </xs:extension>\r
95     </xs:complexContent>\r
96   </xs:complexType>    \r
97     \r
98   <xs:simpleType name="CallTransferRecallNumberOfRings">\r
99     <xs:annotation>\r
100       <xs:documentation>\r
101         Number of Rings until a transferred call is recalled.\r
102       </xs:documentation>\r
103     </xs:annotation>\r
104     <xs:restriction base="xs:int">\r
105       <xs:minInclusive value="2"/>\r
106       <xs:maxInclusive value="20"/>\r
107     </xs:restriction>\r
108   </xs:simpleType>    \r
109     \r
110   <xs:simpleType name="CallTransferBusyCampOnSeconds">\r
111     <xs:annotation>\r
112       <xs:documentation>\r
113         The allotted time for a call to camp on on busy transefer call.\r
114       </xs:documentation>\r
115     </xs:annotation>\r
116     <xs:restriction base="xs:int">\r
117       <xs:minInclusive value="30"/>\r
118       <xs:maxInclusive value="600"/>\r
119     </xs:restriction>\r
120   </xs:simpleType>    \r
121     \r
122 </xs:schema>\r