diff --git a/public/docs/preorder-api.yaml b/public/docs/preorder-api.yaml index b47fc3221..3e9a01ffa 100644 --- a/public/docs/preorder-api.yaml +++ b/public/docs/preorder-api.yaml @@ -194,7 +194,39 @@ paths: tags: - preorder summary: Vorbestellung registrieren - description: "Registriert eine Vorbestellung. Parameter `type` bestimmt Vorbestelltyp: 'interest' = Interessensbekundung, 'provision' = Vorsorgeanschluss, 'order' = Vollanschluss" + description: | + Registriert eine Vorbestellung. + + --- + Parameter `address`: Anschlussadresse + + Parameter `customer`: Vertragsinhaber + + --- + + Parameter `preorderType` bestimmt Vorbestelltyp: + + | preorderType | Description | + |--------------|-------------| + | interest | Interessensbekundung| + | provision | Vorsorgeanschluss| + | order | Vollanschluss| + + --- + + Parameter `connectionCount`: Anzahl Anschlüsse für Rabatt bei mehreren Anschlüssen in Mehrfamilienhaus + + --- + + Parameter `connectionType` bestimmt den Anschlusstyp: + + |connectionType | description | + |---------------|-------------| + | single-dwelling | Einfamilienhaus + | multi-dwelling | Mehrfamilienhaus (bis 3 Wohneinheiten) + | apartment-building | Mehrparteienhaus (ab 4 Wohneinheiten) + | apartment-renter | Mieter in Mehrparteienhaus + | business | Gewerbebetrieb | operationId: submitPreorder requestBody: description: PreorderRequest object @@ -390,10 +422,38 @@ components: preorderRequest: type: object properties: - type: + connectionType: type: string - enum: [interest, provision] - description: Vorbestelltyp (`interest` = Interessensbekundung, `provision` = Vorsorgeanschluss) + enum: [einfamilienhaus, mehrfamilienhaus, mehrparteienhaus, mieter, business] + connectionCount: + type: int + default: 1 + description: Anzahl Anschlüsse für Rabatt bei mehreren Anschlüssen in Mehrfamilienhaus + nullable: true + preorderType: + type: string + enum: [interest, provision, order] + description: | + Vorbestelltyp + + | preorderType | Description | + |--------------|-------------| + | interest | Interessensbekundung| + | provision | Vorsorgeanschluss| + | order | Vollanschluss| + + acceptMarketing: + type: boolean + description: Zustimmung Datenspeicherung/-weitergabe + acceptAgb: + type: boolean + description: Zustimmung AGB + acceptDsgvo: + type: boolean + description: Zustimmung DSGVO + acceptWithdrawal: + type: boolean + description: Informationen zu Rücktrittsrecht akzeptiert address: type: object properties: @@ -462,6 +522,15 @@ components: - street - zip - city + required: + - connectionType + - connectionCount + - preorderType + - acceptMarketing + - acceptAgbDsgvo + - acceptWithdrawal + - address + - customer preorderStatusDetail: type: object properties: