epb_view_models 1.0.29 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.ruby-version +1 -1
- data/Gemfile.lock +24 -24
- data/api/schemas/data/orchestrate.json +4 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/ExternalDefinitions.xml +1735 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/ExternalDefinitions.xsd +313 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/AssessorManagement.xsd +275 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/EPC-Certificate.xsd +632 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/ExceptionList.xsd +20 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/Property.xsd +85 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/ReportList.xsd +27 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/SAP-CollectedData.xsd +2500 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/SAP-Compliance-Report.xsd +51 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/Templates/SAP-Report.xsd +277 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/UDT/EPC-Domains.xsd +646 -0
- data/api/schemas/xml/SAP-Schema-19.1.0/SAP/UDT/SAP-Domains.xsd +3421 -0
- data/epb_view_models.gemspec +2 -2
- data/lib/epb_view_models.rb +1 -1
- data/lib/helper/xml_enums_to_output.rb +2 -0
- data/lib/view_model/factory.rb +1 -0
- data/lib/view_model/sap_schema_1910/common_schema.rb +618 -0
- data/lib/view_model/sap_wrapper.rb +2 -0
- metadata +17 -4
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<xs:schema xmlns="https://epbr.digital.communities.gov.uk/xsd/sap"
|
|
3
|
+
xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
|
4
|
+
targetNamespace="https://epbr.digital.communities.gov.uk/xsd/sap"
|
|
5
|
+
elementFormDefault="qualified"
|
|
6
|
+
attributeFormDefault="unqualified" version="BRUKLD-10.2">
|
|
7
|
+
<xs:include schemaLocation="../UDT/SAP-Domains.xsd"/>
|
|
8
|
+
<xs:include schemaLocation="SAP-Report.xsd"/>
|
|
9
|
+
<xs:element name="SAP-Compliance-Report" type="Compliance-Report"/>
|
|
10
|
+
<xs:complexType name="Compliance-Report">
|
|
11
|
+
<xs:sequence>
|
|
12
|
+
<xs:element name="SAP-Report" type="Energy-Performance-Certificate"
|
|
13
|
+
minOccurs="1">
|
|
14
|
+
<xs:annotation>
|
|
15
|
+
<xs:documentation>The SAP report corresponding to the compliance
|
|
16
|
+
report.
|
|
17
|
+
</xs:documentation>
|
|
18
|
+
</xs:annotation>
|
|
19
|
+
</xs:element>
|
|
20
|
+
<xs:element name="Client-Name" type="xs:string" minOccurs="1">
|
|
21
|
+
<xs:annotation>
|
|
22
|
+
<xs:documentation>Name of the client. External to the EPC schema for
|
|
23
|
+
GDPR purposes.
|
|
24
|
+
</xs:documentation>
|
|
25
|
+
</xs:annotation>
|
|
26
|
+
</xs:element>
|
|
27
|
+
<xs:element name="Client-Company" type="xs:string" minOccurs="1">
|
|
28
|
+
<xs:annotation>
|
|
29
|
+
<xs:documentation>Company name of the client. External to the EPC
|
|
30
|
+
schema for GDPR purposes.
|
|
31
|
+
</xs:documentation>
|
|
32
|
+
</xs:annotation>
|
|
33
|
+
</xs:element>
|
|
34
|
+
<xs:element name="Client-Address" type="AddressType" minOccurs="1">
|
|
35
|
+
<xs:annotation>
|
|
36
|
+
<xs:documentation>Address of the client. External to the EPC schema
|
|
37
|
+
for GDPR purposes.
|
|
38
|
+
</xs:documentation>
|
|
39
|
+
</xs:annotation>
|
|
40
|
+
</xs:element>
|
|
41
|
+
<xs:element name="Is-Multiple-Compliance" type="xs:boolean"
|
|
42
|
+
default="false" minOccurs="0">
|
|
43
|
+
<xs:annotation>
|
|
44
|
+
<xs:documentation>Is the compliance report part of a multiple
|
|
45
|
+
compliance calculation.
|
|
46
|
+
</xs:documentation>
|
|
47
|
+
</xs:annotation>
|
|
48
|
+
</xs:element>
|
|
49
|
+
</xs:sequence>
|
|
50
|
+
</xs:complexType>
|
|
51
|
+
</xs:schema>
|
|
@@ -0,0 +1,277 @@
|
|
|
1
|
+
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
+
<xs:schema xmlns="https://epbr.digital.communities.gov.uk/xsd/sap"
|
|
3
|
+
xmlns:xs="http://www.w3.org/2001/XMLSchema"
|
|
4
|
+
targetNamespace="https://epbr.digital.communities.gov.uk/xsd/sap"
|
|
5
|
+
elementFormDefault="qualified"
|
|
6
|
+
attributeFormDefault="unqualified"
|
|
7
|
+
version="19.1.0"
|
|
8
|
+
>
|
|
9
|
+
<xs:include schemaLocation="../UDT/SAP-Domains.xsd"/>
|
|
10
|
+
<xs:include schemaLocation="AssessorManagement.xsd"/>
|
|
11
|
+
<xs:include schemaLocation="Property.xsd"/>
|
|
12
|
+
<xs:include schemaLocation="SAP-CollectedData.xsd"/>
|
|
13
|
+
<xs:include schemaLocation="EPC-Certificate.xsd"/>
|
|
14
|
+
<xs:include schemaLocation="ExceptionList.xsd"/>
|
|
15
|
+
<xs:include schemaLocation="SAP-Compliance-Report.xsd"/>
|
|
16
|
+
<xs:include schemaLocation="ReportList.xsd"/>
|
|
17
|
+
<xs:element name="SAP-Report" type="Energy-Performance-Certificate"/>
|
|
18
|
+
<xs:complexType name="Energy-Performance-Certificate">
|
|
19
|
+
<xs:sequence>
|
|
20
|
+
<xs:element name="Schema-Version-Original" type="xs:string">
|
|
21
|
+
<xs:annotation>
|
|
22
|
+
<xs:documentation>The schema version that the data conformed to when
|
|
23
|
+
it was lodged.
|
|
24
|
+
</xs:documentation>
|
|
25
|
+
</xs:annotation>
|
|
26
|
+
</xs:element>
|
|
27
|
+
<xs:element name="Schema-Version-Current" type="xs:string" minOccurs="0">
|
|
28
|
+
<xs:annotation>
|
|
29
|
+
<xs:documentation>The schema version to which the data conforms. This
|
|
30
|
+
node is inserted by the register when a retrieval is requested. It
|
|
31
|
+
must not be present in a lodgement being sent to the register.
|
|
32
|
+
</xs:documentation>
|
|
33
|
+
</xs:annotation>
|
|
34
|
+
</xs:element>
|
|
35
|
+
<xs:element name="SAP-Version" type="SAP-VersionCode">
|
|
36
|
+
<xs:annotation>
|
|
37
|
+
<xs:documentation>SAP version that was used for the calculation.
|
|
38
|
+
</xs:documentation>
|
|
39
|
+
</xs:annotation>
|
|
40
|
+
</xs:element>
|
|
41
|
+
<xs:element name="SAP-Data-Version" type="SAP-VersionCode">
|
|
42
|
+
<xs:annotation>
|
|
43
|
+
<xs:documentation>Version of SAP that was used to define the input
|
|
44
|
+
data for the calculation.
|
|
45
|
+
</xs:documentation>
|
|
46
|
+
</xs:annotation>
|
|
47
|
+
</xs:element>
|
|
48
|
+
<xs:element name="PCDF-Revision-Number" type="xs:nonNegativeInteger"
|
|
49
|
+
minOccurs="0">
|
|
50
|
+
<xs:annotation>
|
|
51
|
+
<xs:documentation>Revision Number of the PCDF file used for the
|
|
52
|
+
calculations.
|
|
53
|
+
</xs:documentation>
|
|
54
|
+
</xs:annotation>
|
|
55
|
+
</xs:element>
|
|
56
|
+
<xs:element name="Calculation-Software-Name" type="xs:string">
|
|
57
|
+
<xs:annotation>
|
|
58
|
+
<xs:documentation>Name of the software used to perform the SAP
|
|
59
|
+
calculation.
|
|
60
|
+
</xs:documentation>
|
|
61
|
+
</xs:annotation>
|
|
62
|
+
</xs:element>
|
|
63
|
+
<xs:element name="Calculation-Software-Version" type="xs:string">
|
|
64
|
+
<xs:annotation>
|
|
65
|
+
<xs:documentation>Version of the software used to perform the SAP
|
|
66
|
+
calculation.
|
|
67
|
+
</xs:documentation>
|
|
68
|
+
</xs:annotation>
|
|
69
|
+
</xs:element>
|
|
70
|
+
<xs:element name="User-Interface-Name" type="xs:string" minOccurs="0"/>
|
|
71
|
+
<xs:element name="User-Interface-Version" type="xs:string" minOccurs="0"/>
|
|
72
|
+
<xs:element name="Report-Header" type="Report-Header"/>
|
|
73
|
+
<xs:element name="Energy-Assessment" type="Energy-Assessment"/>
|
|
74
|
+
<xs:element name="SAP10-Data" type="SAP10-Data"/>
|
|
75
|
+
<xs:element name="PDF" type="xs:base64Binary" minOccurs="0">
|
|
76
|
+
<xs:annotation>
|
|
77
|
+
<xs:documentation>
|
|
78
|
+
DEPRECATED - DO NOT USE
|
|
79
|
+
This element is allowed for backwards-compatibility but any data
|
|
80
|
+
sent here will
|
|
81
|
+
not be read, processed or stored by the register.
|
|
82
|
+
</xs:documentation>
|
|
83
|
+
</xs:annotation>
|
|
84
|
+
</xs:element>
|
|
85
|
+
<xs:element name="Insurance-Details" type="Insurance-Details"
|
|
86
|
+
minOccurs="0"/>
|
|
87
|
+
<xs:element name="ExternalDefinitions-Revision-Number" type="xs:string">
|
|
88
|
+
<xs:annotation>
|
|
89
|
+
<xs:documentation>A number indicating the version of related
|
|
90
|
+
ExternalDefinitions.xsd
|
|
91
|
+
</xs:documentation>
|
|
92
|
+
</xs:annotation>
|
|
93
|
+
</xs:element>
|
|
94
|
+
</xs:sequence>
|
|
95
|
+
</xs:complexType>
|
|
96
|
+
<xs:element name="Insurance-Details" type="Insurance-Details"/>
|
|
97
|
+
<xs:complexType name="Insurance-Details">
|
|
98
|
+
<xs:annotation>
|
|
99
|
+
<xs:documentation>Details of the Professional Indemnity Insurance policy
|
|
100
|
+
used to provide cover against a compensation claim against any
|
|
101
|
+
particular Home Condition Report.
|
|
102
|
+
|
|
103
|
+
A particular Home Condition Report may be covered by an Professional
|
|
104
|
+
Indemnity Insurance policy in one of three different ways:
|
|
105
|
+
* The Home Inspector has personal Professional Indemnity Insurance and
|
|
106
|
+
the Home Condition Report is covered by this.
|
|
107
|
+
* The Home Condition Report is covered by an umbrella Professional
|
|
108
|
+
Indemnity Insurance policy held by the Home Condition Report Supplier
|
|
109
|
+
that assigned the inspection to the Home Inspector.
|
|
110
|
+
* An individual insurance policy is taken out to cover the individual
|
|
111
|
+
report such as the case where the property is unusual and falls outside
|
|
112
|
+
the Home Inspectors normal Professional Indemnity Insurance policy.
|
|
113
|
+
|
|
114
|
+
A Home Inspector may use any or all of these methods to providing
|
|
115
|
+
Professional Indemnity Insurance for a Home Condition Report on a
|
|
116
|
+
case-by-case basis.
|
|
117
|
+
</xs:documentation>
|
|
118
|
+
</xs:annotation>
|
|
119
|
+
<xs:all>
|
|
120
|
+
<xs:element name="Insurer" type="xs:string">
|
|
121
|
+
<xs:annotation>
|
|
122
|
+
<xs:documentation>The name of the insurance company that underwrites /
|
|
123
|
+
issued the insurance policy
|
|
124
|
+
</xs:documentation>
|
|
125
|
+
</xs:annotation>
|
|
126
|
+
</xs:element>
|
|
127
|
+
<xs:element name="Policy-No" type="xs:string">
|
|
128
|
+
<xs:annotation>
|
|
129
|
+
<xs:documentation>The policy number of the insurance policy
|
|
130
|
+
</xs:documentation>
|
|
131
|
+
</xs:annotation>
|
|
132
|
+
</xs:element>
|
|
133
|
+
<xs:element name="Effective-Date" type="xs:date">
|
|
134
|
+
<xs:annotation>
|
|
135
|
+
<xs:documentation>The date that the insurance policy becomes effective
|
|
136
|
+
(commences cover)
|
|
137
|
+
</xs:documentation>
|
|
138
|
+
</xs:annotation>
|
|
139
|
+
</xs:element>
|
|
140
|
+
<xs:element name="Expiry-Date" type="xs:date">
|
|
141
|
+
<xs:annotation>
|
|
142
|
+
<xs:documentation>The date that the insurance policy is supposed to
|
|
143
|
+
expire.
|
|
144
|
+
</xs:documentation>
|
|
145
|
+
</xs:annotation>
|
|
146
|
+
</xs:element>
|
|
147
|
+
<xs:element name="PI-Limit" type="Money">
|
|
148
|
+
<xs:annotation>
|
|
149
|
+
<xs:documentation>The upper limit of the Professional Indemnity cover
|
|
150
|
+
provided by the insurance policy.
|
|
151
|
+
</xs:documentation>
|
|
152
|
+
</xs:annotation>
|
|
153
|
+
</xs:element>
|
|
154
|
+
</xs:all>
|
|
155
|
+
</xs:complexType>
|
|
156
|
+
<xs:element name="Report-Header" type="Report-Header"/>
|
|
157
|
+
<xs:complexType name="Report-Header">
|
|
158
|
+
<xs:annotation>
|
|
159
|
+
<xs:documentation>Report Header contains all the identification and
|
|
160
|
+
searchable details for the Report.
|
|
161
|
+
</xs:documentation>
|
|
162
|
+
</xs:annotation>
|
|
163
|
+
<xs:sequence>
|
|
164
|
+
<xs:element name="RRN" type="RRNType">
|
|
165
|
+
<xs:annotation>
|
|
166
|
+
<xs:documentation>Report Reference Number is the unique report
|
|
167
|
+
Identifier that the report will be publicly known by.
|
|
168
|
+
|
|
169
|
+
The RRN is allocated to the Report at the point that it is
|
|
170
|
+
registered and will be algorithmically derived from the natural key
|
|
171
|
+
characteristics of the Home Condition Report i.e. The Unique
|
|
172
|
+
Property Reference Number (UPRN) and Inspection Date.
|
|
173
|
+
</xs:documentation>
|
|
174
|
+
</xs:annotation>
|
|
175
|
+
</xs:element>
|
|
176
|
+
<xs:element name="Inspection-Date" type="xs:date">
|
|
177
|
+
<xs:annotation>
|
|
178
|
+
<xs:documentation>The date that the inspection was actually carried
|
|
179
|
+
out by the Home Inspector.
|
|
180
|
+
</xs:documentation>
|
|
181
|
+
</xs:annotation>
|
|
182
|
+
</xs:element>
|
|
183
|
+
<xs:element name="Report-Type" type="ReportTypeCode">
|
|
184
|
+
<xs:annotation>
|
|
185
|
+
<xs:documentation>The type of Home Inspection that was carried out.
|
|
186
|
+
|
|
187
|
+
Initially the only allowed type will be a Home Condition Report
|
|
188
|
+
inspection but this may be extended in the future to cover Energy
|
|
189
|
+
Assessment Only inspections.
|
|
190
|
+
</xs:documentation>
|
|
191
|
+
</xs:annotation>
|
|
192
|
+
</xs:element>
|
|
193
|
+
<xs:element name="Completion-Date" type="xs:date">
|
|
194
|
+
<xs:annotation>
|
|
195
|
+
<xs:documentation>The date that the Home Inspector completed the
|
|
196
|
+
report. This will be after the Inspection Date but generally before
|
|
197
|
+
the Registration Date.
|
|
198
|
+
</xs:documentation>
|
|
199
|
+
</xs:annotation>
|
|
200
|
+
</xs:element>
|
|
201
|
+
<xs:element name="Registration-Date" type="xs:date">
|
|
202
|
+
<xs:annotation>
|
|
203
|
+
<xs:documentation>The date that the report was submitted to the HCR
|
|
204
|
+
Registration Organisation for lodging in the HCR Register.
|
|
205
|
+
</xs:documentation>
|
|
206
|
+
</xs:annotation>
|
|
207
|
+
</xs:element>
|
|
208
|
+
<xs:element name="Status" type="ReportStatusCode">
|
|
209
|
+
<xs:annotation>
|
|
210
|
+
<xs:documentation>The Status of the Report.
|
|
211
|
+
|
|
212
|
+
A Home Condition Report can have a number of distinct states
|
|
213
|
+
depending on whereabouts in its overall lifecycle the HCR is - see
|
|
214
|
+
Home Condition Report Statechart for more details.
|
|
215
|
+
</xs:documentation>
|
|
216
|
+
</xs:annotation>
|
|
217
|
+
</xs:element>
|
|
218
|
+
<xs:element name="Language-Code" type="LanguageCode">
|
|
219
|
+
<xs:annotation>
|
|
220
|
+
<xs:documentation>The language that the report is written in.
|
|
221
|
+
</xs:documentation>
|
|
222
|
+
</xs:annotation>
|
|
223
|
+
</xs:element>
|
|
224
|
+
<xs:element name="Tenure" type="TenureCode"/>
|
|
225
|
+
<xs:element name="Transaction-Type" type="TransactionType"/>
|
|
226
|
+
<xs:element name="Seller-Commission-Report" type="Flag">
|
|
227
|
+
<xs:annotation>
|
|
228
|
+
<xs:documentation>Indicates that the HCR was commissioned by the
|
|
229
|
+
Seller of the Property or their Agent. This is required in order to
|
|
230
|
+
differentiate these reports from Buyer commisioned reports which are
|
|
231
|
+
not eligible for inclusion in a Home Information Pack
|
|
232
|
+
</xs:documentation>
|
|
233
|
+
</xs:annotation>
|
|
234
|
+
</xs:element>
|
|
235
|
+
<xs:element name="Property-Type" type="PropertyTypeCode">
|
|
236
|
+
<xs:annotation>
|
|
237
|
+
<xs:documentation>Describes the type of Property that is being
|
|
238
|
+
inspected. This should be the same as the Property-Type recorded in
|
|
239
|
+
the Property-Details section.
|
|
240
|
+
</xs:documentation>
|
|
241
|
+
</xs:annotation>
|
|
242
|
+
</xs:element>
|
|
243
|
+
<xs:element name="Home-Inspector" type="Home-Inspector"/>
|
|
244
|
+
<xs:element name="Property" type="Property"/>
|
|
245
|
+
<xs:element name="Region-Code" type="UKRegionCode" minOccurs="0">
|
|
246
|
+
<xs:annotation>
|
|
247
|
+
<xs:documentation>Region within the UK.</xs:documentation>
|
|
248
|
+
</xs:annotation>
|
|
249
|
+
</xs:element>
|
|
250
|
+
<xs:element name="Country-Code" type="UKCountryCode" minOccurs="0">
|
|
251
|
+
<xs:annotation>
|
|
252
|
+
<xs:documentation>Country within the UK.</xs:documentation>
|
|
253
|
+
</xs:annotation>
|
|
254
|
+
</xs:element>
|
|
255
|
+
<xs:element name="Related-Party-Disclosure">
|
|
256
|
+
<xs:complexType>
|
|
257
|
+
<xs:choice>
|
|
258
|
+
<xs:element name="Related-Party-Disclosure-Text" type="Sentence">
|
|
259
|
+
<xs:annotation>
|
|
260
|
+
<xs:documentation>For backward compatibility only.
|
|
261
|
+
</xs:documentation>
|
|
262
|
+
</xs:annotation>
|
|
263
|
+
</xs:element>
|
|
264
|
+
<xs:element name="Related-Party-Disclosure-Number"
|
|
265
|
+
type="DisclosureCode">
|
|
266
|
+
<xs:annotation>
|
|
267
|
+
<xs:documentation>Code indicating any potential conflicts of
|
|
268
|
+
interest or commercial relationships with other parties.
|
|
269
|
+
</xs:documentation>
|
|
270
|
+
</xs:annotation>
|
|
271
|
+
</xs:element>
|
|
272
|
+
</xs:choice>
|
|
273
|
+
</xs:complexType>
|
|
274
|
+
</xs:element>
|
|
275
|
+
</xs:sequence>
|
|
276
|
+
</xs:complexType>
|
|
277
|
+
</xs:schema>
|