Changes for Preorder:
- Added OAID to Hausnummer and Wohneinheit - Added format parameter to /addressdb/findAddress - Added additional fields to /addressdb/findAddress - Updated api doc yaml - Updated addressdb import scripts for Liezen
This commit is contained in:
Frank Schubert
@@ -23,6 +23,11 @@ paths:
|
||||
description: Sucht nach Adressen. Retourniert Adressen mit Wohneinheiten
|
||||
operationId: findAddresses
|
||||
parameters:
|
||||
- name: format
|
||||
description: "Ausgabeformat: `flat` (Ein Array-Element pro Wohneinheit mit Gebäudedaten; **default**) oder `tree` (Ein Array-Element pro Gebäude mit Wohneinheiten-Array; **empfohlen**)"
|
||||
in: query
|
||||
schema:
|
||||
type: string
|
||||
- name: street
|
||||
description: Straße Suchbegriff
|
||||
in: query
|
||||
@@ -63,7 +68,20 @@ paths:
|
||||
| order | Vollanschluss |
|
||||
| reorder | Nachbestellung (nach Bauabschluss) |
|
||||
content:
|
||||
application/json:
|
||||
"application/json (format: tree)":
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
description: Status string
|
||||
example: OK
|
||||
result:
|
||||
type: object
|
||||
properties:
|
||||
addresses:
|
||||
$ref: '#/components/schemas/AddressesTree'
|
||||
"application/json (format: flat)":
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
@@ -341,6 +359,19 @@ paths:
|
||||
code:
|
||||
type: string
|
||||
description: Code für Statusabfrage
|
||||
example: A1B2C3D4
|
||||
additionalData:
|
||||
type: object
|
||||
description: Benutzerdefiniertes Objekt. Wird unverändert gespeichert und in `GET /preorder` wieder ausgegeben
|
||||
example:
|
||||
myData: Hallo
|
||||
moreData: Welt
|
||||
lotsMoreData:
|
||||
- key: name
|
||||
value: test
|
||||
- key: another Key
|
||||
value: more value
|
||||
|
||||
'400':
|
||||
description: |
|
||||
Bad Request
|
||||
@@ -426,13 +457,21 @@ components:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
AddressesTree:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/AddressTree'
|
||||
Addresses:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Address'
|
||||
Address:
|
||||
AddressTree:
|
||||
type: object
|
||||
properties:
|
||||
oaid:
|
||||
type: string
|
||||
description: OAID des Gebäudes
|
||||
example: AT-9999-abcdef01
|
||||
street:
|
||||
type: string
|
||||
description: Strasse
|
||||
@@ -453,6 +492,122 @@ components:
|
||||
type: string
|
||||
description: Ortsteil
|
||||
example: Ortsteil
|
||||
lot_number:
|
||||
type: string
|
||||
description: Grundstücksnummer
|
||||
example: 123/7
|
||||
building_unit_count:
|
||||
type: int64
|
||||
description: Anzahl Wohneinheiten im Gebäude
|
||||
example: 6
|
||||
gps_lat:
|
||||
typee: float
|
||||
description: Breitengrad der GPS-Koordinate (Dezimal)
|
||||
example: 48.517560
|
||||
gps_long:
|
||||
typee: float
|
||||
description: Längengrad der GPS-Koordinate (Dezimal)
|
||||
example: 13.950665
|
||||
rollout_year:
|
||||
type: integer
|
||||
description: Jahr des geplanten Ausbaus
|
||||
example: 2024
|
||||
rollout_info:
|
||||
type: string
|
||||
description: Infotext begzl. Bauplanung
|
||||
example: Bauplan 2024
|
||||
preorderTypes:
|
||||
type: array
|
||||
example: ["interest", "provision", "order", "reorder"]
|
||||
description: |
|
||||
Erlaubte Vorbestelltypen:
|
||||
|
||||
| preorderType | description |
|
||||
|--------------|-------------|
|
||||
| interest | Interessensbekundung |
|
||||
| provision | Vorsorgeanschluss |
|
||||
| order | Vollanschluss |
|
||||
| reorder | Nachbestellung (nach Bauabschluss) |
|
||||
items:
|
||||
type: string
|
||||
units:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
oaid:
|
||||
type: string
|
||||
description: OAID der Wohneinheit
|
||||
example: AT-9999-abcdef01.001
|
||||
num:
|
||||
type: int64
|
||||
description: Fortlaufende Nummer der Wohneinheit
|
||||
example: 2
|
||||
block:
|
||||
type: string
|
||||
description: Block
|
||||
example: ""
|
||||
stock:
|
||||
type: string
|
||||
description: Stock
|
||||
example: 42
|
||||
stiege:
|
||||
type: string
|
||||
description: Stiege
|
||||
example: ""
|
||||
tuer:
|
||||
type: string
|
||||
description: Tür
|
||||
example: 1337
|
||||
zusatz:
|
||||
type: string
|
||||
description: Addresszusatz
|
||||
example: im Carport
|
||||
required:
|
||||
- street
|
||||
Address:
|
||||
type: object
|
||||
properties:
|
||||
oaid:
|
||||
type: string
|
||||
description: OAID der Wohneinheit
|
||||
example: AT-9999-abcdef01.001
|
||||
building_oaid:
|
||||
type: string
|
||||
description: OAID des Gebäudes
|
||||
example: AT-9999-abcdef01
|
||||
street:
|
||||
type: string
|
||||
description: Strasse
|
||||
example: Beispielstraße
|
||||
housenumber:
|
||||
type: string
|
||||
description: Hausnummer
|
||||
example: 13
|
||||
zip:
|
||||
type: string
|
||||
description: PLZ
|
||||
example: 9999
|
||||
city:
|
||||
type: string
|
||||
description: Ort
|
||||
example: Beispielhausen
|
||||
district:
|
||||
type: string
|
||||
description: Ortsteil
|
||||
example: Ortsteil
|
||||
lot_number:
|
||||
type: string
|
||||
description: Grundstücksnummer
|
||||
example: 123/7
|
||||
building_unit_count:
|
||||
type: int64
|
||||
description: Anzahl Wohneinheiten im Gebäude
|
||||
example: 6
|
||||
num:
|
||||
type: int64
|
||||
description: Fortlaufende Nummer der Wohneinheit
|
||||
example: 2
|
||||
block:
|
||||
type: string
|
||||
description: Block
|
||||
@@ -469,6 +624,10 @@ components:
|
||||
type: string
|
||||
description: Tür
|
||||
example: 1337
|
||||
zusatz:
|
||||
type: string
|
||||
description: Addresszusatz
|
||||
example: im Carport
|
||||
gps_lat:
|
||||
typee: float
|
||||
description: Breitengrad der GPS-Koordinate (Dezimal)
|
||||
@@ -585,9 +744,9 @@ components:
|
||||
|
||||
| preorderType | Description |
|
||||
|--------------|-------------|
|
||||
| interest | Interessensbekundung|
|
||||
| provision | Vorsorgeanschluss|
|
||||
| order | Vollanschluss|
|
||||
| interest | Interessensbekundung |
|
||||
| provision | Vorsorgeanschluss |
|
||||
| order | Vollanschluss |
|
||||
| reorder | Nachbestellung (nach Bauabschluss) |
|
||||
acceptMarketing:
|
||||
type: boolean
|
||||
@@ -678,8 +837,12 @@ components:
|
||||
example: Nachname
|
||||
street:
|
||||
type: string
|
||||
description: Straße und Hausnummer Kunde
|
||||
example: "Beispielstraße 42"
|
||||
description: Straße Kunde
|
||||
example: Beispielstraße
|
||||
housenumber:
|
||||
type: string
|
||||
description: Hausnummer Kunde
|
||||
example: 42
|
||||
zip:
|
||||
type: string
|
||||
description: PLZ Kunde
|
||||
@@ -688,6 +851,22 @@ components:
|
||||
type: string
|
||||
description: Ort Kunde
|
||||
example: Beispielhausen
|
||||
block:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
stiege:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
stock:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
tuer:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
phone:
|
||||
type: string
|
||||
description: Telefonnummer Kunde
|
||||
|
||||
Reference in New Issue
Block a user