epb_view_models 2.0.16 → 2.0.17

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.
Files changed (18) hide show
  1. checksums.yaml +4 -4
  2. data/api/schemas/data/orchestrate.json +3 -0
  3. data/api/schemas/xml/CEPC-S-7.1/Reports/BaseDataTypes.xsd +300 -0
  4. data/api/schemas/xml/CEPC-S-7.1/Reports/CEPC-Reports.xsd +66 -0
  5. data/api/schemas/xml/CEPC-S-7.1/Reports/Input-Data.xsd +34 -0
  6. data/api/schemas/xml/CEPC-S-7.1/Reports/Performance-Summary.xsd +125 -0
  7. data/api/schemas/xml/CEPC-S-7.1/Reports/Performance-Summary.xsd.bak +123 -0
  8. data/api/schemas/xml/CEPC-S-7.1/Reports/Property.xsd +67 -0
  9. data/api/schemas/xml/CEPC-S-7.1/Reports/Report-Header.xsd +178 -0
  10. data/api/schemas/xml/CEPC-S-7.1/Reports/Reported-Data.xsd +406 -0
  11. data/api/schemas/xml/CEPC-S-7.1/Reports/UserManagement.xsd +174 -0
  12. data/api/schemas/xml/examples/CEPC-S-7.1(EPC).xml +342 -0
  13. data/lib/epb_view_models.rb +1 -1
  14. data/lib/view_model/cepc71/common_schema.rb +7 -7
  15. data/lib/view_model/cepc_s_71/cepc.rb +101 -0
  16. data/lib/view_model/cepc_wrapper.rb +2 -0
  17. data/lib/view_model/factory.rb +1 -0
  18. metadata +13 -2
data/api/schemas/xml/CEPC-S-7.1/Reports/Performance-Summary.xsd.bak ADDED
@@ -0,0 +1,123 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!--xs:schema xmlns="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" version="LIG-CEPC-7.0"-->
3
+ <xs:schema xmlns="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:CEPC="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" elementFormDefault="qualified" version="LIG-CEPC-7.0">
4
+ <xs:element name="Summary-Of-Performance" type="Summary-Of-Performance"/>
5
+ <xs:complexType name="Summary-Of-Performance">
6
+ <xs:sequence>
7
+ <xs:element name="Building-Data" type="Building-Data" minOccurs="1" maxOccurs="unbounded"/>
8
+ </xs:sequence>
9
+ </xs:complexType>
10
+ <xs:element name="Building-Data" type="Building-Data"/>
11
+ <xs:complexType name="Building-Data">
12
+ <xs:annotation>
13
+ <xs:documentation>
14
+ For an EPC created using EPC-Gen Building-Data is fixed at four, which are:- Actual Building, Notional Building, Reference Building and Typical Buidling
15
+
16
+ The type of Building Data is indicated by7 the Analysis-Type field.</xs:documentation>
17
+ </xs:annotation>
18
+ <xs:all>
19
+ <xs:element name="Analysis-Type" type="AnalysisTypeCode"/>
20
+ <xs:element name="Area" type="xs:float"/>
21
+ <xs:element name="Area-Exterior" type="xs:float"/>
22
+ <xs:element name="Q50-Infiltration" type="xs:float"/>
23
+ <xs:element name="Weather" type="xs:string"/>
24
+ <xs:element name="Building-W-K" type="xs:float"/>
25
+ <xs:element name="Building-W-M2K" type="xs:float"/>
26
+ <xs:element name="Building-Alpha" type="xs:float"/>
27
+ <xs:element name="HVAC-Systems" type="HVAC-Systems"/>
28
+ <xs:element name="Global-Performance" type="Global-Performance"/>
29
+ <xs:element name="Activities" type="Activities"/>
30
+ <xs:element name="Primary-Energy-Indicator">
31
+ <xs:simpleType>
32
+ <xs:restriction base="xs:integer">
33
+ <!--<xs:minInclusive value="1"/>-->
34
+ </xs:restriction>
35
+ </xs:simpleType>
36
+ </xs:element>
37
+ <xs:element name="Approximate-Energy-Use">
38
+ <xs:simpleType>
39
+ <xs:annotation>
40
+ <xs:documentation>Total annual delivered energy consumption, in kWh/m2, inluding any energy consumed by a CHP, if applicable, and net of any energy displaced by it.</xs:documentation>
41
+ </xs:annotation>
42
+ <xs:restriction base="xs:integer">
43
+ <xs:minInclusive value="1"/>
44
+ </xs:restriction>
45
+ </xs:simpleType>
46
+ </xs:element>
47
+ </xs:all>
48
+ </xs:complexType>
49
+ <xs:element name="Activity" type="Activity"/>
50
+ <xs:complexType name="Activity">
51
+ <xs:all>
52
+ <xs:element name="ID" type="xs:long"/>
53
+ <xs:element name="Area" type="xs:float"/>
54
+ </xs:all>
55
+ </xs:complexType>
56
+ <xs:element name="Activities" type="Activities"/>
57
+ <xs:complexType name="Activities">
58
+ <xs:sequence>
59
+ <xs:element name="Activity" type="Activity" maxOccurs="unbounded"/>
60
+ </xs:sequence>
61
+ </xs:complexType>
62
+ <xs:element name="HVAC-System-Data" type="HVAC-System-Data"/>
63
+ <xs:complexType name="HVAC-System-Data">
64
+ <xs:all>
65
+ <xs:element name="Area" type="xs:float"/>
66
+ <xs:element name="Heat-Source" type="xs:string"/>
67
+ <xs:element name="Type" type="xs:string"/>
68
+ <xs:element name="Fuel-Type" type="xs:string"/>
69
+ <xs:element name="Cooling-Gen-SEER" type="xs:float"/>
70
+ <xs:element name="Cooling-SSEER" type="xs:float"/>
71
+ <xs:element name="Heating-Gen-SEFF" type="xs:float"/>
72
+ <xs:element name="Heating-SSEFF" type="xs:float"/>
73
+ <xs:element name="KWH-M2-Auxiliary" type="xs:float"/>
74
+ <xs:element name="KWH-M2-Cooling" type="xs:float"/>
75
+ <xs:element name="KWH-M2-Heating" type="xs:float"/>
76
+ <xs:element name="MJ-M2-Heating-Dem" type="xs:float"/>
77
+ <xs:element name="MJ-M2-Cooling-Dem" type="xs:float"/>
78
+ <xs:element name="Activities" type="Activities"/>
79
+ </xs:all>
80
+ </xs:complexType>
81
+ <xs:element name="Global-Performance" type="Global-Performance"/>
82
+ <xs:complexType name="Global-Performance">
83
+ <xs:all>
84
+ <xs:element name="KWH-M2-Cooling" type="xs:float"/>
85
+ <xs:element name="KWH-M2-Heating" type="xs:float"/>
86
+ <xs:element name="KWH-M2-Auxiliary" type="xs:float"/>
87
+ <xs:element name="KWH-M2-Lighting" type="xs:float"/>
88
+ <xs:element name="KWH-M2-DHW" type="xs:float"/>
89
+ <xs:element name="KWH-M2-Equipment" type="xs:float"/>
90
+ <xs:element name="KWH-M2-Natural-Gas" type="xs:float"/>
91
+ <xs:element name="KWH-M2-Biogas" type="xs:float"/>
92
+ <xs:element name="KWH-M2-LPG" type="xs:float"/>
93
+ <xs:element name="KWH-M2-Coal" type="xs:float"/>
94
+ <xs:element name="KWH-M2-Oil" type="xs:float"/>
95
+ <xs:element name="KWH-M2-Anthracite" type="xs:float"/>
96
+ <xs:element name="KWH-M2-Smokeless" type="xs:float"/>
97
+ <xs:element name="KWH-M2-Biomass" type="xs:float"/>
98
+ <xs:element name="KWH-M2-Dual-Fuel" type="xs:float"/>
99
+ <xs:element name="KWH-M2-Supplied" type="xs:float"/>
100
+ <xs:element name="KWH-M2-Waste-Heat" type="xs:float"/>
101
+ <xs:element name="KWH-M2-Displaced" type="xs:float"/>
102
+ <xs:element name="KWH-M2-PVS" type="xs:float"/>
103
+ <xs:element name="KWH-M2-CHP" type="xs:float"/>
104
+ <xs:element name="KWH-M2-SES" type="xs:float"/>
105
+ <xs:element name="KWH-M2-Wind" type="xs:float"/>
106
+ <xs:element name="KWH-M2-District-Heating" type="xs:float"/>
107
+ </xs:all>
108
+ </xs:complexType>
109
+ <xs:element name="HVAC-Systems" type="HVAC-Systems"/>
110
+ <xs:complexType name="HVAC-Systems">
111
+ <xs:sequence>
112
+ <xs:element name="HVAC-System-Data" type="HVAC-System-Data" maxOccurs="unbounded"/>
113
+ </xs:sequence>
114
+ </xs:complexType>
115
+ <xs:simpleType name="AnalysisTypeCode">
116
+ <xs:restriction base="xs:string">
117
+ <xs:enumeration value="ACTUAL"/>
118
+ <xs:enumeration value="NOTIONAL"/>
119
+ <xs:enumeration value="REFERENCE"/>
120
+ <xs:enumeration value="TYPICAL"/>
121
+ </xs:restriction>
122
+ </xs:simpleType>
123
+ </xs:schema>
data/api/schemas/xml/CEPC-S-7.1/Reports/Property.xsd ADDED
@@ -0,0 +1,67 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" elementFormDefault="qualified" version="LIG-16.0">
3
+ <xs:annotation>
4
+ <xs:documentation>© Department of Communities and Local Government. © Crown copyright, 2007. The Home Condition Report logo and associated wording is a registered trade mark - any unlicensed use is not permitted. Copyright in the typographical arrangement of this document rests with the Crown. This publication, excluding logos, may be reproduced free of charge in any format or medium for research, private study, for internal circulation within an organisation or by registered scheme users. This is subject to it being reproduced accurately and not used in a misleading context. </xs:documentation>
5
+ </xs:annotation>
6
+ <xs:element name="Property" type="Property"/>
7
+ <xs:complexType name="Property">
8
+ <xs:annotation>
9
+ <xs:documentation>A discrete identifiable possession, such as a piece of real-estate, to which its owner has legal title. For the Home Information Pack legislation the types of property are restricted to residential properties.
10
+
11
+ It should be observed that "a property is a property is a property" and all real-estate properties, whether residential or commercial or whether being sold for the first or the nth time will have a very similar conceptual structure and similar rules and constraints.
12
+
13
+ As such the broad description of a Property can be regarded as a framework, containing a set of extension points, that can be expanded as necessary to cover additional detail.
14
+ </xs:documentation>
15
+ </xs:annotation>
16
+ <xs:all>
17
+ <xs:element name="Address" type="AddressType"/>
18
+
19
+ <xs:element name="UPRN" type="UPRNType">
20
+ <xs:annotation>
21
+ <xs:documentation>Unique Property Reference Number</xs:documentation>
22
+ </xs:annotation>
23
+ </xs:element>
24
+ </xs:all>
25
+ </xs:complexType>
26
+ <xs:complexType name="AddressType">
27
+ <xs:annotation>
28
+ <xs:documentation>An address is composed of a number of structured elements such as Postcode, Post-Town, Street etc.
29
+
30
+ </xs:documentation>
31
+ </xs:annotation>
32
+ <xs:sequence>
33
+ <xs:element name="Address-Line-1" type="xs:string" minOccurs="0"/>
34
+ <xs:element name="Address-Line-2" type="xs:string" minOccurs="0"/>
35
+ <xs:element name="Address-Line-3" type="xs:string" minOccurs="0"/>
36
+ <xs:element name="Post-Town" type="xs:string"/>
37
+ <xs:element name="Postcode" type="PostcodeType" minOccurs="0">
38
+ <xs:annotation>
39
+ <xs:documentation>The Postcode for the Address
40
+ </xs:documentation>
41
+ </xs:annotation>
42
+ </xs:element>
43
+ </xs:sequence>
44
+ </xs:complexType>
45
+ <xs:simpleType name="UPRNType">
46
+ <xs:annotation>
47
+ <xs:documentation>Unique Property Reference Number - a 10-digit numeric string unmiquely identifuying each Property that may have a HCR registered against it.</xs:documentation>
48
+ </xs:annotation>
49
+ <xs:restriction base="xs:string">
50
+ <xs:pattern value="[0-9]{10}"/>
51
+ </xs:restriction>
52
+ </xs:simpleType>
53
+ <xs:simpleType name="PostcodeType">
54
+ <xs:restriction base="xs:string">
55
+ <xs:pattern value="[A-Z]{1,2}[0-9R][0-9A-Z]? [0-9][A-Z]{2}"/>
56
+ </xs:restriction>
57
+ </xs:simpleType>
58
+ <xs:element name="PropertyKeyFields" type="PropertyKeyFields"/>
59
+ <xs:complexType name="PropertyKeyFields">
60
+ <xs:annotation>
61
+ <xs:documentation>This is the primary key definition for the Property class - used when a message requires a reference to a Property to be passed rather than the details.</xs:documentation>
62
+ </xs:annotation>
63
+ <xs:sequence>
64
+ <xs:element name="UPRN" type="UPRNType"/>
65
+ </xs:sequence>
66
+ </xs:complexType>
67
+ </xs:schema>
data/api/schemas/xml/CEPC-S-7.1/Reports/Report-Header.xsd ADDED
@@ -0,0 +1,178 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:CEPC="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:UDT="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" targetNamespace="http://www.est.org.uk/epc/estcrV1/DCLG-CEPC" elementFormDefault="qualified" version="LIG-CEPC-7.0">
3
+ <!--xs:import namespace="http://www.est.org.uk/epc/estcrV1/DCLG-HIP" schemaLocation="./SharedDomains.xsd"/-->
4
+ <!--xs:include schemaLocation="./HCR-Domains.xsd"/-->
5
+ <xs:include schemaLocation="./UserManagement.xsd"/>
6
+ <xs:include schemaLocation="./BaseDataTypes.xsd"/>
7
+ <xs:include schemaLocation="./Property.xsd"/>
8
+ <xs:element name="Property-Details" type="Property-Details"/>
9
+ <xs:complexType name="Property-Details"/>
10
+ <xs:element name="AddressType" type="AddressType"/>
11
+ <xs:element name="Report-Header" type="Report-Header"/>
12
+ <xs:complexType name="Report-Header">
13
+ <xs:annotation>
14
+ <xs:documentation>Report Header contains all the identification and searchable details for the Report.</xs:documentation>
15
+ </xs:annotation>
16
+ <xs:sequence>
17
+ <xs:element name="RRN" type="RRNType">
18
+ <xs:annotation>
19
+ <xs:documentation>Report Reference Number is the unique report Identifier that the report will be publicly known by.
20
+
21
+ The RRN is allocated to the Report at the point that it is registered and will be algorithmically derived from the natural key characteristics of the Home Condition Report i.e. The Unique Property Reference Number (UPRN) and Inspection Date.</xs:documentation>
22
+ </xs:annotation>
23
+ </xs:element>
24
+ <xs:element name="Inspection-Date" type="xs:date">
25
+ <xs:annotation>
26
+ <xs:documentation>The date that the inspection was actually carried out by the Home Inspector.</xs:documentation>
27
+ </xs:annotation>
28
+ </xs:element>
29
+ <xs:element name="Report-Type" type="ReportTypeCode">
30
+ <xs:annotation>
31
+ <xs:documentation>The type of Home Inspection that was carried out.
32
+
33
+ Initially the only allowed type will be a Home Condition Report inspection but this may be extended in the future to cover Energy Assessment Only inspections.</xs:documentation>
34
+ </xs:annotation>
35
+ </xs:element>
36
+ <xs:element name="Completion-Date" type="xs:date">
37
+ <xs:annotation>
38
+ <xs:documentation>The date that the Home Inspector completed the report. This will be after the Inspection Date but generally before the Registration Date.</xs:documentation>
39
+ </xs:annotation>
40
+ </xs:element>
41
+ <xs:element name="Registration-Date" type="xs:date">
42
+ <xs:annotation>
43
+ <xs:documentation>The date that the report was submitted to the HCR Registration Organisation for lodging in the HCR Register.</xs:documentation>
44
+ </xs:annotation>
45
+ </xs:element>
46
+ <xs:element name="Status" type="ReportStatusCode">
47
+ <xs:annotation>
48
+ <xs:documentation>The Status of the Report.
49
+
50
+ A Home Condition Report can have a number of distinct states depending on whereabouts in its overall lifecycle the HCR is - see Home Condition Report Statechart for more details.</xs:documentation>
51
+ </xs:annotation>
52
+ </xs:element>
53
+ <xs:element name="Language-Code" type="LanguageCode">
54
+ <xs:annotation>
55
+ <xs:documentation>The language that the report is written in. </xs:documentation>
56
+ </xs:annotation>
57
+ </xs:element>
58
+ <xs:element name="Restricted-Access" type="RestrictedAccessCode">
59
+ <xs:annotation>
60
+ <xs:documentation>Indicates that the Seller wants to restrict access to the Home Condition Report to General Public / Unregistered Users only.
61
+
62
+ Some members of the public have a moral / religious objection to money lending and hence may not want to let Mortgage Lenders have access to the data. When set to "Yes" retrieval of the structured (XML) data will be blocked.
63
+
64
+ However anyone with access to the Report Reference Number (RRN) can retrieve the PDF version of the Home Condition Report via the public access mechanism which cannot be restricted in this way.</xs:documentation>
65
+ </xs:annotation>
66
+ </xs:element>
67
+ <xs:element name="Transaction-Type" type="TransactionType"/>
68
+ <xs:element name="Seller-Commission-Report" type="Flag">
69
+ <xs:annotation>
70
+ <xs:documentation>Indicates that the HCR was commissioned by the Seller of the Property or their Agent. This is required in order to differentiate these reports from Buyer commisioned reports which are not eligible for inclusion in a Home Information Pack</xs:documentation>
71
+ </xs:annotation>
72
+ </xs:element>
73
+ <xs:element name="Property-Type" type="Building-Type">
74
+ <xs:annotation>
75
+ <xs:documentation>Describes the type of Property that is being inspected. This should be the same as the Property-Type recorded in the Property-Details section.</xs:documentation>
76
+ </xs:annotation>
77
+ </xs:element>
78
+ <xs:element name="Energy-Assessor" type="Energy-Assessor"/>
79
+ <xs:element name="Property" type="Property"/>
80
+ <xs:element name="Calculation-Details">
81
+ <xs:complexType>
82
+ <xs:sequence>
83
+ <xs:element name="Methodology" type="xs:string"/>
84
+ <xs:element name="Calculation-Tool" type="xs:string"/>
85
+ <xs:element name="Output-Engine" type="xs:string"/>
86
+ <xs:element name="Inspection-Type" type="xs:string"/>
87
+ </xs:sequence>
88
+ </xs:complexType>
89
+ </xs:element>
90
+ </xs:sequence>
91
+ </xs:complexType>
92
+ <xs:simpleType name="ReportTypeCode">
93
+ <xs:restriction base="xs:string">
94
+ <xs:enumeration value="3">
95
+ <xs:annotation>
96
+ <xs:documentation>Energy Performance Certificate (Non Domestic)</xs:documentation>
97
+ </xs:annotation>
98
+ </xs:enumeration>
99
+ <xs:enumeration value="4">
100
+ <xs:annotation>
101
+ <xs:documentation>Recommendation Report (Non Domestic)</xs:documentation>
102
+ </xs:annotation>
103
+ </xs:enumeration>
104
+ </xs:restriction>
105
+ </xs:simpleType>
106
+ <xs:simpleType name="ReportStatusCode">
107
+ <xs:restriction base="xs:string">
108
+ <xs:enumeration value="cancelled">
109
+ <xs:annotation>
110
+ <xs:documentation>Cancelled</xs:documentation>
111
+ </xs:annotation>
112
+ </xs:enumeration>
113
+ <xs:enumeration value="entered">
114
+ <xs:annotation>
115
+ <xs:documentation>entered on the register</xs:documentation>
116
+ </xs:annotation>
117
+ </xs:enumeration>
118
+ <xs:enumeration value="appeal">
119
+ <xs:annotation>
120
+ <xs:documentation>under appeal</xs:documentation>
121
+ </xs:annotation>
122
+ </xs:enumeration>
123
+ <xs:enumeration value="removed">
124
+ <xs:annotation>
125
+ <xs:documentation>removed</xs:documentation>
126
+ </xs:annotation>
127
+ </xs:enumeration>
128
+ <xs:enumeration value="rejected">
129
+ <xs:annotation>
130
+ <xs:documentation>rejected</xs:documentation>
131
+ </xs:annotation>
132
+ </xs:enumeration>
133
+ <xs:enumeration value="under investigation">
134
+ <xs:annotation>
135
+ <xs:documentation>under investigation</xs:documentation>
136
+ </xs:annotation>
137
+ </xs:enumeration>
138
+ <xs:enumeration value="not for issue">
139
+ <xs:annotation>
140
+ <xs:documentation>not for issue</xs:documentation>
141
+ </xs:annotation>
142
+ </xs:enumeration>
143
+ </xs:restriction>
144
+ </xs:simpleType>
145
+ <xs:simpleType name="RestrictedAccessCode">
146
+ <xs:annotation>
147
+ <xs:documentation>Set of access codes identifying any restrictions on the retrieval of the electronic HCR.</xs:documentation>
148
+ </xs:annotation>
149
+ <xs:restriction base="xs:string">
150
+ <xs:enumeration value="0">
151
+ <xs:annotation>
152
+ <xs:documentation>No restriction</xs:documentation>
153
+ </xs:annotation>
154
+ </xs:enumeration>
155
+ <xs:enumeration value="1">
156
+ <xs:annotation>
157
+ <xs:documentation>Exclude mortgage lenders</xs:documentation>
158
+ </xs:annotation>
159
+ </xs:enumeration>
160
+ <xs:enumeration value="2">
161
+ <xs:annotation>
162
+ <xs:documentation>Mortgage lenders only</xs:documentation>
163
+ </xs:annotation>
164
+ </xs:enumeration>
165
+ <xs:enumeration value="4">
166
+ <xs:annotation>
167
+ <xs:documentation>No access allowed</xs:documentation>
168
+ </xs:annotation>
169
+ </xs:enumeration>
170
+ </xs:restriction>
171
+ </xs:simpleType>
172
+ <xs:complexType name="Building-Type">
173
+ <xs:sequence>
174
+ <xs:element name="Short-Description" type="xs:string"></xs:element>
175
+ <xs:element name="Long-Description" type="xs:string"></xs:element>
176
+ </xs:sequence>
177
+ </xs:complexType>
178
+ </xs:schema>