@viadukt/connect 2.13.0-next.1 → 3.0.0-next.2
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.
- package/dist/index.d.ts +188 -1685
- package/dist/index.js +43 -866
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -19,807 +19,6 @@ var __spreadValues = (a, b) => {
|
|
|
19
19
|
var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
|
|
20
20
|
|
|
21
21
|
// src/schemas.gen.ts
|
|
22
|
-
var $LookupPropertiesV2 = {
|
|
23
|
-
type: "object",
|
|
24
|
-
properties: {
|
|
25
|
-
street: {
|
|
26
|
-
type: ["string", "null"],
|
|
27
|
-
description: `
|
|
28
|
-
The \`street\` field specifies the street name of a building.
|
|
29
|
-
|
|
30
|
-
The field is set to \`null\` if the street is unknown.`,
|
|
31
|
-
example: "Friedrich Ebert Stra\xDFe"
|
|
32
|
-
},
|
|
33
|
-
city: {
|
|
34
|
-
type: ["string", "null"],
|
|
35
|
-
description: `
|
|
36
|
-
The \`city\` field specifies the city name of a building.
|
|
37
|
-
|
|
38
|
-
The field is set to \`null\` if the city is unknown.`,
|
|
39
|
-
example: "Wuppertal"
|
|
40
|
-
},
|
|
41
|
-
street_number: {
|
|
42
|
-
type: ["string", "null"],
|
|
43
|
-
description: `
|
|
44
|
-
The \`street_number\` field specifies the street number name of a building.
|
|
45
|
-
|
|
46
|
-
The field is set to \`null\` if the street number is unknown.`,
|
|
47
|
-
example: "107"
|
|
48
|
-
},
|
|
49
|
-
postcode: {
|
|
50
|
-
type: ["string", "null"],
|
|
51
|
-
description: `
|
|
52
|
-
The \`postcode\` field specifies the postcode of a building.
|
|
53
|
-
|
|
54
|
-
The field is set to \`null\` if the postcode is unknown.`,
|
|
55
|
-
example: "107"
|
|
56
|
-
},
|
|
57
|
-
roof_type: {
|
|
58
|
-
type: ["string", "null"],
|
|
59
|
-
enum: ["flat", "pitched", "mixed"],
|
|
60
|
-
description: `
|
|
61
|
-
The \`roof_type\` field specifies the type of roof of a building. This field can have one of the following values:
|
|
62
|
-
|
|
63
|
-
- **flat**: Flat roof
|
|
64
|
-
- **pitched**: Pitched roof
|
|
65
|
-
- **mixed**: Mixed types of roofs
|
|
66
|
-
|
|
67
|
-
The field is set to \`null\` if the building type is unknown.`,
|
|
68
|
-
example: "flat"
|
|
69
|
-
},
|
|
70
|
-
type: {
|
|
71
|
-
type: ["string", "null"],
|
|
72
|
-
enum: ["single_family", "multi_family", "non_residential", "mixed_use"],
|
|
73
|
-
description: `
|
|
74
|
-
The \`type\` field specifies the type of building. This field can have one of the following values:
|
|
75
|
-
|
|
76
|
-
- **single_family**: Single-family house
|
|
77
|
-
- **multi_family**: Multi-family house
|
|
78
|
-
- **non_residential**: Non-residential building
|
|
79
|
-
- **mixed_use**: Mixed-use building
|
|
80
|
-
|
|
81
|
-
The field is set to \`null\` if the building type is unknown.`,
|
|
82
|
-
example: "single_family"
|
|
83
|
-
},
|
|
84
|
-
type_class: {
|
|
85
|
-
type: ["number", "null"],
|
|
86
|
-
minimum: 1,
|
|
87
|
-
maximum: 4,
|
|
88
|
-
description: `
|
|
89
|
-
The \`type_class\` field specifies the class of the building type. This field can have one of the following values:
|
|
90
|
-
|
|
91
|
-
- **1**: Single-family house
|
|
92
|
-
- **2**: Multi-family house
|
|
93
|
-
- **3**: Non-residential building
|
|
94
|
-
- **4**: Mixed-use building
|
|
95
|
-
|
|
96
|
-
The field is set to \`null\` if the building type is unknown.`,
|
|
97
|
-
example: 1
|
|
98
|
-
},
|
|
99
|
-
water_protected: {
|
|
100
|
-
type: ["boolean", "null"],
|
|
101
|
-
description: `
|
|
102
|
-
The \`water_protected\` field specifies whether the building is within a water protection area.
|
|
103
|
-
|
|
104
|
-
If the field is set to \`null\`, no water protection area could be assigned.`,
|
|
105
|
-
example: true
|
|
106
|
-
},
|
|
107
|
-
heated: {
|
|
108
|
-
type: ["boolean", "null"],
|
|
109
|
-
description: `
|
|
110
|
-
The \`heated\` field specifies whether the building is heated or not.
|
|
111
|
-
|
|
112
|
-
The field is set to \`null\` if the heating status is unknown.`,
|
|
113
|
-
example: true
|
|
114
|
-
},
|
|
115
|
-
heat_demand: {
|
|
116
|
-
type: ["number", "null"],
|
|
117
|
-
minimum: 0,
|
|
118
|
-
description: `
|
|
119
|
-
The \`heat_demand\` field specifies the heat demand of the building in [kWh/m\xB2a].
|
|
120
|
-
|
|
121
|
-
This attribute is deprecated and thus always set to \`null\`.
|
|
122
|
-
|
|
123
|
-
<br /><br />**Warning:**<br /><br />
|
|
124
|
-
|
|
125
|
-
This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.
|
|
126
|
-
`,
|
|
127
|
-
example: 127.42,
|
|
128
|
-
deprecated: true
|
|
129
|
-
},
|
|
130
|
-
height_category: {
|
|
131
|
-
type: ["string", "null"],
|
|
132
|
-
enum: ["<= 5m", "<= 7.5m", "<= 10m", "<= 12.5m", "<= 15m", "> 15m"],
|
|
133
|
-
description: `
|
|
134
|
-
The \`height_category\` field specifies the height category of the building. The height category is a
|
|
135
|
-
number between 1 and 6, where 1 is the lowest and 6 is the highest category.
|
|
136
|
-
|
|
137
|
-
### Classifications
|
|
138
|
-
|
|
139
|
-
- **1**: <= 5m
|
|
140
|
-
- **2**: <= 7.5m
|
|
141
|
-
- **3**: <= 10m
|
|
142
|
-
- **4**: <= 12.5m
|
|
143
|
-
- **5**: <= 15m
|
|
144
|
-
- **6**: > 15m
|
|
145
|
-
|
|
146
|
-
If the height category is unknown, the field is set to \`null\`.
|
|
147
|
-
|
|
148
|
-
<br /><br />**Warning:**<br /><br />
|
|
149
|
-
|
|
150
|
-
This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.
|
|
151
|
-
`,
|
|
152
|
-
example: "<= 5m",
|
|
153
|
-
deprecated: true
|
|
154
|
-
},
|
|
155
|
-
height_category_class: {
|
|
156
|
-
type: ["number", "null"],
|
|
157
|
-
minimum: 1,
|
|
158
|
-
maximum: 6,
|
|
159
|
-
description: `
|
|
160
|
-
The \`height_category_class\` field specifies the height category of the building. The height category is a
|
|
161
|
-
number between 1 and 6, where 1 is the lowest and 6 is the highest category.
|
|
162
|
-
|
|
163
|
-
### Classifications
|
|
164
|
-
|
|
165
|
-
- **1**: <= 5m
|
|
166
|
-
- **2**: <= 7.5m
|
|
167
|
-
- **3**: <= 10m
|
|
168
|
-
- **4**: <= 12.5m
|
|
169
|
-
- **5**: <= 15m
|
|
170
|
-
- **6**: > 15m
|
|
171
|
-
|
|
172
|
-
The field is set to \`null\` if the number of height category is unknown.
|
|
173
|
-
|
|
174
|
-
<br /><br />**Warning:**<br /><br />
|
|
175
|
-
|
|
176
|
-
This field is deprecated and will be no longer supported in future datasets.`,
|
|
177
|
-
example: 1,
|
|
178
|
-
deprecated: true
|
|
179
|
-
},
|
|
180
|
-
levels: {
|
|
181
|
-
type: ["number", "null"],
|
|
182
|
-
minimum: 1,
|
|
183
|
-
description: `
|
|
184
|
-
The \`levels\` field specifies the number of levels in the building.
|
|
185
|
-
|
|
186
|
-
The field is set to \`null\` if the number of levels is unknown.`,
|
|
187
|
-
example: 4
|
|
188
|
-
},
|
|
189
|
-
household_count: {
|
|
190
|
-
type: ["number", "null"],
|
|
191
|
-
minimum: 0,
|
|
192
|
-
description: `
|
|
193
|
-
The \`household_count\` field specifies the number of households in the building.
|
|
194
|
-
|
|
195
|
-
The field is set to \`null\` if the number of households is unknown.`,
|
|
196
|
-
example: 3
|
|
197
|
-
},
|
|
198
|
-
net_area: {
|
|
199
|
-
type: ["number", "null"],
|
|
200
|
-
minimum: 0,
|
|
201
|
-
description: `
|
|
202
|
-
The \`net_area\` field specifies the net area of the building in m\xB2.
|
|
203
|
-
|
|
204
|
-
The field is set to \`null\` if the net area is unknown.
|
|
205
|
-
|
|
206
|
-
The \`net_area\` was modeled according to the Raumw\xE4rmebedarfsmodell NRW as:
|
|
207
|
-
\`footprint_area\` * \`levels\` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)
|
|
208
|
-
the latter was done to concider e.g., inner wall area or staircases.`,
|
|
209
|
-
example: 127.42
|
|
210
|
-
},
|
|
211
|
-
footprint_area: {
|
|
212
|
-
type: ["number", "null"],
|
|
213
|
-
minimum: 0,
|
|
214
|
-
description: `
|
|
215
|
-
The \`footprint_area\` field specifies the footprint area of the building in m\xB2.
|
|
216
|
-
|
|
217
|
-
The field is set to \`null\` if the footprint area is unknown.`,
|
|
218
|
-
example: 127.42
|
|
219
|
-
},
|
|
220
|
-
usage: {
|
|
221
|
-
type: ["string", "null"],
|
|
222
|
-
enum: ["residential", "non_residential", "mixed_use"],
|
|
223
|
-
description: `
|
|
224
|
-
The \`usage\` field specifies the usage of the building. This field can have one of the following values:
|
|
225
|
-
|
|
226
|
-
- **residential**: Residential building
|
|
227
|
-
- **non_residential**: Non-residential building
|
|
228
|
-
- **mixed_use**: Mixed-use building
|
|
229
|
-
|
|
230
|
-
If the usage is unknown, the field is set to \`null\`.
|
|
231
|
-
|
|
232
|
-
<br /><br />**Warning:**<br /><br />
|
|
233
|
-
|
|
234
|
-
This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.`,
|
|
235
|
-
example: "residential",
|
|
236
|
-
deprecated: true
|
|
237
|
-
},
|
|
238
|
-
usage_class: {
|
|
239
|
-
type: ["number", "null"],
|
|
240
|
-
minimum: 1,
|
|
241
|
-
maximum: 3,
|
|
242
|
-
description: `
|
|
243
|
-
The \`usage_class\` field specifies the usage of the building. This field can have one of the following values:
|
|
244
|
-
|
|
245
|
-
- **1**: Residential building
|
|
246
|
-
- **2**: Non-residential building
|
|
247
|
-
- **3**: Mixed-use building
|
|
248
|
-
|
|
249
|
-
If the usage is unknown, the field is set to \`null\`.
|
|
250
|
-
|
|
251
|
-
<br /><br />**Warning:**<br /><br />
|
|
252
|
-
|
|
253
|
-
This field is deprecated and will be removed in future API versions. It is no longer actively supported and may be omitted from upcoming endpoints. We recommend updating your implementation to use the latest supported fields.`,
|
|
254
|
-
example: 1,
|
|
255
|
-
deprecated: true
|
|
256
|
-
},
|
|
257
|
-
characteristics: {
|
|
258
|
-
type: ["string", "null"],
|
|
259
|
-
enum: ["single_two_family", "row_semi_detached", "multi_family", "residential_block", "high_rise", "terrace", "farmhouse", "office_other", "factory_warehouse"],
|
|
260
|
-
description: `
|
|
261
|
-
The \`characteristics\` field defines the different types of building characteristics. This classification includes
|
|
262
|
-
various types of residential and non-residential buildings. This field can have one of the following values:
|
|
263
|
-
|
|
264
|
-
- **single_two_family**: Single- or two-family house
|
|
265
|
-
- **row_semi_detached**: Row or semi-detached house
|
|
266
|
-
- **multi_family**: Multi-family house
|
|
267
|
-
- **residential_block**: Residential block
|
|
268
|
-
- **high_rise**: High-rise residential building
|
|
269
|
-
- **terrace**: Terrace house
|
|
270
|
-
- **farmhouse**: Farmhouse
|
|
271
|
-
- **office_other**: Office or other building
|
|
272
|
-
- **factory_warehouse**: Factory or warehouse building
|
|
273
|
-
|
|
274
|
-
If the characteristics is unknown, the field is set to \`null\`.`,
|
|
275
|
-
example: "residential_block"
|
|
276
|
-
},
|
|
277
|
-
characteristics_class: {
|
|
278
|
-
type: ["number", "null"],
|
|
279
|
-
minimum: 1,
|
|
280
|
-
maximum: 9,
|
|
281
|
-
description: `
|
|
282
|
-
The \`characteristics_class\` field defines the different types of building characteristics. This classification includes
|
|
283
|
-
various types of residential and non-residential buildings. This field can have one of the following values:
|
|
284
|
-
|
|
285
|
-
- **1**: Single- or two-family house
|
|
286
|
-
- **2**: Row or semi-detached house
|
|
287
|
-
- **3**: Multi-family house
|
|
288
|
-
- **4**: Residential block
|
|
289
|
-
- **5**: High-rise residential building
|
|
290
|
-
- **6**: Terrace house
|
|
291
|
-
- **7**: Farmhouse
|
|
292
|
-
- **8**: Office or other building
|
|
293
|
-
- **9**: Factory or warehouse building
|
|
294
|
-
|
|
295
|
-
If the characteristics_class is unknown, the field is set to \`null\`.`,
|
|
296
|
-
example: 1
|
|
297
|
-
},
|
|
298
|
-
development_layout: {
|
|
299
|
-
type: ["string", "null"],
|
|
300
|
-
enum: ["non_detached", "semi_detached", "detached"],
|
|
301
|
-
description: `
|
|
302
|
-
The \`development_layout\` field specifies the layout of the building. This field can have one of the following values:
|
|
303
|
-
|
|
304
|
-
- **non_detached**: Non-detached building
|
|
305
|
-
- **semi_detached**: Semi-detached building
|
|
306
|
-
- **detached**: Detached building
|
|
307
|
-
|
|
308
|
-
If the development layout is unknown, the field is set to \`null\`.
|
|
309
|
-
|
|
310
|
-
The \`development_layout\` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)
|
|
311
|
-
neighbouring buildings and the perimeter of a geometry as follows:
|
|
312
|
-
|
|
313
|
-
**detached** = intersection_length / outline_length < 0.085
|
|
314
|
-
**semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection
|
|
315
|
-
**semi_detached** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections
|
|
316
|
-
**non_detached** = for all other buildings`,
|
|
317
|
-
example: "non_detached"
|
|
318
|
-
},
|
|
319
|
-
development_layout_class: {
|
|
320
|
-
type: ["number", "null"],
|
|
321
|
-
minimum: 1,
|
|
322
|
-
maximum: 3,
|
|
323
|
-
description: `
|
|
324
|
-
The \`development_layout_class\` field specifies the layout of the building. This field can have one of the following values:
|
|
325
|
-
|
|
326
|
-
- **1**: Non-detached building
|
|
327
|
-
- **2**: Semi-detached building
|
|
328
|
-
- **3**: Detached building
|
|
329
|
-
|
|
330
|
-
If the development layout is unknown, the field is set to \`null\`.
|
|
331
|
-
|
|
332
|
-
The \`development_layout_class\` was modeled based on the number and length of intersections with heated (and buildings with unknown heating status)
|
|
333
|
-
neighbouring buildings and the perimeter of a geometry as follows:
|
|
334
|
-
|
|
335
|
-
**1** = intersection_length / outline_length < 0.085
|
|
336
|
-
**2** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.45 for buildings with exactly 1 intersection
|
|
337
|
-
**2** = intersection_length / outline_length >= 0.085 AND intersection_length / outline_length < 0.15 for buildings with more than 1 intersections
|
|
338
|
-
**3** = for all other buildings`,
|
|
339
|
-
example: 1
|
|
340
|
-
},
|
|
341
|
-
construction_year_range: {
|
|
342
|
-
type: ["array", "null"],
|
|
343
|
-
prefixItems: [
|
|
344
|
-
{
|
|
345
|
-
type: ["number", "null"]
|
|
346
|
-
},
|
|
347
|
-
{
|
|
348
|
-
type: "number"
|
|
349
|
-
}
|
|
350
|
-
],
|
|
351
|
-
description: `
|
|
352
|
-
The \`construction_year_range\` field specifies the approximate construction year of the building. The field is a tuple with two
|
|
353
|
-
values: the lower and upper bound of the construction year and can have one of the following value:
|
|
354
|
-
|
|
355
|
-
- **[*null*, 1899]**: Construction year is somewhere up to 1899
|
|
356
|
-
- **[1900, 1945]**
|
|
357
|
-
- **[1946, 1960]**
|
|
358
|
-
- **[1961, 1970]**
|
|
359
|
-
- **[1971, 1980]**
|
|
360
|
-
- **[1981, 1985]**
|
|
361
|
-
- **[1986, 1995]**
|
|
362
|
-
- **[1996, 2000]**
|
|
363
|
-
- **[2001, 2005]**
|
|
364
|
-
- **[2006, 2010]**
|
|
365
|
-
- **[2011, 2015]**
|
|
366
|
-
- **[2016, 2024]**
|
|
367
|
-
|
|
368
|
-
If the construction year class is unknown, the field is set to \`null\`.`,
|
|
369
|
-
example: [1990, 1995]
|
|
370
|
-
},
|
|
371
|
-
construction_year_range_class: {
|
|
372
|
-
type: ["number", "null"],
|
|
373
|
-
minimum: 1,
|
|
374
|
-
maximum: 12,
|
|
375
|
-
description: `
|
|
376
|
-
The \`construction_year_range_class\` field specifies the approximate construction year of the building and can have one of the following values:
|
|
377
|
-
|
|
378
|
-
- **1**: < 1899
|
|
379
|
-
- **2**: 1900 - 1945
|
|
380
|
-
- **3**: 1946 - 1960
|
|
381
|
-
- **4**: 1961 - 1970
|
|
382
|
-
- **5**: 1971 - 1980
|
|
383
|
-
- **6**: 1981 - 1985
|
|
384
|
-
- **7**: 1986 - 1995
|
|
385
|
-
- **8**: 1996 - 2000
|
|
386
|
-
- **9**: 2001 - 2005
|
|
387
|
-
- **10**: 2006 - 2010
|
|
388
|
-
- **11**: 2011 - 2015
|
|
389
|
-
- **12**: 2016 - 2024
|
|
390
|
-
|
|
391
|
-
If the construction year range class is unknown, the field is set to \`null\`.`,
|
|
392
|
-
example: 1
|
|
393
|
-
},
|
|
394
|
-
construction_year: {
|
|
395
|
-
type: ["number", "null"],
|
|
396
|
-
minimum: 0,
|
|
397
|
-
description: `
|
|
398
|
-
The \`construction_year\` field specifies the construction year of the building.
|
|
399
|
-
|
|
400
|
-
If the construction year is unknown, the field is set to \`null\`.`,
|
|
401
|
-
example: 1993
|
|
402
|
-
},
|
|
403
|
-
heritage: {
|
|
404
|
-
type: ["boolean", "null"],
|
|
405
|
-
description: `
|
|
406
|
-
The \`heritage\` field specifies whether the building is under monumental protection.
|
|
407
|
-
|
|
408
|
-
The field is set to \`null\` if the heritage status is unknown.`,
|
|
409
|
-
example: true
|
|
410
|
-
},
|
|
411
|
-
geo_conductivity_100: {
|
|
412
|
-
type: ["number", "null"],
|
|
413
|
-
minimum: 0,
|
|
414
|
-
description: `
|
|
415
|
-
The \`geo_conductivity_100\` field specifies the geothermal conductivity in 100 m depth.
|
|
416
|
-
|
|
417
|
-
The field is set to \`null\` if the geothermal conductivity is unknown.`,
|
|
418
|
-
example: 2
|
|
419
|
-
},
|
|
420
|
-
heat_pump_air_possible: {
|
|
421
|
-
type: ["boolean", "null"],
|
|
422
|
-
description: `
|
|
423
|
-
The \`heat_pump_air_possible\` field indicates whether an air-source heat pump is a viable option for the building.
|
|
424
|
-
|
|
425
|
-
- Set to \`true\` if an air-source heat pump is feasible.
|
|
426
|
-
- Set to \`false\` if an air-source heat pump is not feasible.
|
|
427
|
-
- Set to \`null\` if the information is unknown.`,
|
|
428
|
-
example: true
|
|
429
|
-
},
|
|
430
|
-
heat_pump_maximal_distance_drillings: {
|
|
431
|
-
type: ["number", "null"],
|
|
432
|
-
minimum: 0,
|
|
433
|
-
description: `
|
|
434
|
-
The \`heat_pump_maximal_distance_drillings\` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
|
|
435
|
-
This field will be deprecated in future versions. Please use \`heat_pump_maximal_distance_drillings_5m\` instead.
|
|
436
|
-
|
|
437
|
-
The field is set to \`null\` if the information is unknown.`,
|
|
438
|
-
example: 100
|
|
439
|
-
},
|
|
440
|
-
heat_pump_maximal_distance_drillings_5m: {
|
|
441
|
-
type: ["number", "null"],
|
|
442
|
-
minimum: 0,
|
|
443
|
-
description: `
|
|
444
|
-
The \`heat_pump_maximal_distance_drillings_5m\` field specifies the maximum allowable distance between drillings for a heat pump installation, measured in meters.
|
|
445
|
-
|
|
446
|
-
The field is set to \`null\` if the information is unknown.`,
|
|
447
|
-
example: 100.35
|
|
448
|
-
},
|
|
449
|
-
heat_pump_minimal_number_possible_drillings: {
|
|
450
|
-
type: ["number", "null"],
|
|
451
|
-
minimum: 0,
|
|
452
|
-
description: `
|
|
453
|
-
The \`heat_pump_minimal_number_possible_drillings\` field specifies the minimum
|
|
454
|
-
number of drillings required for a heat pump installation with a distance of 5m
|
|
455
|
-
to the parcel border.
|
|
456
|
-
This field will be deprecated in future versions. Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead.
|
|
457
|
-
|
|
458
|
-
The field is set to \`null\` if the information is unknown.
|
|
459
|
-
|
|
460
|
-
<br /><br />**Deprecation Warning:**<br /><br />
|
|
461
|
-
|
|
462
|
-
Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead of this field.`,
|
|
463
|
-
example: 1,
|
|
464
|
-
deprecated: true
|
|
465
|
-
},
|
|
466
|
-
heat_pump_minimal_number_possible_drillings_5m: {
|
|
467
|
-
type: ["number", "null"],
|
|
468
|
-
minimum: 0,
|
|
469
|
-
description: `
|
|
470
|
-
The \`heat_pump_minimal_number_possible_drillings_5m\` field specifies the minimum
|
|
471
|
-
number of drillings required for a heat pump installation with a distance of 5m
|
|
472
|
-
to the parcel border.
|
|
473
|
-
|
|
474
|
-
The field is set to \`null\` if the information is unknown.`,
|
|
475
|
-
example: 1
|
|
476
|
-
},
|
|
477
|
-
heat_pump_minimal_number_possible_drillings_2m: {
|
|
478
|
-
type: ["number", "null"],
|
|
479
|
-
minimum: 0,
|
|
480
|
-
description: `
|
|
481
|
-
The \`heat_pump_minimal_number_possible_drillings_2m\` field specifies the minimum
|
|
482
|
-
number of drillings required for a heat pump installation with a distance of 2m
|
|
483
|
-
to the parcel border.
|
|
484
|
-
|
|
485
|
-
The field is set to \`null\` if the information is unknown.`,
|
|
486
|
-
example: 1
|
|
487
|
-
},
|
|
488
|
-
heat_pump_minimal_number_possible_drillings_no_distance: {
|
|
489
|
-
type: ["number", "null"],
|
|
490
|
-
minimum: 0,
|
|
491
|
-
description: `
|
|
492
|
-
The \`heat_pump_minimal_number_possible_drillings_no_distance\` field specifies the minimum
|
|
493
|
-
number of drillings required for a heat pump installation with no distance to the parcel border.
|
|
494
|
-
|
|
495
|
-
The field is set to \`null\` if the information is unknown.`,
|
|
496
|
-
example: 1
|
|
497
|
-
},
|
|
498
|
-
heat_pump_collector_free_area: {
|
|
499
|
-
type: ["number", "null"],
|
|
500
|
-
minimum: 0,
|
|
501
|
-
description: `
|
|
502
|
-
The \`heat_pump_collector_free_area\` field specifies the sum of the free area suitable
|
|
503
|
-
for a collector heat pump on parcels associated to a building.
|
|
504
|
-
|
|
505
|
-
The field is set to \`null\` if the information is unknown.`,
|
|
506
|
-
example: 100
|
|
507
|
-
},
|
|
508
|
-
flood_potential: {
|
|
509
|
-
type: ["array", "null"],
|
|
510
|
-
items: {
|
|
511
|
-
type: "object",
|
|
512
|
-
properties: {
|
|
513
|
-
min_recurrence: {
|
|
514
|
-
type: ["number", "null"],
|
|
515
|
-
minimum: 0
|
|
516
|
-
},
|
|
517
|
-
max_recurrence: {
|
|
518
|
-
type: ["number", "null"],
|
|
519
|
-
minimum: 0
|
|
520
|
-
},
|
|
521
|
-
protection_against_floods: {
|
|
522
|
-
type: ["boolean", "null"]
|
|
523
|
-
}
|
|
524
|
-
}
|
|
525
|
-
},
|
|
526
|
-
minItems: 1,
|
|
527
|
-
description: `
|
|
528
|
-
The \`flood_potential\` field is an array representing different flood risk scenarios for a given
|
|
529
|
-
location. The objects in the array can contain the following fields:
|
|
530
|
-
|
|
531
|
-
- \`min_reccurence\`: The minimum expected recurrence interval for flooding, measured in years.
|
|
532
|
-
This field is optional and can be \`null\` if the data is unavailable. A lower value indicates more
|
|
533
|
-
frequent flooding.
|
|
534
|
-
|
|
535
|
-
- \`max_reccurence\`: The maximum expected recurrence interval for flooding, also in years. This
|
|
536
|
-
field is optional and can be \`null\`. If provided, this value represents the upper bound of the
|
|
537
|
-
flood risk interval. This field allows the specification of a range of recurrence intervals.
|
|
538
|
-
|
|
539
|
-
- \`protection_against_floods\`: A boolean flag indicating whether flood protection measures are in
|
|
540
|
-
place for the area. This field is optional and can be \`null\` if the information is not available.
|
|
541
|
-
A value of \`true\` means flood defenses are present, while \`false\` indicates the absence of such
|
|
542
|
-
measures.
|
|
543
|
-
|
|
544
|
-
If this array is set to \`null\`, it means that no data regarding flood potential is available for the location.`,
|
|
545
|
-
example: [
|
|
546
|
-
{
|
|
547
|
-
min_recurrence: 100,
|
|
548
|
-
max_recurrence: null,
|
|
549
|
-
protection_against_floods: true
|
|
550
|
-
},
|
|
551
|
-
{
|
|
552
|
-
min_recurrence: 101,
|
|
553
|
-
max_recurrence: 1e3,
|
|
554
|
-
protection_against_floods: false
|
|
555
|
-
}
|
|
556
|
-
]
|
|
557
|
-
},
|
|
558
|
-
photovoltaic_potential: {
|
|
559
|
-
type: "object",
|
|
560
|
-
properties: {
|
|
561
|
-
suitable_roof_area: {
|
|
562
|
-
type: ["number", "null"],
|
|
563
|
-
minimum: 0,
|
|
564
|
-
description: `
|
|
565
|
-
The \`suitable_roof_area\` field specifies the roof area suited for photovoltaics [m^2].
|
|
566
|
-
|
|
567
|
-
The field is set to \`null\` if the roof area suited for photovoltaics is unknown.`,
|
|
568
|
-
example: 77
|
|
569
|
-
},
|
|
570
|
-
gross_collector_area: {
|
|
571
|
-
type: ["number", "null"],
|
|
572
|
-
minimum: 0,
|
|
573
|
-
description: `
|
|
574
|
-
The \`gross_collector_area\` field specifies the maximal collector area for photovoltaics including module frames [m^2].
|
|
575
|
-
|
|
576
|
-
The field is set to \`null\` if the maximal collector area for photovoltaics is unknown.`,
|
|
577
|
-
example: 48
|
|
578
|
-
},
|
|
579
|
-
net_collector_area: {
|
|
580
|
-
type: ["number", "null"],
|
|
581
|
-
minimum: 0,
|
|
582
|
-
description: `
|
|
583
|
-
The \`net_collector_area\` field specifies the maximal collector area for photovoltaics excluding module frames [m^2].
|
|
584
|
-
|
|
585
|
-
The field is set to \`null\` if the maximal collector area for photovoltaics excluding module frames is unknown.`,
|
|
586
|
-
example: 48
|
|
587
|
-
},
|
|
588
|
-
electricity_generation: {
|
|
589
|
-
type: ["number", "null"],
|
|
590
|
-
minimum: 0,
|
|
591
|
-
description: `
|
|
592
|
-
The \`electricity_generation\` field specifies the maximal electricity generation from photovoltaics of the building per year [kWh/a].
|
|
593
|
-
|
|
594
|
-
The field is set to \`null\` if the maximal electricity generation per year is unknown.`,
|
|
595
|
-
example: 6401
|
|
596
|
-
},
|
|
597
|
-
nominal_power: {
|
|
598
|
-
type: ["number", "null"],
|
|
599
|
-
minimum: 0,
|
|
600
|
-
description: `
|
|
601
|
-
The \`nominal_power\` field specifies the nominal power a photovoltaics system could have at this building per year [kWp].
|
|
602
|
-
|
|
603
|
-
The field is set to \`null\` if the the nominal power is unknown.`,
|
|
604
|
-
example: 7.5
|
|
605
|
-
}
|
|
606
|
-
},
|
|
607
|
-
required: ["suitable_roof_area", "gross_collector_area", "net_collector_area", "electricity_generation", "nominal_power"]
|
|
608
|
-
},
|
|
609
|
-
solarthermal_potential: {
|
|
610
|
-
type: "object",
|
|
611
|
-
properties: {
|
|
612
|
-
suitable_roof_area: {
|
|
613
|
-
type: ["number", "null"],
|
|
614
|
-
minimum: 0,
|
|
615
|
-
description: `
|
|
616
|
-
The \`st_suitable_roof_area\` field specifies the roof area suited for solarthermie [m^2].
|
|
617
|
-
|
|
618
|
-
The field is set to \`null\` if the roof area suited for solarthermie is unknown.`,
|
|
619
|
-
example: 90
|
|
620
|
-
},
|
|
621
|
-
heat_generation: {
|
|
622
|
-
type: ["number", "null"],
|
|
623
|
-
minimum: 0,
|
|
624
|
-
description: `
|
|
625
|
-
The \`st_heat_generation\` field specifies the potential solarthermic heat generation on this bulding [kWh/a].
|
|
626
|
-
|
|
627
|
-
The field is set to \`null\` if the heat generation by solarthermie is unknown.`,
|
|
628
|
-
example: 25201
|
|
629
|
-
},
|
|
630
|
-
net_collector_area: {
|
|
631
|
-
type: ["number", "null"],
|
|
632
|
-
minimum: 0,
|
|
633
|
-
description: `
|
|
634
|
-
The \`st_net_collector_area\` field specifies the maximal collector area for solarthermie [m^2].
|
|
635
|
-
|
|
636
|
-
The field is set to \`null\` if the maximal collector area for solarthermie is unknown.`,
|
|
637
|
-
example: 25201
|
|
638
|
-
}
|
|
639
|
-
},
|
|
640
|
-
required: ["suitable_roof_area", "heat_generation", "net_collector_area"]
|
|
641
|
-
},
|
|
642
|
-
matching_addresses: {
|
|
643
|
-
type: ["number", "null"],
|
|
644
|
-
minimum: 0,
|
|
645
|
-
description: `
|
|
646
|
-
The \`matching_addresses\` field indicates the number of addresses associated with the geometry.
|
|
647
|
-
|
|
648
|
-
The field is set to \`null\` if no matching addresses are found.`,
|
|
649
|
-
example: 1
|
|
650
|
-
},
|
|
651
|
-
eave_above_ground_weighted: {
|
|
652
|
-
type: ["number", "null"],
|
|
653
|
-
minimum: 0,
|
|
654
|
-
description: `
|
|
655
|
-
The \`eave_above_ground_weighted\` field specifies the weighted average height of the eave above ground [meters]. For weighting
|
|
656
|
-
the \`footprint_area\` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the
|
|
657
|
-
field \`number_original_geometries\`.
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
The field is set to \`null\` if the height is unknown.`,
|
|
661
|
-
example: 11.398919537428867
|
|
662
|
-
},
|
|
663
|
-
eave_above_ground_min: {
|
|
664
|
-
type: ["number", "null"],
|
|
665
|
-
minimum: 0,
|
|
666
|
-
description: `
|
|
667
|
-
The \`eave_above_ground_min\` field specifies the minimum height of the eave above ground [meters]. This is the minimal
|
|
668
|
-
\`eave_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis
|
|
669
|
-
of the field \`number_original_geometries\`.
|
|
670
|
-
|
|
671
|
-
The field is set to \`null\` if the height is unknown.`,
|
|
672
|
-
example: 5.7899932861328125
|
|
673
|
-
},
|
|
674
|
-
eave_above_ground_max: {
|
|
675
|
-
type: ["number", "null"],
|
|
676
|
-
minimum: 0,
|
|
677
|
-
description: `
|
|
678
|
-
The \`eave_above_ground_max\` field specifies the maximum height of the eave above ground [meters]. This is the maximal
|
|
679
|
-
\`eave_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of
|
|
680
|
-
the field \`number_original_geometries\`.
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
The field is set to \`null\` if the height is unknown.`,
|
|
684
|
-
example: 13.722991943359375
|
|
685
|
-
},
|
|
686
|
-
ridge_above_ground_weighted: {
|
|
687
|
-
type: ["number", "null"],
|
|
688
|
-
minimum: 0,
|
|
689
|
-
description: `
|
|
690
|
-
The \`ridge_above_ground_weighted\` field specifies the weighted average height of the ridge above ground [meters]. For
|
|
691
|
-
weighting the \`footprint_area\` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis
|
|
692
|
-
of the field \`number_original_geometries\`.
|
|
693
|
-
|
|
694
|
-
The field is set to \`null\` if the height is unknown.`,
|
|
695
|
-
example: 13.619256575276214
|
|
696
|
-
},
|
|
697
|
-
ridge_above_ground_min: {
|
|
698
|
-
type: ["number", "null"],
|
|
699
|
-
minimum: 0,
|
|
700
|
-
description: `
|
|
701
|
-
The \`ridge_above_ground_min\` field specifies the minimum height of the ridge above ground [meters]. This is the minimal
|
|
702
|
-
\`ridge_above_ground within\` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
|
|
703
|
-
field \`number_original_geometries\`.
|
|
704
|
-
|
|
705
|
-
The field is set to \`null\` if the height is unknown.`,
|
|
706
|
-
example: 6.64300537109375
|
|
707
|
-
},
|
|
708
|
-
ridge_above_ground_max: {
|
|
709
|
-
type: ["number", "null"],
|
|
710
|
-
minimum: 0,
|
|
711
|
-
description: `
|
|
712
|
-
The \`ridge_above_ground_max\` field specifies the maximum height of the ridge above ground [meters]. This is the maximal
|
|
713
|
-
\`ridge_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
|
|
714
|
-
field \`number_original_geometries\`.
|
|
715
|
-
|
|
716
|
-
The field is set to \`null\` if the height is unknown.`,
|
|
717
|
-
example: 16.987991333007812
|
|
718
|
-
},
|
|
719
|
-
number_original_geometries: {
|
|
720
|
-
type: ["number", "null"],
|
|
721
|
-
minimum: 0,
|
|
722
|
-
description: `
|
|
723
|
-
The \`number_original_geometries\` field specifies the number of original geometries used for weighted calculations.
|
|
724
|
-
|
|
725
|
-
The field is set to \`null\` if the count is unknown.`,
|
|
726
|
-
example: 3
|
|
727
|
-
},
|
|
728
|
-
roof_area: {
|
|
729
|
-
type: ["number", "null"],
|
|
730
|
-
minimum: 0,
|
|
731
|
-
description: `
|
|
732
|
-
The \`roof_area\` field specifies the total roof area of the building [square meters].
|
|
733
|
-
|
|
734
|
-
The field is set to \`null\` if the roof area is unknown.`,
|
|
735
|
-
example: 355.37342071533203
|
|
736
|
-
},
|
|
737
|
-
ogc_fid: {
|
|
738
|
-
type: ["string", "null"],
|
|
739
|
-
description: `
|
|
740
|
-
The \`ogc_fid\` field specifies a unique identifier from the LOD2 dataset.
|
|
741
|
-
|
|
742
|
-
The field is set to \`null\` if the identifier is unavailable.`,
|
|
743
|
-
example: "DENW29AL1000FzW2"
|
|
744
|
-
},
|
|
745
|
-
outer_wall_area_free: {
|
|
746
|
-
type: ["number", "null"],
|
|
747
|
-
minimum: 0,
|
|
748
|
-
description: `
|
|
749
|
-
The \`outer_wall_area_free\` field specifies the facade area free of adjacent structures [square meters].
|
|
750
|
-
|
|
751
|
-
The field is set to \`null\` if the area is unknown.`,
|
|
752
|
-
example: 690.5686635568186
|
|
753
|
-
},
|
|
754
|
-
outer_wall_area_shared_heated: {
|
|
755
|
-
type: ["number", "null"],
|
|
756
|
-
minimum: 0,
|
|
757
|
-
description: `
|
|
758
|
-
The \`outer_wall_area_shared_heated\` field specifies the facade area shared with heated adjacent structures [square meters].
|
|
759
|
-
|
|
760
|
-
The field is set to \`null\` if the area is unknown.`,
|
|
761
|
-
example: 202.10705297163204
|
|
762
|
-
},
|
|
763
|
-
outer_wall_area_shared_non_heated: {
|
|
764
|
-
type: ["number", "null"],
|
|
765
|
-
minimum: 0,
|
|
766
|
-
description: `
|
|
767
|
-
The \`outer_wall_area_shared_non_heated\` field specifies the facade area shared with non-heated adjacent structures [square meters].
|
|
768
|
-
|
|
769
|
-
The field is set to \`null\` if the area is unknown.`,
|
|
770
|
-
example: 298.6121580931941
|
|
771
|
-
},
|
|
772
|
-
plinth_length_free: {
|
|
773
|
-
type: ["number", "null"],
|
|
774
|
-
minimum: 0,
|
|
775
|
-
description: `
|
|
776
|
-
The \`plinth_length_free\` field specifies the length of the building's plinth that is not shared with adjacent structures [meters].
|
|
777
|
-
|
|
778
|
-
The field is set to \`null\` if the length is unknown.`,
|
|
779
|
-
example: 48.672734987814366
|
|
780
|
-
},
|
|
781
|
-
plinth_length_shared_heated: {
|
|
782
|
-
type: ["number", "null"],
|
|
783
|
-
minimum: 0,
|
|
784
|
-
description: `
|
|
785
|
-
The \`plinth_length_shared_heated\` field specifies the length of the building's plinth shared with heated adjacent structures [meters].
|
|
786
|
-
|
|
787
|
-
The field is set to \`null\` if the length is unknown.`,
|
|
788
|
-
example: 13.16187444425839
|
|
789
|
-
},
|
|
790
|
-
plinth_length_shared_non_heated: {
|
|
791
|
-
type: ["number", "null"],
|
|
792
|
-
minimum: 0,
|
|
793
|
-
description: `
|
|
794
|
-
The \`plinth_length_shared_non_heated\` field specifies the length of the building's plinth shared with non-heated adjacent structures [meters].
|
|
795
|
-
|
|
796
|
-
The field is set to \`null\` if the length is unknown.`,
|
|
797
|
-
example: 31.994775355440325
|
|
798
|
-
},
|
|
799
|
-
building_function: {
|
|
800
|
-
type: ["string", "null"],
|
|
801
|
-
description: `
|
|
802
|
-
The \`building_function\` field contains the original German building function name (GFK - Geb\xE4udefunktionsklasse) from the source data.
|
|
803
|
-
|
|
804
|
-
This is the raw German value. For the standardized English classification, use the \`building_function_class\` field.
|
|
805
|
-
|
|
806
|
-
The field is set to \`null\` if the building function is unknown.`,
|
|
807
|
-
example: "Wohngeb\xE4ude"
|
|
808
|
-
},
|
|
809
|
-
building_function_class: {
|
|
810
|
-
type: ["string", "null"],
|
|
811
|
-
enum: ["residential_building", "residential_house", "dormitory", "childrens_home", "nursing_home", "nurses_dormitory", "student_dormitory", "school_country_home", "mixed_use_building_with_residential", "residential_building_with_public_amenities", "residential_building_with_commerce_services", "residential_and_administrative_building", "residential_and_office_building", "residential_and_commercial_building", "residential_commercial_industrial_building", "agricultural_forestry_residential_building", "agricultural_forestry_residential_commercial_building", "farmhouse", "residential_and_agricultural_building", "forest_house", "leisure_facility_building", "holiday_home", "weekend_house", "garden_house", "commercial_building", "commercial_and_service_building", "office_building", "credit_institution", "insurance_office", "department_store", "shopping_center", "market_hall", "shop", "kiosk", "pharmacy", "exhibition_hall", "accommodation_building", "hotel_motel_guesthouse", "youth_hostel", "hut_with_overnight_stay", "campground_building", "catering_building", "restaurant", "hut_no_overnight_stay", "canteen", "leisure_and_entertainment_venue", "banquet_hall", "cinema", "bowling_alley", "casino", "arcade", "commercial_and_industrial_building", "production_building", "factory", "operations_building", "brewery", "distillery", "workshop", "sawmill", "gas_station", "car_wash", "storage_building", "cold_storage", "warehouse", "freight_forwarding_building", "research_building", "raw_material_extraction_building", "mine", "saltworks", "company_social_facility_building", "other_commercial_industrial_building", "mill", "windmill", "watermill", "pumping_station", "weather_station", "commercial_service_residential_building", "commercial_industrial_residential_building", "traffic_facility_operations_building_general", "road_traffic_operations_building", "road_maintenance_depot", "waiting_hall", "rail_traffic_operations_building", "railroad_crossing_keeper_house", "locomotive_shed_carriage_hall", "signal_box_block_post", "freight_yard_operations_building", "air_traffic_operations_building", "aircraft_hangar", "maritime_traffic_operations_building", "shipyard_hall", "dock_hall", "lock_operations_building", "boathouse", "cable_car_operations_building", "cable_car_tensioning_station", "parking_building", "parking_garage", "garage", "vehicle_hall", "supply_building", "energy_supply_building", "water_supply_building", "waterworks", "water_reservoir", "electricity_supply_building", "power_plant", "substation", "transformer", "reactor_building", "turbine_house", "boiler_house", "telecommunications_building", "building_at_underground_lines", "gas_supply_building", "gas_works", "heating_plant", "utility_building", "pumping_station_non_water_supply", "disposal_building", "wastewater_treatment_building", "sewage_treatment_plant_building", "public_toilet", "waste_treatment_building", "waste_bunker", "waste_incineration_plant", "landfill_building", "agricultural_forestry_building", "agricultural_forestry_commercial_building", "barn", "shed", "stable", "barn_and_stable", "large_scale_animal_housing", "riding_hall", "alpine_hut", "hunting_lodge_cabin", "greenhouse", "moveable_greenhouse", "public_building", "administrative_building", "parliament_building", "town_hall", "post_office", "customs_office", "court_building", "embassy_consulate", "district_administration", "regional_government", "tax_office", "education_research_building", "general_education_school", "vocational_school", "higher_education_building_university", "research_institute", "cultural_building", "palace", "theater_opera", "concert_hall", "museum", "broadcasting_television", "event_building", "library", "castle_fortress", "religious_building", "church", "synagogue", "chapel", "community_hall", "house_of_worship", "mosque", "temple", "monastery", "healthcare_building", "hospital", "sanatorium_nursing_home_nursing_station", "doctors_office_polyclinic", "rescue_station", "social_services_building", "youth_center", "leisure_club_community_center", "senior_center", "homeless_shelter", "daycare_kindergarten", "refugee_shelter", "security_and_order_building", "police_station", "fire_station", "barracks", "air_raid_shelter", "correctional_facility", "cemetery_building", "funeral_hall", "crematorium", "reception_building", "railway_station_building", "airport_building", "subway_station_building", "suburban_railway_station_building", "bus_station_building", "maritime_terminal_building", "public_purpose_residential_building", "recreational_building", "sports_building", "sports_gymnasium", "sports_field_building", "bathhouse", "indoor_swimming_pool", "outdoor_pool_building", "stadium_building", "spa_facility_building", "medical_bath_building", "sanatorium", "zoo_building", "zoo_entrance_building", "aquarium_terrarium_aviary", "animal_exhibition_building", "zoo_stable", "botanical_garden_building", "botanical_garden_entrance_building", "botanical_greenhouse", "conservatory", "other_recreational_facility_building", "mountain_hut_shelter", "tourist_information_center", "not_specified_due_to_source_situation", "water_tower", "church_tower", "observation_tower", "control_tower", "cooling_tower", "lighthouse", "fire_watchtower", "transmission_radio_tower", "city_gate_tower", "winding_tower", "drilling_tower", "castle_tower", "other", "biogas_plant", "wind_turbine", "solar_panels", "mast", "power_line_mast", "radio_mast", "radio_telescope", "chimney", "crane", "slewing_crane", "gantry_crane", "traveling_crane", "blast_furnace", "silo", "tank", "gasometer", "grandstand", "covered_grandstand", "uncovered_grandstand", "stadium", "covered_stadium", "uncovered_stadium", "ski_jump_inrun", "graduation_tower", "historic_water_pipeline", "watchtower", "fortification_castle_ruin", "historic_wall", "city_wall", "other_historic_wall", "canopy", "carport", "wall", "monument", "ship_lift", "chamber_lock", "bridge", "swing_bridge", "lifting_bridge", "drawbridge", "elevated_railway_elevated_road", "lock_chamber", "dam", "weir", "security_gate", "sewer_drain", "barrage"],
|
|
812
|
-
description: `
|
|
813
|
-
The \`building_function_class\` field specifies the standardized English classification of the building function according to the German GFK (Geb\xE4udefunktionsklasse) standard.
|
|
814
|
-
|
|
815
|
-
This field categorizes buildings by their primary use or purpose, such as residential, commercial, industrial, public, or mixed-use functions.
|
|
816
|
-
|
|
817
|
-
The field is set to \`null\` if the building function class is unknown.`,
|
|
818
|
-
example: "residential_building"
|
|
819
|
-
}
|
|
820
|
-
},
|
|
821
|
-
required: ["street", "city", "street_number", "postcode", "roof_type", "type", "type_class", "water_protected", "heated", "heat_demand", "height_category", "height_category_class", "levels", "household_count", "net_area", "footprint_area", "usage", "usage_class", "characteristics", "characteristics_class", "development_layout", "development_layout_class", "construction_year_range", "construction_year_range_class", "construction_year", "heritage", "geo_conductivity_100", "heat_pump_air_possible", "heat_pump_maximal_distance_drillings", "heat_pump_maximal_distance_drillings_5m", "heat_pump_minimal_number_possible_drillings", "heat_pump_minimal_number_possible_drillings_5m", "heat_pump_minimal_number_possible_drillings_2m", "heat_pump_minimal_number_possible_drillings_no_distance", "heat_pump_collector_free_area", "flood_potential", "photovoltaic_potential", "solarthermal_potential", "matching_addresses", "eave_above_ground_weighted", "eave_above_ground_min", "eave_above_ground_max", "ridge_above_ground_weighted", "ridge_above_ground_min", "ridge_above_ground_max", "number_original_geometries", "roof_area", "ogc_fid", "outer_wall_area_free", "outer_wall_area_shared_heated", "outer_wall_area_shared_non_heated", "plinth_length_free", "plinth_length_shared_heated", "plinth_length_shared_non_heated", "building_function", "building_function_class"]
|
|
822
|
-
};
|
|
823
22
|
var $LookupPropertiesV3 = {
|
|
824
23
|
type: "object",
|
|
825
24
|
properties: {
|
|
@@ -954,9 +153,9 @@ The \`net_area\` field specifies the net area of the building in m\xB2.
|
|
|
954
153
|
|
|
955
154
|
The field is set to \`null\` if the net area is unknown.
|
|
956
155
|
|
|
957
|
-
The \`net_area\` was modeled according to the Raumw\xE4rmebedarfsmodell NRW as:
|
|
156
|
+
The \`net_area\` was modeled according to the Raumw\xE4rmebedarfsmodell NRW as:
|
|
958
157
|
\`footprint_area\` * \`levels\` * factors between 0.7 (inhabited) and 0.8 (non-inhabited)
|
|
959
|
-
the latter was done to
|
|
158
|
+
the latter was done to consider e.g., inner wall area or staircases.`,
|
|
960
159
|
example: 127.42
|
|
961
160
|
},
|
|
962
161
|
footprint_area: {
|
|
@@ -972,7 +171,7 @@ The field is set to \`null\` if the footprint area is unknown.`,
|
|
|
972
171
|
type: ["string", "null"],
|
|
973
172
|
enum: ["single_two_family", "row_semi_detached", "multi_family", "residential_block", "high_rise", "terrace", "farmhouse", "office_other", "factory_warehouse"],
|
|
974
173
|
description: `
|
|
975
|
-
The \`characteristics\` field defines the different types of building characteristics. This classification includes
|
|
174
|
+
The \`characteristics\` field defines the different types of building characteristics. This classification includes
|
|
976
175
|
various types of residential and non-residential buildings. This field can have one of the following values:
|
|
977
176
|
|
|
978
177
|
- **single_two_family**: Single- or two-family house
|
|
@@ -993,7 +192,7 @@ If the characteristics is unknown, the field is set to \`null\`.`,
|
|
|
993
192
|
minimum: 1,
|
|
994
193
|
maximum: 9,
|
|
995
194
|
description: `
|
|
996
|
-
The \`characteristics_class\` field defines the different types of building characteristics. This classification includes
|
|
195
|
+
The \`characteristics_class\` field defines the different types of building characteristics. This classification includes
|
|
997
196
|
various types of residential and non-residential buildings. This field can have one of the following values:
|
|
998
197
|
|
|
999
198
|
- **1**: Single- or two-family house
|
|
@@ -1087,7 +286,7 @@ If the construction year class is unknown, the field is set to \`null\`.`,
|
|
|
1087
286
|
minimum: 1,
|
|
1088
287
|
maximum: 12,
|
|
1089
288
|
description: `
|
|
1090
|
-
The \`construction_year_range_class\` field specifies the approximate construction year of the building and can have one of the following values:
|
|
289
|
+
The \`construction_year_range_class\` field specifies the approximate construction year of the building and can have one of the following values:
|
|
1091
290
|
|
|
1092
291
|
- **1**: < 1899
|
|
1093
292
|
- **2**: 1900 - 1945
|
|
@@ -1164,8 +363,8 @@ The field is set to \`null\` if the information is unknown.`,
|
|
|
1164
363
|
type: ["number", "null"],
|
|
1165
364
|
minimum: 0,
|
|
1166
365
|
description: `
|
|
1167
|
-
The \`heat_pump_minimal_number_possible_drillings\` field specifies the minimum
|
|
1168
|
-
number of drillings required for a heat pump installation with a distance of 5m
|
|
366
|
+
The \`heat_pump_minimal_number_possible_drillings\` field specifies the minimum
|
|
367
|
+
number of drillings required for a heat pump installation with a distance of 5m
|
|
1169
368
|
to the parcel border.
|
|
1170
369
|
This field will be deprecated in future versions. Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead.
|
|
1171
370
|
|
|
@@ -1181,8 +380,8 @@ Please use \`heat_pump_minimal_number_possible_drillings_5m\` instead of this fi
|
|
|
1181
380
|
type: ["number", "null"],
|
|
1182
381
|
minimum: 0,
|
|
1183
382
|
description: `
|
|
1184
|
-
The \`heat_pump_minimal_number_possible_drillings_5m\` field specifies the minimum
|
|
1185
|
-
number of drillings required for a heat pump installation with a distance of 5m
|
|
383
|
+
The \`heat_pump_minimal_number_possible_drillings_5m\` field specifies the minimum
|
|
384
|
+
number of drillings required for a heat pump installation with a distance of 5m
|
|
1186
385
|
to the parcel border.
|
|
1187
386
|
|
|
1188
387
|
The field is set to \`null\` if the information is unknown.`,
|
|
@@ -1192,8 +391,8 @@ The field is set to \`null\` if the information is unknown.`,
|
|
|
1192
391
|
type: ["number", "null"],
|
|
1193
392
|
minimum: 0,
|
|
1194
393
|
description: `
|
|
1195
|
-
The \`heat_pump_minimal_number_possible_drillings_2m\` field specifies the minimum
|
|
1196
|
-
number of drillings required for a heat pump installation with a distance of 2m
|
|
394
|
+
The \`heat_pump_minimal_number_possible_drillings_2m\` field specifies the minimum
|
|
395
|
+
number of drillings required for a heat pump installation with a distance of 2m
|
|
1197
396
|
to the parcel border.
|
|
1198
397
|
|
|
1199
398
|
The field is set to \`null\` if the information is unknown.`,
|
|
@@ -1203,7 +402,7 @@ The field is set to \`null\` if the information is unknown.`,
|
|
|
1203
402
|
type: ["number", "null"],
|
|
1204
403
|
minimum: 0,
|
|
1205
404
|
description: `
|
|
1206
|
-
The \`heat_pump_minimal_number_possible_drillings_no_distance\` field specifies the minimum
|
|
405
|
+
The \`heat_pump_minimal_number_possible_drillings_no_distance\` field specifies the minimum
|
|
1207
406
|
number of drillings required for a heat pump installation with no distance to the parcel border.
|
|
1208
407
|
|
|
1209
408
|
The field is set to \`null\` if the information is unknown.`,
|
|
@@ -1213,7 +412,7 @@ The field is set to \`null\` if the information is unknown.`,
|
|
|
1213
412
|
type: ["number", "null"],
|
|
1214
413
|
minimum: 0,
|
|
1215
414
|
description: `
|
|
1216
|
-
The \`heat_pump_collector_free_area\` field specifies the sum of the free area suitable
|
|
415
|
+
The \`heat_pump_collector_free_area\` field specifies the sum of the free area suitable
|
|
1217
416
|
for a collector heat pump on parcels associated to a building.
|
|
1218
417
|
|
|
1219
418
|
The field is set to \`null\` if the information is unknown.`,
|
|
@@ -1239,20 +438,20 @@ The field is set to \`null\` if the information is unknown.`,
|
|
|
1239
438
|
},
|
|
1240
439
|
minItems: 1,
|
|
1241
440
|
description: `
|
|
1242
|
-
The \`flood_potential\` field is an array representing different flood risk scenarios for a given
|
|
441
|
+
The \`flood_potential\` field is an array representing different flood risk scenarios for a given
|
|
1243
442
|
location. The objects in the array can contain the following fields:
|
|
1244
443
|
|
|
1245
|
-
- \`
|
|
1246
|
-
This field is optional and can be \`null\` if the data is unavailable. A lower value indicates more
|
|
444
|
+
- \`min_recurrence\`: The minimum expected recurrence interval for flooding, measured in years.
|
|
445
|
+
This field is optional and can be \`null\` if the data is unavailable. A lower value indicates more
|
|
1247
446
|
frequent flooding.
|
|
1248
|
-
|
|
1249
|
-
- \`
|
|
1250
|
-
field is optional and can be \`null\`. If provided, this value represents the upper bound of the
|
|
447
|
+
|
|
448
|
+
- \`max_recurrence\`: The maximum expected recurrence interval for flooding, also in years. This
|
|
449
|
+
field is optional and can be \`null\`. If provided, this value represents the upper bound of the
|
|
1251
450
|
flood risk interval. This field allows the specification of a range of recurrence intervals.
|
|
1252
|
-
|
|
1253
|
-
- \`protection_against_floods\`: A boolean flag indicating whether flood protection measures are in
|
|
1254
|
-
place for the area. This field is optional and can be \`null\` if the information is not available.
|
|
1255
|
-
A value of \`true\` means flood defenses are present, while \`false\` indicates the absence of such
|
|
451
|
+
|
|
452
|
+
- \`protection_against_floods\`: A boolean flag indicating whether flood protection measures are in
|
|
453
|
+
place for the area. This field is optional and can be \`null\` if the information is not available.
|
|
454
|
+
A value of \`true\` means flood defenses are present, while \`false\` indicates the absence of such
|
|
1256
455
|
measures.
|
|
1257
456
|
|
|
1258
457
|
If this array is set to \`null\`, it means that no data regarding flood potential is available for the location.`,
|
|
@@ -1366,9 +565,9 @@ The field is set to \`null\` if no matching addresses are found.`,
|
|
|
1366
565
|
type: ["number", "null"],
|
|
1367
566
|
minimum: 0,
|
|
1368
567
|
description: `
|
|
1369
|
-
The \`eave_above_ground_weighted\` field specifies the weighted average height of the eave above ground [meters]. For weighting
|
|
1370
|
-
the \`footprint_area\` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the
|
|
1371
|
-
field \`number_original_geometries\`.
|
|
568
|
+
The \`eave_above_ground_weighted\` field specifies the weighted average height of the eave above ground [meters]. For weighting
|
|
569
|
+
the \`footprint_area\` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis of the
|
|
570
|
+
field \`number_original_geometries\`.
|
|
1372
571
|
|
|
1373
572
|
|
|
1374
573
|
The field is set to \`null\` if the height is unknown.`,
|
|
@@ -1378,8 +577,8 @@ The field is set to \`null\` if the height is unknown.`,
|
|
|
1378
577
|
type: ["number", "null"],
|
|
1379
578
|
minimum: 0,
|
|
1380
579
|
description: `
|
|
1381
|
-
The \`eave_above_ground_min\` field specifies the minimum height of the eave above ground [meters]. This is the minimal
|
|
1382
|
-
\`eave_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis
|
|
580
|
+
The \`eave_above_ground_min\` field specifies the minimum height of the eave above ground [meters]. This is the minimal
|
|
581
|
+
\`eave_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis
|
|
1383
582
|
of the field \`number_original_geometries\`.
|
|
1384
583
|
|
|
1385
584
|
The field is set to \`null\` if the height is unknown.`,
|
|
@@ -1389,8 +588,8 @@ The field is set to \`null\` if the height is unknown.`,
|
|
|
1389
588
|
type: ["number", "null"],
|
|
1390
589
|
minimum: 0,
|
|
1391
590
|
description: `
|
|
1392
|
-
The \`eave_above_ground_max\` field specifies the maximum height of the eave above ground [meters]. This is the maximal
|
|
1393
|
-
\`eave_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of
|
|
591
|
+
The \`eave_above_ground_max\` field specifies the maximum height of the eave above ground [meters]. This is the maximal
|
|
592
|
+
\`eave_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of
|
|
1394
593
|
the field \`number_original_geometries\`.
|
|
1395
594
|
|
|
1396
595
|
|
|
@@ -1401,9 +600,9 @@ The field is set to \`null\` if the height is unknown.`,
|
|
|
1401
600
|
type: ["number", "null"],
|
|
1402
601
|
minimum: 0,
|
|
1403
602
|
description: `
|
|
1404
|
-
The \`ridge_above_ground_weighted\` field specifies the weighted average height of the ridge above ground [meters]. For
|
|
1405
|
-
weighting the \`footprint_area\` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis
|
|
1406
|
-
of the field \`number_original_geometries\`.
|
|
603
|
+
The \`ridge_above_ground_weighted\` field specifies the weighted average height of the ridge above ground [meters]. For
|
|
604
|
+
weighting the \`footprint_area\` of sub-geometries was used, if a building consists of multiple. This can be traced on the basis
|
|
605
|
+
of the field \`number_original_geometries\`.
|
|
1407
606
|
|
|
1408
607
|
The field is set to \`null\` if the height is unknown.`,
|
|
1409
608
|
example: 13.619256575276214
|
|
@@ -1412,9 +611,9 @@ The field is set to \`null\` if the height is unknown.`,
|
|
|
1412
611
|
type: ["number", "null"],
|
|
1413
612
|
minimum: 0,
|
|
1414
613
|
description: `
|
|
1415
|
-
The \`ridge_above_ground_min\` field specifies the minimum height of the ridge above ground [meters]. This is the minimal
|
|
1416
|
-
\`ridge_above_ground within\` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
|
|
1417
|
-
field \`number_original_geometries\`.
|
|
614
|
+
The \`ridge_above_ground_min\` field specifies the minimum height of the ridge above ground [meters]. This is the minimal
|
|
615
|
+
\`ridge_above_ground within\` a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
|
|
616
|
+
field \`number_original_geometries\`.
|
|
1418
617
|
|
|
1419
618
|
The field is set to \`null\` if the height is unknown.`,
|
|
1420
619
|
example: 6.64300537109375
|
|
@@ -1423,9 +622,9 @@ The field is set to \`null\` if the height is unknown.`,
|
|
|
1423
622
|
type: ["number", "null"],
|
|
1424
623
|
minimum: 0,
|
|
1425
624
|
description: `
|
|
1426
|
-
The \`ridge_above_ground_max\` field specifies the maximum height of the ridge above ground [meters]. This is the maximal
|
|
1427
|
-
\`ridge_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
|
|
1428
|
-
field \`number_original_geometries\`.
|
|
625
|
+
The \`ridge_above_ground_max\` field specifies the maximum height of the ridge above ground [meters]. This is the maximal
|
|
626
|
+
\`ridge_above_ground\` within a group of sub-geometries, if a building consists of multiple. This can be traced on the basis of the
|
|
627
|
+
field \`number_original_geometries\`.
|
|
1429
628
|
|
|
1430
629
|
The field is set to \`null\` if the height is unknown.`,
|
|
1431
630
|
example: 16.987991333007812
|
|
@@ -1452,7 +651,7 @@ The field is set to \`null\` if the roof area is unknown.`,
|
|
|
1452
651
|
type: ["number", "null"],
|
|
1453
652
|
minimum: 0,
|
|
1454
653
|
description: `
|
|
1455
|
-
The \`outer_wall_area_free\` field specifies the facade area free of adjacent structures [square meters].
|
|
654
|
+
The \`outer_wall_area_free\` field specifies the facade area free of adjacent structures [square meters].
|
|
1456
655
|
|
|
1457
656
|
The field is set to \`null\` if the area is unknown.`,
|
|
1458
657
|
example: 690.5686635568186
|
|
@@ -1461,7 +660,7 @@ The field is set to \`null\` if the area is unknown.`,
|
|
|
1461
660
|
type: ["number", "null"],
|
|
1462
661
|
minimum: 0,
|
|
1463
662
|
description: `
|
|
1464
|
-
The \`outer_wall_area_shared_heated\` field specifies the facade area shared with heated adjacent structures [square meters].
|
|
663
|
+
The \`outer_wall_area_shared_heated\` field specifies the facade area shared with heated adjacent structures [square meters].
|
|
1465
664
|
|
|
1466
665
|
The field is set to \`null\` if the area is unknown.`,
|
|
1467
666
|
example: 202.10705297163204
|
|
@@ -1533,9 +732,9 @@ The field is set to \`null\` if the building function class is unknown.`,
|
|
|
1533
732
|
ogc_fid: {
|
|
1534
733
|
type: ["string", "null"],
|
|
1535
734
|
description: `
|
|
1536
|
-
The \`ogc_fid\` field specifies a unique identifier from the LOD2 dataset. **This field is deprecated** and should no longer be used for identifying buildings.
|
|
735
|
+
The \`ogc_fid\` field specifies a unique identifier from the LOD2 dataset. **This field is deprecated** and should no longer be used for identifying buildings.
|
|
1537
736
|
|
|
1538
|
-
For current and future use, refer to \`building_id\` (for the building geometry) or \`building_address_id\` (for a unique building-address combination) instead.
|
|
737
|
+
For current and future use, refer to \`building_id\` (for the building geometry) or \`building_address_id\` (for a unique building-address combination) instead.
|
|
1539
738
|
|
|
1540
739
|
The field is set to \`null\` if the identifier is unavailable.`,
|
|
1541
740
|
example: "DENW29AL1000FzW2",
|
|
@@ -2415,24 +1614,6 @@ var $BuildingGeometryResponseV4 = {
|
|
|
2415
1614
|
|
|
2416
1615
|
// src/services.gen.ts
|
|
2417
1616
|
import { client } from "@hey-api/client-fetch";
|
|
2418
|
-
var getAddressLookupV2 = (options) => {
|
|
2419
|
-
var _a;
|
|
2420
|
-
return ((_a = options == null ? void 0 : options.client) != null ? _a : client).get(__spreadProps(__spreadValues({}, options), {
|
|
2421
|
-
url: "/v2/addressLookup"
|
|
2422
|
-
}));
|
|
2423
|
-
};
|
|
2424
|
-
var getCoordinateLookupV2 = (options) => {
|
|
2425
|
-
var _a;
|
|
2426
|
-
return ((_a = options == null ? void 0 : options.client) != null ? _a : client).get(__spreadProps(__spreadValues({}, options), {
|
|
2427
|
-
url: "/v2/coordinateLookup"
|
|
2428
|
-
}));
|
|
2429
|
-
};
|
|
2430
|
-
var postCoordinateBatchLookupV2 = (options) => {
|
|
2431
|
-
var _a;
|
|
2432
|
-
return ((_a = options == null ? void 0 : options.client) != null ? _a : client).post(__spreadProps(__spreadValues({}, options), {
|
|
2433
|
-
url: "/v2/coordinateBatchLookup"
|
|
2434
|
-
}));
|
|
2435
|
-
};
|
|
2436
1617
|
var getAddressLookupV3 = (options) => {
|
|
2437
1618
|
var _a;
|
|
2438
1619
|
return ((_a = options == null ? void 0 : options.client) != null ? _a : client).get(__spreadProps(__spreadValues({}, options), {
|
|
@@ -2472,7 +1653,6 @@ export {
|
|
|
2472
1653
|
$BuildingGeometryResponseV4,
|
|
2473
1654
|
$Geometry3D,
|
|
2474
1655
|
$GeometryCollection3D,
|
|
2475
|
-
$LookupPropertiesV2,
|
|
2476
1656
|
$LookupPropertiesV3,
|
|
2477
1657
|
$MultiPolygon3DGeometry,
|
|
2478
1658
|
$ParcelPropertiesV4,
|
|
@@ -2480,13 +1660,10 @@ export {
|
|
|
2480
1660
|
$Position3D,
|
|
2481
1661
|
$SurfaceType,
|
|
2482
1662
|
createClient,
|
|
2483
|
-
getAddressLookupV2,
|
|
2484
1663
|
getAddressLookupV3,
|
|
2485
1664
|
getBuildingPart3dGeometryLookupV4,
|
|
2486
|
-
getCoordinateLookupV2,
|
|
2487
1665
|
getCoordinateLookupV3,
|
|
2488
1666
|
getParcelCoordinateLookupV4,
|
|
2489
|
-
postCoordinateBatchLookupV2,
|
|
2490
1667
|
postCoordinateBatchLookupV3
|
|
2491
1668
|
};
|
|
2492
1669
|
//# sourceMappingURL=index.js.map
|