XML Schema
DOCSCurrent
Last updated: Aug 15th, 7:56am
XML Schema
This appendix contains the XML Reporting 1.0 schema.
1<?xml version="1.0" encoding="UTF-8"?>2<xs:schema elementFormDefault="qualified" attributeFormDefault="unqualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">3 <xs:element name="reportingEngineRequest"><br />4 <xs:complexType>5 <xs:sequence>6 <xs:element name="authRequest">7 <xs:complexType>8 <xs:sequence>9 <xs:element name="user" type="xs:string"/>10 <xs:element name="vendor" type="xs:string"/>11 <xs:element name="partner" type="xs:string"/>12 <xs:element name="password" type="xs:string"/>13 <xs:element name="executor" type="xs:string" minOccurs="0"/>14 </xs:sequence>15 </xs:complexType>16 </xs:element>17 <xs:choice>18 <xs:element name="createTemplateRequest">19 <xs:complexType>20 <xs:sequence>21 <xs:element ref="templateDefinition"/>22 </xs:sequence>23 </xs:complexType>24 </xs:element>25 <xs:element name="getTemplateRequest">26 <xs:complexType>27 <xs:choice>28 <xs:element ref="reportName"/>29 <xs:element ref="templateName"/>30 </xs:choice>31 </xs:complexType>32 </xs:element>33 <xs:element name="updateTemplateRequest">34 <xs:complexType>35 <xs:sequence>36 <xs:element ref="templateDefinition"/>37 </xs:sequence>38 </xs:complexType>39 </xs:element>40 <xs:element name="deleteTemplateRequest">41 <xs:complexType>42 <xs:sequence>43 <xs:element ref="templateName"/>44 </xs:sequence>45 </xs:complexType>46 </xs:element>47 <xs:element name="createScheduleRequest">48 <xs:complexType>49 <xs:sequence>50 <xs:element ref="scheduleDefinition"/>51 </xs:sequence>52 </xs:complexType>53 </xs:element>54 <xs:element name="getScheduleRequest">55 <xs:complexType>56 <xs:choice>57 <xs:element ref="scheduleName"/>58 <xs:element ref="templateName"/>59 </xs:choice>60 </xs:complexType>61 </xs:element>62 <xs:element name="updateScheduleRequest">63 <xs:complexType>64 <xs:sequence>65 <xs:element ref="scheduleDefinition"/>66 </xs:sequence>67 </xs:complexType>68 </xs:element>69 <xs:element name="deleteScheduleRequest">70 <xs:complexType>71 <xs:sequence>72 <xs:element ref="scheduleName"/>73 </xs:sequence>74 </xs:complexType>75 </xs:element>76 <xs:element name="runReportRequest">77 <xs:complexType>78 <xs:sequence>79 <xs:choice>80 <xs:element ref="reportName"/>81 <xs:element ref="templateName"/>82 </xs:choice>83 <xs:element ref="reportParam" minOccurs="0"84 maxOccurs="unbounded"/>85 <xs:element ref="notificationRequired" minOccurs="0"/>86 <xs:element ref="pageSize" minOccurs="0"/>87 </xs:sequence>88 </xs:complexType>89 </xs:element>90 <xs:element name="runSearchRequest">91 <xs:complexType>92 <xs:sequence>93 <xs:element ref="searchName"/>94 <xs:element ref="reportParam" minOccurs="0" maxOccurs="unbounded"/>95 <xs:element ref="pageSize" minOccurs="0"/>96 </xs:sequence>97 </xs:complexType>98 </xs:element>99 <xs:element name="getResultsRequest">100 <xs:complexType>101 <xs:sequence>102 <xs:choice minOccurs="0">103 <xs:element ref="scheduleName"/>104 <xs:element ref="templateName"/>105 <xs:element ref="reportName"/>106 <xs:element ref="searchName"/>107 <xs:element ref="reportId"/>108 </xs:choice>109 <xs:choice minOccurs="0">110 <xs:complexType>111 <xs:sequence>112 <xs:element name="startDate"type="xs:date"/>113 <xs:element name="endDate" type="xs:date"/>114 </xs:sequence>115 </xs:complexType>116 </xs:choice>117 </xs:sequence>118 </xs:complexType>119 </xs:element>120 <xs:element name="getMetaDataRequest">121 <xs:complexType>122 <xs:sequence>123 <xs:element ref="reportId"/>124 </xs:sequence>125 </xs:complexType>126 </xs:element>127 <xs:element name="getDataRequest">128 <xs:complexType>129 <xs:sequence>130 <xs:element ref="reportId"/>131 <xs:element ref="pageNum" minOccurs="0"/>132 </xs:sequence>133 </xs:complexType>134 </xs:element>135 </xs:choice>136 </xs:sequence>137 </xs:complexType>138 </xs:element>139 <xs:element name="reportingEngineResponse">140 <xs:complexType>141 <xs:sequence>142 <xs:element name="baseResponse">143 <xs:complexType>144 <xs:sequence>145 <xs:element name="responseCode" type="xs:int"/>146 <xs:element name="responseMsg" type="xs:string"/>147 </xs:sequence>148 </xs:complexType>149 </xs:element>150 <xs:choice minOccurs="0">151 <xs:element name="getTemplateResponse">152 <xs:complexType>153 <xs:choice>154 <xs:element ref="templateName" maxOccurs="unbounded"/>155 <xs:element ref="templateDefinition"/>156 </xs:choice>157 </xs:complexType>158 </xs:element>159 <xs:element name="getScheduleResponse">160 <xs:complexType>161 <xs:choice>162 <xs:element ref="scheduleName" maxOccurs="unbounded"/>163 <xs:element ref="scheduleDefinition"/>164 </xs:choice>165 </xs:complexType>166 </xs:element>167 <xs:element name="runReportResponse">168 <xs:complexType>169 <xs:sequence>170 <xs:element ref="reportId"/>171 <xs:element ref="statusCode"/>172 <xs:element ref="statusMsg"/>173 </xs:sequence>174 </xs:complexType>175 </xs:element>176 <xs:element name="runSearchResponse">177 <xs:complexType>178 <xs:sequence>179 <xs:element ref="reportId"/>180 <xs:element ref="statusCode"/>181 <xs:element ref="statusMsg"/>182 </xs:sequence>183 </xs:complexType>184 </xs:element>185 <xs:element name="getResultsResponse">186 <xs:complexType>187 <xs:sequence>188 <xs:element name="Results" minOccurs="0" maxOccurs="unbounded">189 <xs:complexType>190 <xs:sequence>191 <xs:element ref="reportId"/>192 <xs:element ref="statusCode"/>193 <xs:element ref="statusMsg"/>194 <xs:element name="executionTime" type="xs:dateTime"195 minOccurs="0"/>196 <xs:element ref="scheduleName" minOccurs="0"/>197 <xs:element ref="reportName" minOccurs="0"/>198 <xs:element ref="templateName" minOccurs="0"/>199 <xs:element ref="searchName" minOccurs="0"/>200 </xs:sequence>201 </xs:complexType>202 </xs:element>203 </xs:sequence>204 </xs:complexType>205 </xs:element>206 <xs:element name="getMetaDataResponse">207 <xs:complexType>208 <xs:sequence>209 <xs:element name="numberOfRows" type="xs:int"/>210 <xs:element name="numberOfPages" type="xs:int"/>211 <xs:element ref="pageSize"/>212 <xs:element name="numberOfColumns" type="xs:int"/>213 <xs:element name="columnMetaData" minOccurs="0"214 maxOccurs="unbounded">215 <xs:complexType>216 <xs:sequence>217 <xs:element name="dataName" type="xs:string"/>218 <xs:element name="dataType">219 <xs:simpleType>220 <xs:restriction base="xs:string">221 <xs:enumeration value="string"/>222 <xs:enumeration value="number"/>223 <xs:enumeration value="date"/>224 <xs:enumeration value="currency"/>225 </xs:restriction>226 </xs:simpleType>227 </xs:element>228 </xs:sequence>229 </xs:complexType>230 </xs:element>231 </xs:sequence>232 </xs:complexType>233 </xs:element>234 <xs:element name="getDataResponse">235 <xs:complexType>236 <xs:sequence>237 <xs:element name="reportDataRow" maxOccurs="unbounded">238 <xs:complexType>239 <xs:sequence>240 <xs:element name="columnData" maxOccurs="unbounded">241 <xs:complexType>242 <xs:sequence>243 <xs:element name="data" type="xs:string" minOccurs="0"/>244 </xs:sequence>245 </xs:complexType>246 </xs:element>247 </xs:sequence>248 </xs:complexType>249 </xs:element>250 <xs:element ref="pageNum"/>251 </xs:sequence>252 </xs:complexType>253 </xs:element>254 </xs:choice>255 </xs:sequence>256 </xs:complexType>257 </xs:element>258 <xs:element name="reportDefinition">259 <xs:complexType>260 <xs:sequence/>261 </xs:complexType>262 </xs:element>263 <xs:element name="reportId" type="xs:string"/>264 <xs:element name="paramName" type="xs:string"/>265 <xs:element name="paramValue" type="xs:string"/>266 <xs:element name="templateName" type="xs:string"/>267 <xs:element name="reportName" type="xs:string"/>268 <xs:element name="reportParam">269 <xs:complexType>270 <xs:sequence>271 <xs:element ref="paramName"/>272 <xs:element ref="paramValue"/>273 </xs:sequence>274 </xs:complexType>275 </xs:element>276 <xs:element name="templateDefinition">277 <xs:complexType>278 <xs:sequence>279 <xs:element ref="templateName"/>280 <xs:element ref="reportName"/>281 <xs:element ref="reportParam" minOccurs="0" maxOccurs="unbounded"/>282 </xs:sequence>283 </xs:complexType>284 </xs:element>285 <xs:element name="notificationRequired" type="xs:boolean"/>286 <xs:element name="scheduleDefinition">287 <xs:complexType>288 <xs:sequence>289 <xs:element ref="scheduleName"/>290 <xs:element ref="templateName"/>291 <xs:element ref="notificationRequired"/>292 <xs:choice>293 <xs:element name="daily">294 <xs:complexType/>295 </xs:element>296 <xs:element name="weekly">297 <xs:complexType>298 <xs:sequence>299 <xs:element name="dayOfWeek">300 <xs:simpleType>301 <xs:restriction base="xs:string">302 <xs:enumeration value="Sunday"/>303 <xs:enumeration value="Monday"/>304 <xs:enumeration value="Tuesday"/>305 <xs:enumeration value="Wednesday"/>306 <xs:enumeration value="Thursday"/>307 <xs:enumeration value="Friday"/>308 <xs:enumeration value="Saturday"/>309 </xs:restriction>310 </xs:simpleType>311 </xs:element>312 </xs:sequence>313 </xs:complexType>314 </xs:element>315 <xs:element name="monthly">316 <xs:complexType>317 <xs:sequence>318 <xs:element name="dayOfMonth" type="xs:int"/>319 </xs:sequence>320 </xs:complexType>321 </xs:element>322 </xs:choice>323 <xs:element ref="pageSize" minOccurs="0"/>324 </xs:sequence>325 </xs:complexType>326 </xs:element>327 <xs:element name="scheduleName" type="xs:string"/>328 <xs:element name="pageNum" type="xs:int"/>329 <xs:element name="searchName" type="xs:string"/>330 <xs:element name="pageSize" type="xs:int"/>331 <xs:element name="statusCode" type="xs:int"/>332 <xs:element name="statusMsg" type="xs:string"/>333</xs:schema>