initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceDirectoryNumberHunting.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 <!-- D I R E C T O R Y   N U M B E R   H U N T I N G  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   <!-- D I R E C T O R Y   N U M B E R   H U N T I N G                                    -->\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     GroupDirectoryNumberHuntingGetAvailableUserListRequest    \r
36     GroupDirectoryNumberHuntingGetRequest17sp1    \r
37     GroupDirectoryNumberHuntingModifyRequest    \r
38     \r
39   --> \r
40   \r
41   <xs:complexType name="GroupDirectoryNumberHuntingGetAvailableUserListRequest">\r
42     <xs:annotation>\r
43       <xs:documentation>\r
44         Request to get the agents of a call center or hunt group that are available\r
45         to be assigned to a directory number hunting group.  They are agents that\r
46         are not already assigned to any other directory number hunting group.\r
47         The response is either\r
48         GroupDirectoryNumberHuntingGetAvailableUserListResponse or 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="serviceUserId" type="UserId"/>\r
55         </xs:sequence>\r
56       </xs:extension>\r
57     </xs:complexContent>\r
58   </xs:complexType>    \r
59     \r
60   <xs:complexType name="GroupDirectoryNumberHuntingGetAvailableUserListResponse">\r
61     <xs:annotation>\r
62       <xs:documentation>\r
63         Response to the GroupDirectoryNumberHuntingGetAvailableUserListRequest.\r
64         Contains a table with column headings: "User Id", "Last Name",\r
65         "First Name", "Hiragana Last Name", "Hiragana First Name",\r
66         "Phone Number", "Extension", "Department", "Email Address".\r
67       </xs:documentation>\r
68     </xs:annotation>\r
69     <xs:complexContent>\r
70       <xs:extension base="core:OCIDataResponse">\r
71         <xs:sequence>\r
72           <xs:element name="userTable" type="core:OCITable"/>\r
73         </xs:sequence>\r
74       </xs:extension>\r
75     </xs:complexContent>\r
76   </xs:complexType>    \r
77     \r
78   <xs:complexType name="GroupDirectoryNumberHuntingGetRequest17sp1">\r
79     <xs:annotation>\r
80       <xs:documentation>\r
81         Request to get the properties of the DNH service for a specified serviceUserId.\r
82         It gets the agents of a call center or hunt group that are members\r
83         of a directory number hunting group.  They are agents that are not already\r
84         assigned to any other directory number hunting group.\r
85         The response is either GroupDirectoryNumberHuntingGetResponse or ErrorResponse.\r
86       </xs:documentation>\r
87     </xs:annotation>\r
88     <xs:complexContent>\r
89       <xs:extension base="core:OCIRequest">\r
90         <xs:sequence>\r
91           <xs:element name="serviceUserId" type="UserId"/>\r
92         </xs:sequence>\r
93       </xs:extension>\r
94     </xs:complexContent>\r
95   </xs:complexType>    \r
96     \r
97   <xs:complexType name="GroupDirectoryNumberHuntingGetResponse17sp1">\r
98     <xs:annotation>\r
99       <xs:documentation>\r
100         Response to the GroupDirectoryNumberHuntingGetRequest.\r
101         Contains a table with column headings: "User Id", "Last Name",\r
102         "First Name", "Hiragana Last Name", "Hiragana First Name",\r
103         "Phone Number", "Extension", "Department", "Email Address".\r
104       </xs:documentation>\r
105     </xs:annotation>\r
106     <xs:complexContent>\r
107       <xs:extension base="core:OCIDataResponse">\r
108         <xs:sequence>\r
109           <xs:element name="agentUserTable" type="core:OCITable"/>\r
110           <xs:element name="useTerminateCallToAgentFirst" type="xs:boolean"/>\r
111           <xs:element name="useOriginalAgentServicesForBusyAndNoAnswerCalls" type="xs:boolean"/>\r
112         </xs:sequence>\r
113       </xs:extension>\r
114     </xs:complexContent>\r
115   </xs:complexType>    \r
116     \r
117   <xs:complexType name="GroupDirectoryNumberHuntingModifyRequest">\r
118     <xs:annotation>\r
119       <xs:documentation>\r
120         Replaces a list of users as agents for a directory number hunting group.\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="serviceUserId" type="UserId"/>\r
128           <xs:element name="agentUserIdList" type="ReplacementUserIdList" nillable="true" minOccurs="0"/>\r
129           <xs:element name="useTerminateCallToAgentFirst" type="xs:boolean" minOccurs="0"/>\r
130           <xs:element name="useOriginalAgentServicesForBusyAndNoAnswerCalls" type="xs:boolean" 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