Added preorderTrigger / added cif api docs
This commit is contained in:
@@ -14,6 +14,8 @@ tags:
|
||||
description: Abfrage von GWR-Daten
|
||||
- name: preorder
|
||||
description: Abfragen und Operationen zu Vorbestellungen
|
||||
- name: Customer Installation Feedback
|
||||
description: Kundenfeedback Lehrrohrverlegung
|
||||
paths:
|
||||
/addressdb/getClusters:
|
||||
get:
|
||||
@@ -806,6 +808,62 @@ paths:
|
||||
description: Unauthorized
|
||||
'404':
|
||||
description: Vorbestellung nicht gefunden
|
||||
/preorder/customerInstallationFeedback:
|
||||
get:
|
||||
tags:
|
||||
- Customer Installation Feedback
|
||||
summary: Anschluss-/Kundendaten zu ciftoken
|
||||
description: Gibt Anschluss-/Kundendaten zum abgefragten CIF-Token zurück. Dient zum Validieren des Anschlusses durch den Kunden
|
||||
operationId: getCifData
|
||||
parameters:
|
||||
- name: ciftoken
|
||||
in: query
|
||||
description: Client Installation Feedback Token
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
type: string
|
||||
description: Status string
|
||||
example: OK
|
||||
result:
|
||||
$ref: '#/components/schemas/cifResponseData'
|
||||
'400':
|
||||
description: ciftoken missing
|
||||
'401':
|
||||
description: Unauthorized
|
||||
'404':
|
||||
description: Invalid ciftoken
|
||||
post:
|
||||
tags:
|
||||
- Customer Installation Feedback
|
||||
summary: Bestellung auf Status 200 - Rohr im Gebäude setzen
|
||||
description: Setzt Status der Bestellung auf 200 - Rohr im Gebäude. Wird gesetzt wenn beim Kunden die Lehrrohrinstallation abgeschlossen ist. (CIF)
|
||||
operationId: setCifData
|
||||
parameters:
|
||||
- name: ciftoken
|
||||
in: query
|
||||
description: Client Installation Feedback Token
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: Successful operation
|
||||
'400':
|
||||
description: ciftoken missing
|
||||
'401':
|
||||
description: Unauthorized
|
||||
'404':
|
||||
description: Invalid ciftoken
|
||||
components:
|
||||
schemas:
|
||||
timestampString:
|
||||
@@ -1595,6 +1653,75 @@ components:
|
||||
type: integer
|
||||
description: Zeitpunkt der letzten Bearbeitung der Bestellung in Sekunden seit der Unix Epoche
|
||||
example: 1675206000
|
||||
cifResponseData:
|
||||
type: object
|
||||
properties:
|
||||
ciftoken:
|
||||
code:
|
||||
type: string
|
||||
description: Eindeutiger Code der Vorbestellung
|
||||
example: A1B2C3D4
|
||||
oaid:
|
||||
type: string
|
||||
description: Open Access ID der Wohneinheit
|
||||
example: AT-9999-abcdef01.001
|
||||
company:
|
||||
type: string
|
||||
description: Firmenname Kunde
|
||||
example:
|
||||
uid:
|
||||
type: string
|
||||
description: UID (wenn Firmenkunde)
|
||||
example:
|
||||
firstname:
|
||||
type: string
|
||||
description: Vorname Kunde
|
||||
example: Vor
|
||||
lastname:
|
||||
type: string
|
||||
description: Nachname Kunde
|
||||
example: Nachname
|
||||
street:
|
||||
type: string
|
||||
description: Straße Kunde
|
||||
example: Beispielstraße
|
||||
housenumber:
|
||||
type: string
|
||||
description: Hausnummer Kunde
|
||||
example: 42
|
||||
zip:
|
||||
type: string
|
||||
description: PLZ Kunde
|
||||
example: 9999
|
||||
city:
|
||||
type: string
|
||||
description: Gemeinde oder Ortschaft
|
||||
example: Gemeinde/Ort
|
||||
municipality:
|
||||
type: string
|
||||
description: Gemeinde
|
||||
example: Gemeinde
|
||||
district:
|
||||
type: string
|
||||
description: Ortschaft/Ortsteil
|
||||
example: Ortschaft/Ortsteil
|
||||
block:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
stiege:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
stock:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
tuer:
|
||||
type: string
|
||||
description: Adresszusatz
|
||||
example: null
|
||||
|
||||
securitySchemes:
|
||||
api_key_header:
|
||||
type: apiKey
|
||||
|
||||
Reference in New Issue
Block a user