epb_view_models 2.3.0 → 2.4.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.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/api/schemas/data/orchestrate.json +4 -0
  3. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/CommonFiles/CommonStructures.xsd +160 -0
  4. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/CommonFiles/Exceptions.xsd +72 -0
  5. data/api/schemas/xml/{RdSAP-Schema-S-14.0/RdSAP/Messages/PropertyUPRNValidationRequest_1.xsd → RdSAP-Schema-S-12.0/RdSAP/Messages/ConditionReportCreateRequest_1.xsd} +24 -15
  6. data/api/schemas/xml/{RdSAP-Schema-S-14.0/RdSAP/SAP-EPC → RdSAP-Schema-S-12.0/RdSAP}/Templates/EPC-Certificate.xsd +48 -105
  7. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/EPC-CollectedData.xsd +445 -0
  8. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/HCR-FeaturesExternal.xsd +283 -0
  9. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/HCR-FeaturesGrounds.xsd +222 -0
  10. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/HCR-FeaturesInternal.xsd +205 -0
  11. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/HCR-FeaturesServices.xsd +311 -0
  12. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/HCR-PropertyDetails.xsd +380 -0
  13. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Templates/HCR-RiskAssessment.xsd +297 -0
  14. data/api/schemas/xml/{RdSAP-Schema-S-14.0/RdSAP/SAP-EPC/Templates/SAP05-Report.xsd → RdSAP-Schema-S-12.0/RdSAP/Templates/HIP-Reports.xsd} +64 -56
  15. data/api/schemas/xml/{RdSAP-Schema-S-14.0/RdSAP/SAP-EPC → RdSAP-Schema-S-12.0/RdSAP}/Templates/Property.xsd +14 -9
  16. data/api/schemas/xml/{RdSAP-Schema-S-14.0/RdSAP/SAP-EPC → RdSAP-Schema-S-12.0/RdSAP}/Templates/UserManagement.xsd +100 -63
  17. data/api/schemas/xml/{RdSAP-Schema-S-14.0/RdSAP/SAP-EPC → RdSAP-Schema-S-12.0/RdSAP}/UDT/BaseDataTypes.xsd +28 -26
  18. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/UDT/EPC-Domains.xsd +68 -0
  19. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/UDT/HCR-Domains.xsd +1773 -0
  20. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/UDT/SAP-Domains.xsd +1101 -0
  21. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/UDT/SharedDomains.xsd +596 -0
  22. data/api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/UDT/TypeDefinitions.xsd +19 -0
  23. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportCreateRequest_1.xsd +2 -2
  24. data/lib/epb_view_models/version.rb +5 -0
  25. data/lib/epb_view_models.rb +1 -3
  26. data/lib/helper/rrn_helper.rb +4 -4
  27. data/lib/view_model/cs63/common_schema.rb +18 -18
  28. data/lib/view_model/factory.rb +1 -0
  29. data/lib/view_model/rd_sap_schema_s_120/common_schema.rb +547 -0
  30. data/lib/view_model/rd_sap_wrapper.rb +2 -0
  31. metadata +26 -36
  32. data/.buildspec.yml +0 -13
  33. data/.gitignore +0 -19
  34. data/.rspec +0 -2
  35. data/.rubocop.yml +0 -8
  36. data/.ruby-version +0 -1
  37. data/Gemfile +0 -15
  38. data/Gemfile.lock +0 -122
  39. data/Makefile +0 -17
  40. data/Rakefile +0 -12
  41. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/ExternalDefinitions.xsd +0 -147
  42. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportChangeAccessRequest_1.xsd +0 -44
  43. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportChangeAccessResponse_1.xsd +0 -47
  44. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportChangeStatusRequest_1.xsd +0 -44
  45. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportChangeStatusResponse_1.xsd +0 -47
  46. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportCreateResponse_1.xsd +0 -52
  47. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportRetrieveRequest_1.xsd +0 -52
  48. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportRetrieveResponse_1.xsd +0 -87
  49. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/HomeInspectorRegisterUpdateRequest_1.xsd +0 -44
  50. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/HomeInspectorRegisterUpdateResponse_1.xsd +0 -28
  51. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/HomeInspectorRegisterUpdateStatusRequest_1.xsd +0 -30
  52. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/HomeInspectorRegisterUpdateStatusResponse_1.xsd +0 -52
  53. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/PropertyUPRNValidationResponse_1.xsd +0 -46
  54. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/SAP-EPC/Templates/SAP05-CollectedData.xsd +0 -1188
  55. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/SAP-EPC/UDT/EPC-Domains.xsd +0 -703
  56. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/SAP-EPC/UDT/SAP05-Domains.xsd +0 -3007
  57. data/api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/SAP-EPC/UDT/SharedDomains.xsd +0 -311
  58. data/epb_view_models.gemspec +0 -27
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fd8197c49c85bbd4021c3ed7de879a39e384487045f458d5fabe1e2cbb277299
4
- data.tar.gz: d5d06e72be91e7f565e6eeed197c4ba9eb8d31b37ad16dc766b6d00d31d8f977
3
+ metadata.gz: 8fc4f00f9b029744ebfd2a4e4de51636873e23fa4121ecbf9cc3b0244284b7d3
4
+ data.tar.gz: '002389e62c4c7c2bd3226852073621aa23a350b37737ddd1212ec78fb4a182b4'
5
5
  SHA512:
6
- metadata.gz: e074c824fdc8e4b9ac2eb55a91269af924a09f6ef6088336324d272d6c7ae9dbef45a1e54134fd9ffe6638c05336d5349f2dfb0ba56c4831709c319c18ba8242
7
- data.tar.gz: 8e63ed4516a7bd12ea77b1ff37a183836486852d38b6580aba671e0e773c6b5fc6f1b31a0dd5b7a15d796fdd77e4959751e1629086970422bf8948d76ab3bd8d
6
+ metadata.gz: 87bb3bc7e7fda3dcfb8fce735bcc37f7bae683def568392d3fa4874cf9da4c357eebc9276db8b3b08b125a7f3e7f7701a22d0b108174a2c7befd4701ea9cce01
7
+ data.tar.gz: ed5acc05eaaf16e4c64baada3083fb29884f68b7799fda3c0f4893ad8fb7f9c39ab3141313d8d8765a1791d94d0ee5504e5326c0e6b82858aaea146d6fe44f54
@@ -219,6 +219,10 @@
219
219
  "schema_path":
220
220
  "api/schemas/xml/RdSAP-Schema-S-14.0/RdSAP/Messages/ConditionReportCreateRequest_1.xsd"
221
221
  },
222
+ "RdSAP-Schema-S-12.0": {
223
+ "schema_path":
224
+ "api/schemas/xml/RdSAP-Schema-S-12.0/RdSAP/Messages/ConditionReportCreateRequest_1.xsd"
225
+ },
222
226
  "CEPC-8.0.0": {
223
227
  "schema_path": "api/schemas/xml/CEPC-8.0.0/Reports/CEPC-Reports.xsd"
224
228
  },
@@ -0,0 +1,160 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:CS="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/CommonStructures" xmlns:pfdt="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" targetNamespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/CommonStructures" elementFormDefault="qualified" attributeFormDefault="unqualified" version="LIG-12.0">
3
+ <!--
4
+ © 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.
5
+
6
+ -->
7
+ <!-- ***************************************************************************
8
+ Simple Type declarations for Identification Block property values
9
+ *************************************************************************** -->
10
+ <xs:import namespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" schemaLocation="../UDT/BaseDataTypes.xsd"/>
11
+ <!-- ***************************************************************************
12
+ Simple Type declarations for Identification Block property values
13
+ *************************************************************************** -->
14
+ <xs:simpleType name="ServiceNameType">
15
+ <xs:annotation>
16
+ <xs:documentation source="Service Name is a string label that uniquely identifies each service within the domain."/>
17
+ </xs:annotation>
18
+ <xs:restriction base="xs:string"/>
19
+ <!-- Should include validation of allowed Service Name constraints such as allowed charcaters etc. -->
20
+ </xs:simpleType>
21
+ <xs:simpleType name="OperationType">
22
+ <xs:restriction base="xs:string">
23
+ <xs:enumeration value="Create"/>
24
+ <xs:enumeration value="Retrieve"/>
25
+ <xs:enumeration value="Update"/>
26
+ <xs:enumeration value="Delete"/>
27
+ <xs:enumeration value="Retire"/>
28
+ <xs:enumeration value="Search"/>
29
+ <xs:enumeration value="Execute"/>
30
+ <xs:enumeration value="Describe"/>
31
+ </xs:restriction>
32
+ </xs:simpleType>
33
+ <xs:complexType name="IdentifierValue">
34
+ <xs:annotation>
35
+ <xs:documentation source="Public Identifier datatype is the public identifier by which an instance of a Business Entity can be identified. It's called Public Form Identiier rather then Content Form Identifier for historic reasons as a result of confusion over definitions of terms."/>
36
+ </xs:annotation>
37
+ <xs:simpleContent>
38
+ <xs:extension base="xs:string">
39
+ <xs:attribute name="IdentifierTypeDomain" type="xs:string" use="optional">
40
+ <xs:annotation>
41
+ <xs:documentation source="Public Form Identifier datatype is the public identifier by which an instance of a Content Form can be identified. It's called Public Form Identiier rather then Content Form Identifier for historic reasons as a result of confusion over definitions of terms."/>
42
+ </xs:annotation>
43
+ </xs:attribute>
44
+ </xs:extension>
45
+ </xs:simpleContent>
46
+ </xs:complexType>
47
+ <xs:simpleType name="ReportRetrievalType">
48
+ <xs:restriction base="xs:string">
49
+ <xs:enumeration value="List"/>
50
+ <xs:enumeration value="Data"/>
51
+ <xs:enumeration value="PDF"/>
52
+ </xs:restriction>
53
+ </xs:simpleType>
54
+ <!-- ***************************************************************************
55
+ Standard Identifying Block declarations
56
+
57
+ The Identification block contains standard data needed to identify an individual instance of a
58
+ particular service such as the service name, service provider, execution date.
59
+
60
+ Because there can be significant delays between the invocation of a service and the equivalent
61
+ response it is essential that each individual service request can be recognised. An individual
62
+ requestor may concurrently initiate many requests so the Identification blocks provide a
63
+ standard means of pairing the response to the particular request.
64
+
65
+ These data-items can be considered standard across all messages of a particular type but may be
66
+ extended by an individual service to include service specific parameters.
67
+
68
+ *************************************************************************** -->
69
+ <!-- Standard Identification Message _________________________________________________ -->
70
+ <!--
71
+ This standard identification block then needs to be extended with an Identifier element
72
+ defining the allowed key attributes particular to the Business Entity retrieve via the service.
73
+ This is done on a message by message basis, for example:
74
+
75
+ <xs:element name="Identification">
76
+ <xs:complexType>
77
+ <xs:complexContent>
78
+ <xs:extension base="CS:DefaultIDBlock">
79
+ <xs:sequence>
80
+ <xs:element name="Identifier" type="[IdentifierKeyFieldsType]"/>
81
+ </xs:sequence>
82
+ </xs:extension>
83
+ </xs:complexContent>
84
+ </xs:complexType>
85
+ </xs:element>
86
+
87
+ -->
88
+ <xs:complexType name="DefaultIdBlock">
89
+ <xs:annotation>
90
+ <xs:documentation source="The standard Identifying Block for all messages."/>
91
+ </xs:annotation>
92
+ <xs:sequence>
93
+ <xs:element name="ServiceName" type="CS:ServiceNameType"/>
94
+ <xs:element name="Operation">
95
+ <xs:simpleType>
96
+ <xs:restriction base="CS:OperationType"/>
97
+ </xs:simpleType>
98
+ </xs:element>
99
+ <xs:element name="TransactionDetails">
100
+ <xs:complexType>
101
+ <xs:sequence>
102
+ <xs:element name="OriginatingID" type="xs:string"/>
103
+ <xs:element name="RecipientID" type="xs:string"/>
104
+ <xs:element name="Timestamp" type="xs:dateTime"/>
105
+ <xs:element name="TransactionID" type="xs:string" minOccurs="0"/>
106
+ </xs:sequence>
107
+ </xs:complexType>
108
+ </xs:element>
109
+ <xs:element name="TermsAndConditions" minOccurs="0">
110
+ <xs:simpleType>
111
+ <xs:restriction base="pfdt:Flag"/>
112
+ </xs:simpleType>
113
+ </xs:element>
114
+ </xs:sequence>
115
+ </xs:complexType>
116
+ <!-- ***************************************************************************
117
+ Standard Configuration declarations
118
+
119
+ The Configuration block contains standard data required by the service to carry out its designated
120
+ task such as details of the parties / organisations involved in the transaction or operating
121
+ directions.
122
+
123
+ These are the configuration parameters that can be considered standard across all messages of a
124
+ particular type but may be extended by an individual service to include service specific
125
+ parameters.
126
+
127
+ Not all service types may need a Configuration block.
128
+ *************************************************************************** -->
129
+ <xs:complexType name="UpdateRequestConfigBlock">
130
+ <xs:sequence>
131
+ <xs:element name="StopOnFirstError" type="xs:string" minOccurs="0"/>
132
+ <xs:element name="ReasonForChange" type="xs:string" minOccurs="0"/>
133
+ </xs:sequence>
134
+ </xs:complexType>
135
+ <xs:complexType name="CreateRequestConfigBlock">
136
+ <xs:sequence>
137
+ <xs:element name="StopOnFirstError" type="xs:string" minOccurs="0"/>
138
+ <xs:element name="ReasonForChange" type="xs:string" minOccurs="0"/>
139
+ </xs:sequence>
140
+ </xs:complexType>
141
+ <xs:complexType name="RetrieveRequestConfigBlock">
142
+ <xs:sequence>
143
+ <xs:element name="StartDate" type="xs:date" minOccurs="0"/>
144
+ <xs:element name="Language" type="pfdt:LanguageCode" minOccurs="0"/>
145
+ <xs:element name="ResponseFormat" type="CS:ReportRetrievalType" minOccurs="0"/>
146
+ </xs:sequence>
147
+ </xs:complexType>
148
+ <xs:complexType name="SearchRequestConfigBlock">
149
+ <xs:sequence>
150
+ <xs:element name="RecordsToRetrieve" type="xs:long" minOccurs="0"/>
151
+ <xs:element name="StartRecord" type="xs:long" minOccurs="0"/>
152
+ </xs:sequence>
153
+ </xs:complexType>
154
+ <xs:complexType name="SearchResponseConfigBlock">
155
+ <xs:sequence>
156
+ <xs:element name="MoreRecords" type="xs:boolean" minOccurs="0"/>
157
+ <xs:element name="MoreThanMaxRecords" type="xs:boolean" minOccurs="0"/>
158
+ </xs:sequence>
159
+ </xs:complexType>
160
+ </xs:schema>
@@ -0,0 +1,72 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <xs:schema xmlns="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/Exceptions" xmlns:ERR="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/Exceptions" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:pfdt="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" targetNamespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/Exceptions" elementFormDefault="qualified" version="LIG-12.0">
3
+ <!--
4
+ © 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.
5
+
6
+ -->
7
+ <xs:import namespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" schemaLocation="../UDT/BaseDataTypes.xsd"/>
8
+ <xs:element name="DataItem" type="DataItem"/>
9
+ <xs:complexType name="DataItem">
10
+ <xs:annotation>
11
+ <xs:documentation>The Data-Item from the input XML message that caused the data exception to be raised.
12
+
13
+ Each Data Item consists of the name of the XML Element(s) that caused the exception to be raised, the value assigned to the element and an optional reference to the individual element of there is more than one of them in the XML Message.
14
+
15
+ </xs:documentation>
16
+ </xs:annotation>
17
+ <xs:sequence>
18
+ <xs:element name="ItemName" type="xs:string">
19
+ <xs:annotation>
20
+ <xs:documentation>The name of the data-item that was in error. This is that actual name of the element as it is in the message, for example:
21
+
22
+ &lt;MyElementName&gt;[Value]&lt;/MyElementName&gt;
23
+
24
+ would result in:
25
+
26
+ &lt;ItemName&gt;MyElementname&lt;/DataItem&gt;
27
+
28
+ </xs:documentation>
29
+ </xs:annotation>
30
+ </xs:element>
31
+ <xs:element name="Path" type="xs:string" minOccurs="0">
32
+ <xs:annotation>
33
+ <xs:documentation>The full X-Path to the XML Element containing the error.
34
+
35
+ This is required because there may be multiple data-items with the same name sometimes in separate functional components and sometimes the same functional component may occur multiple times. In both cases the Data-Item Name may not uniquely identify the actual error.</xs:documentation>
36
+ </xs:annotation>
37
+ </xs:element>
38
+ <xs:element name="Value" type="xs:anyType" minOccurs="0">
39
+ <xs:annotation>
40
+ <xs:documentation>The value that was in error.
41
+
42
+ This is an optional field because it may be the case where a mandatory data-item isn't present.</xs:documentation>
43
+ </xs:annotation>
44
+ </xs:element>
45
+ </xs:sequence>
46
+ </xs:complexType>
47
+ <xs:element name="ExceptionList" type="ExceptionList"/>
48
+ <xs:complexType name="ExceptionList">
49
+ <xs:sequence>
50
+ <xs:element name="Exception" type="Exception" maxOccurs="unbounded"/>
51
+ </xs:sequence>
52
+ </xs:complexType>
53
+ <xs:element name="Exception" type="Exception"/>
54
+ <xs:complexType name="Exception">
55
+ <xs:sequence>
56
+ <xs:element name="ErrorCode" type="pfdt:NumericString"/>
57
+ <xs:element name="ErrorMessage" type="pfdt:Sentence"/>
58
+ <xs:element name="DataItemList" type="DataItemList" minOccurs="0"/>
59
+ </xs:sequence>
60
+ </xs:complexType>
61
+ <xs:element name="DataItemList" type="DataItemList"/>
62
+ <xs:complexType name="DataItemList">
63
+ <xs:annotation>
64
+ <xs:documentation>The set of Data-Items that were instrumental in raising the exception.
65
+
66
+ This is an aggregation point for all of the Data-Items because there may be more than one Data-Item for each exception. For example if the check is that A = B and the check fails then the values of both A and B need to be returned as the context of the exception.</xs:documentation>
67
+ </xs:annotation>
68
+ <xs:sequence>
69
+ <xs:element name="DataItem" type="DataItem" maxOccurs="unbounded"/>
70
+ </xs:sequence>
71
+ </xs:complexType>
72
+ </xs:schema>
@@ -1,5 +1,17 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:CS="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/CommonStructures" xmlns:ERR="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/Exceptions" xmlns:pfdt="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" xmlns:HIP="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP" elementFormDefault="qualified" attributeFormDefault="unqualified" version="LIG-14.0">
2
+ <xs:schema
3
+ xmlns:xs="http://www.w3.org/2001/XMLSchema"
4
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5
+ xmlns:CS="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/CommonStructures"
6
+ xmlns:ERR="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/Exceptions"
7
+ xmlns:pfdt="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes"
8
+ xmlns:SAP05="http://www.est.org.uk/epc/lodgement/estV20/DCLG-SAP05"
9
+ xmlns:HIP="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP"
10
+ targetNamespace="http://www.est.org.uk/epc/lodgement"
11
+ elementFormDefault="qualified"
12
+ attributeFormDefault="unqualified"
13
+ version="LIG-12.0"
14
+ >
3
15
  <!--
4
16
  © 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.
5
17
 
@@ -13,28 +25,25 @@
13
25
  <xs:import namespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" schemaLocation="../UDT/BaseDataTypes.xsd"/>
14
26
  <!-- Include templates for all Business Entities used by the message -->
15
27
  <xs:import namespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP" schemaLocation="../Templates/HIP-Reports.xsd"/>
28
+ <!-- Add the New build SAP-EPC data model -->
29
+ <!--<xs:import namespace="http://www.est.org.uk/epc/lodgement/DCLG-SAP05" schemaLocation="../SAP-EPC/Templates/SAP05-Report.xsd"/>-->
16
30
  <!--***************************************************************************
17
31
  Message Definition
18
32
  *************************************************************************** -->
19
- <xs:element name="PropertyUPRNValidationRequest_1">
33
+ <xs:element name="ConditionReportCreateRequest_1">
20
34
  <xs:complexType>
21
35
  <xs:sequence>
22
- <xs:element name="Identification">
23
- <xs:complexType>
24
- <xs:complexContent>
25
- <xs:extension base="CS:DefaultIdBlock">
26
- <xs:sequence>
27
- <xs:element name="UPRN" type="HIP:UPRNType"/>
28
- </xs:sequence>
29
- </xs:extension>
30
- </xs:complexContent>
31
- </xs:complexType>
32
- </xs:element>
36
+ <xs:element name="Identification" type="CS:DefaultIdBlock"/>
37
+ <xs:element name="Configuration" type="CS:CreateRequestConfigBlock"/>
33
38
  <xs:element name="Content">
34
39
  <xs:complexType>
35
40
  <xs:sequence>
36
- <xs:element name="Address" type="HIP:AddressType"/>
37
- <xs:element name="Language" type="pfdt:LanguageCode" default="1"/>
41
+ <xs:choice>
42
+ <!--<xs:element name="SAP-EPC-Data" type="SAP05:Energy-Performance-Certificate"/>-->
43
+ <xs:element name="EPC-Data" type="HIP:Energy-Performance-Certificate"/>
44
+ <xs:element name="HCR-Data" type="HIP:Home-Condition-Report"/>
45
+ </xs:choice>
46
+ <xs:element name="PDF" type="xs:base64Binary"/>
38
47
  </xs:sequence>
39
48
  </xs:complexType>
40
49
  </xs:element>
@@ -1,21 +1,11 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <xs:schema targetNamespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-SAP05" xmlns="http://www.est.org.uk/epc/lodgement/estV20/DCLG-SAP05" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bdt="http://www.est.org.uk/epc/lodgement/estV20/DCLG-SAP05/BaseDataTypes" xmlns:SAP05="http://www.est.org.uk/epc/lodgement/estV20/DCLG-SAP05" elementFormDefault="qualified" version="LIG-14.0">
3
- <xs:import namespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-SAP05/BaseDataTypes" schemaLocation="../UDT/BaseDataTypes.xsd"/>
2
+ <xs:schema targetNamespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP" xmlns="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:pfdt="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" xmlns:HIP="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP" version="LIG-12.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:import namespace="http://www.est.org.uk/epc/lodgement/estV20/DCLG-HIP/BaseDataTypes" schemaLocation="../UDT/BaseDataTypes.xsd"/>
7
+ <xs:include schemaLocation="../UDT/SAP-Domains.xsd"/>
4
8
  <xs:include schemaLocation="../UDT/EPC-Domains.xsd"/>
5
- <xs:include schemaLocation="../UDT/SAP05-Domains.xsd"/>
6
- <xs:element name="LZC-Energy-Sources" type="LZC-Energy-Sources"/>
7
- <xs:complexType name="LZC-Energy-Sources">
8
- <xs:annotation>
9
- <xs:documentation>Details of low and zero carbon energy source(s) for the property, if any.</xs:documentation>
10
- </xs:annotation>
11
- <xs:sequence>
12
- <xs:element name="LZC-Energy-Source" type="SAP-LZCEnergySourceCode" minOccurs="1" maxOccurs="unbounded">
13
- <xs:annotation>
14
- <xs:documentation>Low and zero carbon energy source(s) for the property.</xs:documentation>
15
- </xs:annotation>
16
- </xs:element>
17
- </xs:sequence>
18
- </xs:complexType>
19
9
  <xs:simpleType name="EnergyRatingType">
20
10
  <xs:restriction base="xs:integer">
21
11
  <xs:minInclusive value="0"/>
@@ -26,15 +16,9 @@
26
16
  <xs:annotation>
27
17
  <xs:documentation>Energy Efficiency Assessment Report is an inspection report whose purpose is to assess the energy efficiency of the inspected property and provide energy ratings for the significant heat-loss features of the property.
28
18
 
29
- The report also identifies a number of potential improvements that may be made to the property in order to increase the energy efficiency.
30
- </xs:documentation>
19
+ The report also identifies a number of potential improvements that may be made to the property in order to increase the energy efficiency.</xs:documentation>
31
20
  </xs:annotation>
32
21
  <xs:all>
33
- <xs:element name="Assessment-Date" type="xs:date" minOccurs="1" maxOccurs="1">
34
- <xs:annotation>
35
- <xs:documentation>Date of assessment.</xs:documentation>
36
- </xs:annotation>
37
- </xs:element>
38
22
  <xs:element name="Property-Summary" type="Property-Summary" minOccurs="1" maxOccurs="1"/>
39
23
  <xs:element name="Energy-Use" type="Energy-Use" minOccurs="1" maxOccurs="1"/>
40
24
  <xs:element name="Suggested-Improvements" type="Suggested-Improvements" minOccurs="0" maxOccurs="1"/>
@@ -44,46 +28,17 @@ The report also identifies a number of potential improvements that may be made t
44
28
  <xs:element name="Property-Summary" type="Property-Summary"/>
45
29
  <xs:complexType name="Property-Summary">
46
30
  <xs:sequence>
47
- <xs:element name="Walls" type="PropertySummaryType" minOccurs="1" maxOccurs="unbounded"/>
31
+ <xs:element name="Wall" type="PropertySummaryType" minOccurs="1" maxOccurs="unbounded"/>
48
32
  <xs:element name="Roof" type="PropertySummaryType" minOccurs="1" maxOccurs="unbounded"/>
49
33
  <xs:element name="Floor" type="PropertySummaryType" minOccurs="1" maxOccurs="unbounded"/>
50
- <xs:element name="Windows" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
34
+ <xs:element name="Window" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
51
35
  <xs:element name="Main-Heating" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
52
36
  <xs:element name="Main-Heating-Controls" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
53
- <xs:element name="Secondary-Heating" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
54
37
  <xs:element name="Hot-Water" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
55
38
  <xs:element name="Lighting" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
56
- <xs:element name="Air-Tightness" type="PropertySummaryType" minOccurs="0" maxOccurs="1"/>
57
- <xs:element name="Has-Fixed-Air-Conditioning" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false">
58
- <xs:annotation>
59
- <xs:documentation>Fixed air conditioning?</xs:documentation>
60
- </xs:annotation>
61
- </xs:element>
62
- <xs:element name="Has-Hot-Water-Cylinder" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false">
63
- <xs:annotation>
64
- <xs:documentation>Hot water cylinder?</xs:documentation>
65
- </xs:annotation>
66
- </xs:element>
67
- <xs:element name="Has-Heated-Separate-Conservatory" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false">
68
- <xs:annotation>
69
- <xs:documentation>Heated separate conservatory?</xs:documentation>
70
- </xs:annotation>
71
- </xs:element>
72
- <xs:element name="Dwelling-Type" type="bdt:Sentence" minOccurs="0" maxOccurs="1">
73
- <xs:annotation>
74
- <xs:documentation>Is a string such as Detached house or Top-floor flat</xs:documentation>
75
- </xs:annotation>
76
- </xs:element>
77
- <xs:element name="Total-Floor-Area" type="xs:positiveInteger" minOccurs="0" maxOccurs="1">
78
- <xs:annotation>
79
- <xs:documentation>Is a number such as 125</xs:documentation>
80
- </xs:annotation>
81
- </xs:element>
82
- <xs:element name="Is-Zero-Carbon-Home" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false">
83
- <xs:annotation>
84
- <xs:documentation>Is dwelling a Zero Carbon Home?</xs:documentation>
85
- </xs:annotation>
86
- </xs:element>
39
+ <xs:element name="Secondary-Heating" type="PropertySummaryType" minOccurs="1" maxOccurs="1"/>
40
+ <xs:element name="Has-Hot-Water-Cylinder" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false"/>
41
+ <xs:element name="Has-Heated-Separate-Conservatory" type="xs:boolean" minOccurs="0" maxOccurs="1" default="false"/>
87
42
  </xs:sequence>
88
43
  </xs:complexType>
89
44
  <xs:element name="Energy-Use" type="Energy-Use"/>
@@ -112,57 +67,57 @@ The report also identifies a number of potential improvements that may be made t
112
67
  <xs:documentation>The estimated potential Environmental Impact Rating of the property</xs:documentation>
113
68
  </xs:annotation>
114
69
  </xs:element>
115
- <xs:element name="Energy-Consumption-Current" type="bdt:Measurement" minOccurs="1" maxOccurs="1">
70
+ <xs:element name="Energy-Consumption-Current" type="pfdt:Measurement" minOccurs="1" maxOccurs="1">
116
71
  <xs:annotation>
117
72
  <xs:documentation>Estimated total energy consumption for the Property in a 12 month period. Value is Kilowatt Hours per Square Metre (kWh/m2)</xs:documentation>
118
73
  </xs:annotation>
119
74
  </xs:element>
120
- <xs:element name="Energy-Consumption-Potential" type="bdt:Measurement" minOccurs="1" maxOccurs="1">
75
+ <xs:element name="Energy-Consumption-Potential" type="pfdt:Measurement" minOccurs="1" maxOccurs="1">
121
76
  <xs:annotation>
122
77
  <xs:documentation>Estimated total energy consumption for the Property in a 12 month period. Value is Kilowatt Hours per Square Metre (kWh/m2)</xs:documentation>
123
78
  </xs:annotation>
124
79
  </xs:element>
125
- <xs:element name="CO2-Emissions-Current" type="bdt:Measurement" minOccurs="1" maxOccurs="1">
80
+ <xs:element name="CO2-Emissions-Current" type="pfdt:Measurement" minOccurs="1" maxOccurs="1">
126
81
  <xs:annotation>
127
82
  <xs:documentation>CO2 emissions per year in tonnes/year.</xs:documentation>
128
83
  </xs:annotation>
129
84
  </xs:element>
130
- <xs:element name="CO2-Emissions-Current-Per-Floor-Area" type="bdt:Measurement" minOccurs="1" maxOccurs="1">
85
+ <xs:element name="CO2-Emissions-Current-Per-Floor-Area" type="pfdt:Measurement" minOccurs="1" maxOccurs="1">
131
86
  <xs:annotation>
132
87
  <xs:documentation>CO2 emissions per square metre floor area per year in kg/m².</xs:documentation>
133
88
  </xs:annotation>
134
89
  </xs:element>
135
- <xs:element name="CO2-Emissions-Potential" type="bdt:Measurement" minOccurs="1" maxOccurs="1">
90
+ <xs:element name="CO2-Emissions-Potential" type="pfdt:Measurement" minOccurs="1" maxOccurs="1">
136
91
  <xs:annotation>
137
92
  <xs:documentation>Estimated value in Tonnes per Year of the total CO2 emissions produced by the Property in 12 month period.</xs:documentation>
138
93
  </xs:annotation>
139
94
  </xs:element>
140
- <xs:element name="Lighting-Cost-Current" type="bdt:Money" minOccurs="1" maxOccurs="1">
95
+ <xs:element name="Lighting-Cost-Current" type="pfdt:Money" minOccurs="1" maxOccurs="1">
141
96
  <xs:annotation>
142
97
  <xs:documentation>The current estimated cost of Lighting for the property</xs:documentation>
143
98
  </xs:annotation>
144
99
  </xs:element>
145
- <xs:element name="Lighting-Cost-Potential" type="bdt:Money" minOccurs="1" maxOccurs="1">
100
+ <xs:element name="Lighting-Cost-Potential" type="pfdt:Money" minOccurs="1" maxOccurs="1">
146
101
  <xs:annotation>
147
102
  <xs:documentation>The current estimated cost of Lighting for the property</xs:documentation>
148
103
  </xs:annotation>
149
104
  </xs:element>
150
- <xs:element name="Heating-Cost-Current" type="bdt:Money" minOccurs="1" maxOccurs="1">
105
+ <xs:element name="Heating-Cost-Current" type="pfdt:Money" minOccurs="1" maxOccurs="1">
151
106
  <xs:annotation>
152
107
  <xs:documentation>The current estimated cost of Heating for the property</xs:documentation>
153
108
  </xs:annotation>
154
109
  </xs:element>
155
- <xs:element name="Heating-Cost-Potential" type="bdt:Money" minOccurs="1" maxOccurs="1">
110
+ <xs:element name="Heating-Cost-Potential" type="pfdt:Money" minOccurs="1" maxOccurs="1">
156
111
  <xs:annotation>
157
112
  <xs:documentation>The current estimated cost of Heating for the property</xs:documentation>
158
113
  </xs:annotation>
159
114
  </xs:element>
160
- <xs:element name="Hot-Water-Cost-Current" type="bdt:Money" minOccurs="1" maxOccurs="1">
115
+ <xs:element name="Hot-Water-Cost-Current" type="pfdt:Money" minOccurs="1" maxOccurs="1">
161
116
  <xs:annotation>
162
117
  <xs:documentation>|The current estimated cost of Hot Water for the property</xs:documentation>
163
118
  </xs:annotation>
164
119
  </xs:element>
165
- <xs:element name="Hot-Water-Cost-Potential" type="bdt:Money" minOccurs="1" maxOccurs="1">
120
+ <xs:element name="Hot-Water-Cost-Potential" type="pfdt:Money" minOccurs="1" maxOccurs="1">
166
121
  <xs:annotation>
167
122
  <xs:documentation>|The current estimated cost of Hot Water for the property</xs:documentation>
168
123
  </xs:annotation>
@@ -190,67 +145,45 @@ The Improved Energy Ratings that result from carrying out a Suggested Improvemen
190
145
  </xs:element>
191
146
  <xs:element name="Improvement-Category" type="RecommendationCategoryCode" minOccurs="1" maxOccurs="1">
192
147
  <xs:annotation>
193
- <xs:documentation>The category of improvement. This identifies where on the report the recommendation is printed.</xs:documentation>
148
+ <xs:documentation>The categfory of improvement. This identifies where on the report the recommendation is printed.</xs:documentation>
194
149
  </xs:annotation>
195
150
  </xs:element>
196
- <xs:element name="Improvement-Type" type="SAP-ImprovementMeasureCode" minOccurs="1" maxOccurs="1">
151
+ <xs:element name="Improvement-Summary" type="pfdt:Sentence" minOccurs="0" maxOccurs="1">
197
152
  <xs:annotation>
198
- <xs:documentation>Suggested work to be carried out on the Property to improve its energy efficiency. This should be a enumerated list of acceptable improvements but it hasn't yet been defined.</xs:documentation>
153
+ <xs:documentation>A short description of the suggested improvement.</xs:documentation>
199
154
  </xs:annotation>
200
155
  </xs:element>
201
- <xs:element name="Typical-Saving" type="bdt:Money" minOccurs="1" maxOccurs="1">
156
+ <xs:element name="Improvement-Heading" type="pfdt:Sentence" minOccurs="0" maxOccurs="1">
202
157
  <xs:annotation>
203
- <xs:documentation>Typical savings (in British Pounds) per year if the suggested improvement is carried out.</xs:documentation>
204
- </xs:annotation>
205
- </xs:element>
206
- <xs:element name="Energy-Performance-Rating" type="EnergyRatingType" minOccurs="1" maxOccurs="1">
207
- <xs:annotation>
208
- <xs:documentation>The estimated Energy performance rating of the Property after the Suggested Improvement has been carried out providing any preceding Suggested Improvement has also been carried out.</xs:documentation>
158
+ <xs:documentation>Text to precede the improvement description. If this field is not provided the 'Improvement-Summary' is used instead.</xs:documentation>
209
159
  </xs:annotation>
210
160
  </xs:element>
211
- <xs:element name="Environmental-Impact-Rating" type="EnergyRatingType" minOccurs="1" maxOccurs="1">
161
+ <xs:element name="Improvement-Description" type="pfdt:Sentence" minOccurs="1" maxOccurs="1">
212
162
  <xs:annotation>
213
- <xs:documentation>The estimated Environmental Impact rating of the Property after the Suggested Improvement has been carried out providing any preceding Suggested Improvement has also been carried out.</xs:documentation>
163
+ <xs:documentation>Detailed description of the suggested improvement.</xs:documentation>
214
164
  </xs:annotation>
215
165
  </xs:element>
216
- <xs:element name="Improvement-Details">
217
- <xs:complexType>
218
- <xs:choice>
219
- <xs:element name="Improvement-Texts" type="ImprovementTexts" minOccurs="1" maxOccurs="1">
220
- <xs:annotation>
221
- <xs:documentation>For backward compatability only</xs:documentation>
222
- </xs:annotation>
223
- </xs:element>
224
- <xs:element name="Improvement-Number" type="RecommendationSummaryCode" minOccurs="1" maxOccurs="1"/>
225
- </xs:choice>
226
- </xs:complexType>
227
- </xs:element>
228
- </xs:all>
229
- </xs:complexType>
230
- <xs:element name="ImprovementTexts" type="ImprovementTexts"/>
231
- <xs:complexType name="ImprovementTexts">
232
- <xs:sequence>
233
- <xs:element name="Improvement-Summary" type="bdt:Sentence" minOccurs="0" maxOccurs="1">
166
+ <xs:element name="Typical-Saving" type="pfdt:Money" minOccurs="1" maxOccurs="1">
234
167
  <xs:annotation>
235
- <xs:documentation>A short description of the suggested improvement.</xs:documentation>
168
+ <xs:documentation>Typical savings (in British Pounds) per year if the suggested improvement is carried out.</xs:documentation>
236
169
  </xs:annotation>
237
170
  </xs:element>
238
- <xs:element name="Improvement-Heading" type="bdt:Sentence" minOccurs="0" maxOccurs="1">
171
+ <xs:element name="Energy-Performance-Rating" type="EnergyRatingType" minOccurs="1" maxOccurs="1">
239
172
  <xs:annotation>
240
- <xs:documentation>Text to precede the improvement description. If this field is not provided the 'Improvement-Summary' is used instead.</xs:documentation>
173
+ <xs:documentation>The estimated Energy performance rating of the Property after the Suggested Improvement has been carried out providing any preceding Suggested Improvement has also been carried out.</xs:documentation>
241
174
  </xs:annotation>
242
175
  </xs:element>
243
- <xs:element name="Improvement-Description" type="bdt:Sentence" minOccurs="1" maxOccurs="1">
176
+ <xs:element name="Environmental-Impact-Rating" type="EnergyRatingType" minOccurs="1" maxOccurs="1">
244
177
  <xs:annotation>
245
- <xs:documentation>Detailed description of the suggested improvement.</xs:documentation>
178
+ <xs:documentation>The estimated Environmental Impact rating of the Property after the Suggested Improvement has been carried out providing any preceding Suggested Improvement has also been carried out.</xs:documentation>
246
179
  </xs:annotation>
247
180
  </xs:element>
248
- </xs:sequence>
181
+ </xs:all>
249
182
  </xs:complexType>
250
183
  <xs:element name="PropertySummaryType" type="PropertySummaryType"/>
251
184
  <xs:complexType name="PropertySummaryType">
252
185
  <xs:all>
253
- <xs:element name="Description" type="bdt:Sentence" minOccurs="0" maxOccurs="1">
186
+ <xs:element name="Description" type="pfdt:Sentence" minOccurs="1" maxOccurs="1">
254
187
  <xs:annotation>
255
188
  <xs:documentation>Overall description of the property feature</xs:documentation>
256
189
  </xs:annotation>
@@ -267,4 +200,14 @@ The Improved Energy Ratings that result from carrying out a Suggested Improvemen
267
200
  </xs:element>
268
201
  </xs:all>
269
202
  </xs:complexType>
203
+ <xs:element name="LZC-Energy-Sources" type="LZC-Energy-Sources"/>
204
+ <xs:complexType name="LZC-Energy-Sources">
205
+ <xs:sequence>
206
+ <xs:element name="LZC-Energy-Source" type="SAP-LZCEnergySourceCode" minOccurs="1" maxOccurs="unbounded">
207
+ <xs:annotation>
208
+ <xs:documentation>Low and zero carbon energy source(s) for the property.</xs:documentation>
209
+ </xs:annotation>
210
+ </xs:element>
211
+ </xs:sequence>
212
+ </xs:complexType>
270
213
  </xs:schema>