FIX: addressdb/preorder API now uses gemeinde as City

public/docs/preorder-api.yaml

@@ -139,7 +139,7 @@ paths:
                   result:
                     type: object
                     properties:
-                      streets:
+                      zips:
                         $ref: '#/components/schemas/Zips'
         '400':
           description: |
@@ -180,7 +180,7 @@ paths:
                   result:
                     type: object
                     properties:
-                      streets:
+                      cities:
                         $ref: '#/components/schemas/Cities'
         '400':
           description: |
@@ -194,7 +194,7 @@ paths:
       tags:
         - preorder
       summary: Vorbestellung registrieren
-      description: "Registriert eine Vorbestellung. Parameter `type` bestimmt Vorbestelltyp: 'interest' = Interessensbekundung, 'provision' = Vorsorgeanschluss"
+      description: "Registriert eine Vorbestellung. Parameter `type` bestimmt Vorbestelltyp: 'interest' = Interessensbekundung, 'provision' = Vorsorgeanschluss, 'order' = Vollanschluss"
       operationId: submitPreorder
       requestBody:
         description: PreorderRequest object
@@ -233,6 +233,54 @@ paths:
           description: Unauthorized
         '404':
           description: Adresse oder Wohneinheit nicht gefunden
+#  /preorder/{code}:
+#    get:
+#      tags:
+#        - preorder
+#      summary: Details zur Vorbestellung (noch nicht Final)
+#      description: Gibt Details zum Status der Vorbestellung/Bestellung zurück **(noch nicht Final)**
+#      operationId: getPreorderStatus
+#      parameters:
+#        - name: code
+#          in: path
+#          description: code der Vorbestellung
+#          required: true
+#          schema:
+#            type: string
+#      responses:
+#        '200':
+#          description: | 
+#            Successful operation
+#            
+#            Mögliche Werte für Rückgabewert `status`
+#
+#            | id   | text | description |
+#            |------|------|-------------|
+#            | 100  | Aufgenommen | Interessensbekundung/Vorbestellung aufgenommen |
+#            | 110  | Tiefbau in Planung | |
+#            | 120  | Tiefbau in Arbeit | |
+#            | 200  | Tiefbau abgeschlossen | |
+#            | 210  | Leitungsbau in planung | |
+#            | 220  | Leitungsbau in Arbeit | |
+#            | 230  | Leitungsbau abgeschlossen | |
+#            | 300  | Leitungskonfiguration in Planung | |
+#            | 310  | Leitungskonfiguration in Arbeit | |
+#            | 320  | Leitung hergestellt | Produkt bestellbar |
+#          content:
+#            application/json:
+#              schema:
+#                type: object
+#                properties:
+#                  status:
+#                    type: string
+#                    description: Status string
+#                    example: OK
+#                  result:
+#                    $ref: '#/components/schemas/preorderStatusDetail'
+#        '401':
+#          description: Unauthorized
+#        '404':
+#          description: Vorbestellung nicht gefunden
 components:
   schemas:
     addressComponentSearchRequest:
@@ -282,13 +330,70 @@ components:
           description: Ortschaft
       required:
         - street
+    addressResponse:
+      type: object
+      properties:
+        street:
+          type: string
+          description: Strasse der Anschlussadresse
+        housenumber:
+          type: string
+          description: Hausnummer der Anschlussadresse
+        zip:
+          type: string
+          description: PLZ der Anschlussadresse
+        city:
+          type: string
+          description: Ort der Anschlussadresse
+        block:
+          type: string
+          description: Block der Anschlussadresse
+        stock:
+          type: string
+          description: Stock der Anschlussadresse
+        stiege:
+          type: string
+          description: Stiege der Anschlussadresse
+        tuer:
+          type: string
+          description: Tür der Anschlussadresse
+    customerResponse:
+      type: object
+      properties:
+        company:
+          type: string
+          description: Firmenname Kunde
+        uid:
+          type: string
+          description: UID (wenn Firmenkunde)
+        firstname:
+          type: string
+          description: Vorname Kunde
+        lastname:
+          type: string
+          description: Nachname Kunde
+        street:
+          type: string
+          description: Straße Kunde
+        zip:
+          type: string
+          description: PLZ Kunde
+        city:
+          type: string
+          description: Ort Kunde
+        phone:
+          type: string
+          description: Telefonnummer Kunde
+        email:
+          type: string
+          description: Emailadresse Kunde
     preorderRequest:
       type: object
       properties:
         type:
           type: string
           enum: [interest, provision]
-          desciption: Vorbestelltyp (`interest` = Interessensbekundung, `provision` = Vorsorgeanschluss)
+          description: Vorbestelltyp (`interest` = Interessensbekundung, `provision` = Vorsorgeanschluss)
         address:
           type: object
           properties:
@@ -357,6 +462,25 @@ components:
             - street
             - zip
             - city
+    preorderStatusDetail:
+      type: object
+      properties:
+        address:
+          $ref: '#/components/schemas/addressResponse'
+        customer:
+          $ref: '#/components/schemas/customerResponse'
+        status:
+          type: object
+          properties:
+            id:
+              type: int
+              description: status ID
+              example: 220
+            text:
+              type: string
+              description: Statustext
+                
+              example: Tiefbau abgeschlossen, Leitungsbau ausständig
   securitySchemes:
     api_key_header:
       type: apiKey