initial commit
[BroadWorks-OCI.git] / share / OCISchemaAS / Services / OCISchemaServiceInventoryReport.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 <!-- I N V E N T O R Y   R E P O R T  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   <!-- I N V E N T O R Y   R E P O R T    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     GroupInventoryReportGetRequest    \r
35     SystemInventoryReportGetRequest    \r
36     SystemInventoryReportModifyRequest    \r
37     \r
38   --> \r
39   \r
40   <xs:complexType name="GroupInventoryReportGetRequest">\r
41     <xs:annotation>\r
42       <xs:documentation>\r
43         Request the group's inventory report.\r
44         The response is either a GroupInventoryReportGetResponse or an 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="serviceProviderId" type="ServiceProviderId"/>\r
51           <xs:element name="groupId" type="GroupId"/>\r
52           <xs:element name="includeUsers" type="xs:boolean"/>\r
53           <xs:element name="includeServices" type="xs:boolean"/>\r
54           <xs:element name="includeDns" type="xs:boolean"/>\r
55           <xs:element name="includeAccessDevices" type="xs:boolean"/>\r
56           <xs:element name="includeDepartments" type="xs:boolean"/>\r
57           <xs:element name="reportDeliveryEmailAddress" type="EmailAddress" minOccurs="0"/>\r
58         </xs:sequence>\r
59       </xs:extension>\r
60     </xs:complexContent>\r
61   </xs:complexType>    \r
62     \r
63   <xs:complexType name="GroupInventoryReportGetResponse">\r
64     <xs:annotation>\r
65       <xs:documentation>\r
66         Response to GroupInventoryReportGetRequest.\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="inventoryReportTable" 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="SystemInventoryReportGetRequest">\r
79     <xs:annotation>\r
80       <xs:documentation>\r
81         Request the system level data associated with Inventory Report.\r
82         The response is either a SystemInventoryReportGetResponse or an\r
83         ErrorResponse.\r
84       </xs:documentation>\r
85     </xs:annotation>\r
86     <xs:complexContent>\r
87       <xs:extension base="core:OCIRequest">\r
88         <xs:sequence/>\r
89       </xs:extension>\r
90     </xs:complexContent>\r
91   </xs:complexType>    \r
92     \r
93   <xs:complexType name="SystemInventoryReportGetResponse">\r
94     <xs:annotation>\r
95       <xs:documentation>\r
96         Response to SystemInventoryReportGetRequest.\r
97       </xs:documentation>\r
98     </xs:annotation>\r
99     <xs:complexContent>\r
100       <xs:extension base="core:OCIDataResponse">\r
101         <xs:sequence>\r
102           <xs:element name="defaultFromAddress" type="EmailAddress"/>\r
103         </xs:sequence>\r
104       </xs:extension>\r
105     </xs:complexContent>\r
106   </xs:complexType>    \r
107     \r
108   <xs:complexType name="SystemInventoryReportModifyRequest">\r
109     <xs:annotation>\r
110       <xs:documentation>\r
111         Modify the system level data associated with Inventory Report.\r
112         The response is either a SuccessResponse or an ErrorResponse.\r
113       </xs:documentation>\r
114     </xs:annotation>\r
115     <xs:complexContent>\r
116       <xs:extension base="core:OCIRequest">\r
117         <xs:sequence>\r
118           <xs:element name="defaultFromAddress" type="EmailAddress" minOccurs="0"/>\r
119         </xs:sequence>\r
120       </xs:extension>\r
121     </xs:complexContent>\r
122   </xs:complexType>    \r
123     \r
124 </xs:schema>\r