diff --git a/public/docs/preorder-api.yaml b/public/docs/preorder-api.yaml index 1388cd3f2..fc315143b 100644 --- a/public/docs/preorder-api.yaml +++ b/public/docs/preorder-api.yaml @@ -1,7 +1,7 @@ openapi: 3.0.1 info: title: thetool Preorder API - description: API Dokumentation für thetool Vorbestellung + description: API Dokumentation für thetool Akquise-Plattform license: name: Apache 2.0 License url: http://www.apache.org/licenses/LICENSE-2.0.html @@ -19,9 +19,9 @@ paths: get: tags: - addressdb - summary: Freitextsuche nach Adressen - description: Sucht Adressen die den Suchbegriff beinhalten. Retourniert Adressen mit Wohneinheiten - operationId: findAddresses + summary: Freitextsuche nach Adressen mit Ausbaustatus + description: Sucht Adressen die den Suchbegriff beinhalten. Retourniert Adressen mit Ausbaustatus und Wohneinheiten + operationId: searchAddresses 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)" @@ -92,8 +92,8 @@ paths: get: tags: - addressdb - summary: Adressen suchen - description: Sucht nach Adressen. Retourniert Adressen mit Wohneinheiten + summary: Strukturierte Suche nach Adressen mit Ausbaustatus + description: Sucht nach Adressen. Retourniert Adressen mit Ausbaustatus und Wohneinheiten operationId: findAddresses parameters: - name: format @@ -352,9 +352,9 @@ paths: post: tags: - preorder - summary: Vorbestellung registrieren + summary: (Vor-)bestellung registrieren description: | - Registriert eine Vorbestellung. + Registriert eine (Vor-)bestellung. Bestellungsart wird mit `preorderType` definiert. --- Parameter `address`: Anschlussadresse. Soll Starterkit an Anschlussadresse gesendet werden, muss `address.is_shipping` auf true gestellt werden, bei false wird das Starterkit an Vertragsinhaber (`customer`) gesendet. @@ -818,6 +818,18 @@ components: preorderRequest: type: object properties: + preorderType: + type: string + enum: [interest, provision, order] + description: | + Vorbestelltyp + + | preorderType | Description | + |--------------|-------------| + | interest | Interessensbekundung | + | provision | Vorsorgeanschluss | + | order | Vollanschluss | + | reorder | Nachbestellung (nach Bauabschluss) | connectionType: type: string enum: [single-dwelling, multi-dwelling, apartment-building, apartment, business] @@ -832,20 +844,18 @@ components: connectionCount: type: integer default: 1 - description: Anzahl Anschlüsse für Rabatt bei mehreren Anschlüssen in Mehrfamilienhaus + description: Anzahl Anschlüsse bei mehreren Anschlüssen in Mehrfamilienhaus nullable: true - preorderType: + technology: type: string - enum: [interest, provision, order] - description: | - Vorbestelltyp - - | preorderType | Description | - |--------------|-------------| - | interest | Interessensbekundung | - | provision | Vorsorgeanschluss | - | order | Vollanschluss | - | reorder | Nachbestellung (nach Bauabschluss) | + default: gpon + description: Bei Provider eingesetzte Technologie (optional, falls für Patchpunkt im POP nötig) + nullable: true + patchposition: + type: string + default: null + description: Patchpunkt im POP (optional) + nullable: true acceptMarketing: type: boolean description: Zustimmung Datenspeicherung/-weitergabe @@ -894,6 +904,10 @@ components: type: string description: Tür der Anschlussadresse example: 1337 + unit_id: + type: string + description: Zusatzangaben zur Identifizierung der Wohneinheit in einem String. Kann statt den Einzelfeldern (Block, Stiege, Stock, Tür) angegeben werden + example: Stg. 2 Stock 3 Tür 7 is_shipping: type: boolean description: Soll Starterkit an Anschlussadresse gesendet werden. Bei false wird das Starterkit an Vertrasinhaber (`customer`) gesendet.