From fbe825793f197f5d5742c1a90a9f580bf2696282 Mon Sep 17 00:00:00 2001 From: Frank Schubert Date: Wed, 21 Jun 2023 17:38:22 +0200 Subject: [PATCH] Added address.oaid to Preorder docs yaml --- public/docs/preorder-api.yaml | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/public/docs/preorder-api.yaml b/public/docs/preorder-api.yaml index 8ba7c6b90..3f3eb70df 100644 --- a/public/docs/preorder-api.yaml +++ b/public/docs/preorder-api.yaml @@ -429,6 +429,8 @@ paths: Parameter `address`: Anschlussadresse. + Das Feld `oaid` ist **optional**: Wird die **OAID der Adresse** oder die **OAID der Wohneinheit** übergeben, können die Adressbestandteile leer/NULL sein oder ganz entfallen. + Soll Starterkit an Anschlussadresse gesendet werden, muss `address.is_shipping` auf true gestellt werden, bei false wird das Starterkit an Vertragsinhaber (`customer`) gesendet. Wohneinheitsidentifikation (Block, Stiege, Stock, Tür) kann strukturiert mit jeweils einem eigenen Feld übergeben werden oder alle Wohneinheitsdaten in einem einzigen String (`unit_string`). @@ -1116,6 +1118,10 @@ components: type: object description: Anschlussadresse properties: + oaid: + type: string + description: Optional. OAID der Adresse oder OAID der Wohneinheit. Wird OAID angegeben, können die Adressbestandteile entfallen + example: AT-9999-abcdef01.001 street: type: string description: Strasse der Anschlussadresse @@ -1156,11 +1162,6 @@ components: type: boolean description: Soll Starterkit an Anschlussadresse gesendet werden. Bei false wird das Starterkit an Vertrasinhaber (`customer`) gesendet. example: true - required: - - street - - housenumber - - zip - - city address_info: type: string description: Zusätzliche Info zur Adresse