Added addonServices and additionalData to docs for POST /preorder

This commit is contained in:
Frank Schubert
2022-10-27 12:23:36 +02:00
parent 9d3c20d477
commit 8d8a0b54ae

View File

@@ -214,7 +214,7 @@ paths:
---
Parameter `address`: Anschlussadresse
Parameter `address_info`: Zusätzliche Informationen zur Adresse
Parameter `address_info`: **(Optional)** Zusätzliche Informationen zur Adresse
Parameter `customer`: Vertragsinhaber
@@ -244,6 +244,26 @@ paths:
| apartment-building | Mehrparteienhaus (ab 4 Wohneinheiten)
| apartment | Wohneinheit in Mehrparteienhaus
| business | Gewerbebetrieb |
---
Parameter `addonServices`: **(Optional)** Array für zusätzlich gebuchte Services. Services müssen nicht vordefiniert sein, es können benutzerdefinierte Services übergeben werden.
Das Array `data` ist optional und kann frei befüllt werden, um weitere Details zum Service zu speichern (z.B. extra Einwilligung zur Datenweitergabe an Dienstleister)
Folgende Services sind vordefiniert:
| Service | description |
|---------|-------------|
| installation_onproperty | Lehrrohrverlegung am Grundstück |
| installation_inhouse | Glasfaserverlegung im Haus |
| ... | ...|
---
Parameter `additionalData`: **(Optional)** Object für zusätzliche individuelle Daten, die in der Vorbestellung gespeichert werden. Wird in `GET /preorder` retourniert.
operationId: submitPreorder
requestBody:
description: PreorderRequest object
@@ -612,6 +632,50 @@ components:
- street
- zip
- city
addonServices:
type: array
description: |
Zusätzlich gebuchte Services
Services müssen nicht vordefiniert sein, es können benutzerdefinierte Services übergeben werden
items:
type: object
properties:
service:
type: string
description: Name des gebuchten Service
example: installation_inhouse
ordered:
type: boolean
description: Wurde dieses Service dazu gebucht
example: true
data:
type: array
items:
type: object
description: Zusätzlich benötigte Felder für Service
properties:
name:
type: string
description: Name für zusätzliches Feld
example: accept_data_forwarding
value:
type: string
description: Wert für zusätzliches Feld
example: true
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
required:
- connectionType
- preorderType