openapi: 3.0.0
info:
  title: DRIS VE-Anbindungstest Email-Service Kommunikationsservice API
  version: 1.0.0
  description: Schnittstellenspezifikation für DRIS VE-Anbindungstest
paths: {}
components:
  schemas:
    AnbindungstestRequest:
      type: object
      properties:
        anfrageEndpunkt:
          type: string
          format: uri
          description: Endpoint der VE für die Anfrage von Standmitteilungen
        fehlerEndpunkt:
          type: string
          format: uri
          description: Optionaler Endpoint für Fehlerrückmeldung. Wenn nicht vorhanden, wird der Endpoint sowohl für Standmitteilung als auch für Fehlerrückmeldung benutzt.
        nutzer:
          type: array
          nullable: false
          items:
            $ref: '#/components/schemas/Nutzer'
      required:
        - anfrageEndpunkt
        - nutzer
    AnbindungstestResponse:
      type: object
      properties:
        requestorEmail:
          type: string
          format: email
          description: Email des Test-Requestors
        anfrageEndpunkt:
          type: string
          format: uri
          description: getesteter Anspruchsdaten-Endpoint der VE
        fehlerEndpunkt:
          type: string
          format: uri
          description: getesteter Fehlerrueckmeldung-Endpoint der VE
        fehler:
          type: string
          description: Fehler in Testdaten in Email
        nutzerTestergebnisse:
          type: array
          description: Auflistung der Testergebnisse pro Nutzer-Block aus dem Anbindungstest-Request
          items:
            $ref: '#/components/schemas/NutzerTestergebnis'
      required:
        - empfaenger
        - anfrageEndpunkt
    NutzerTestergebnis:
      x-class-extra-annotation: '@javax.json.bind.annotation.JsonbPropertyOrder({"nutzer", "ansprueche", "fehler"})'
      type: object
      properties:
        nutzer:
          $ref: '#/components/schemas/Nutzer'
        anprueche:
          type: array
          items:
            $ref: '#/components/schemas/Anspruch'
        fehler:
          type: Object
          description: |-
            Fehler bei der Ermittlung von Ansprüchen 
            (alles Mögliche - von "host unreacheable" für den Test-Endpunkt bis nicht valide Anspruchsdaten)
      required:
        - nutzer
    Nutzer:
      type: object
      properties:
        geburtsdatum:
          type: string
          pattern: ^(\d{4})-(1[0-2]|0[0-9])-(3[01]|[12][0-9]|0[0-9])$
          example: 1981-01-01
        idNr:
          type: string
          pattern: ^\d{11}$
      required:
        - geburtsdatum
        - idNr
    Anspruch:
      type: object
      description: Flache Anspruch-Repräsentation eines (a,b,c,d) Unterbausteins, wie er in der DRIS-DB abgelegt wird
      properties:
        unterbaustein:
          type: string
        ordnungsbegriff:
          type: string
        produktArt:
          type: string
        private Instant speicherzeitpunkt:
          type: string
        produktBezeichnung:
          type: string
        ansprechpartnerTelefon:
          type: string
        ansprechpartnerEmail:
          type: string
        gesellschaftOderMarkeBezeichnung:
          type: string
        url:
          type: string
        kontaktStrasse:
          type: string
        kontaktHausNr:
          type: string
        kontaktOrt:
          type: string
        kontaktPlz:
          type: string
        kontaktPostfach:
          type: string
        kontaktStaat:
          type: string
        kontaktUrl:
          type: string
        standmitteilungReferenz:
          type: string
        stichtagWertangaben:
          type: string
          format: date
        datumLeistungsbeginnEinmalbetrag:
          type: string
          format: date
        datumLeistungsbeginnRente:
          type: string
          format: date
        datumLeistungsendeRente:
          type: string
          format: date
        nochKeinAnspruch:
          type: boolean
        keineBeitragszahlung:
          type: boolean
        garantiertErreichteRente:
          type: number
          format: double
        prognostiziertErreichteRente:
          type: number
          format: double
        garantiertErreichbareRente:
          type: number
          format: double
        prognostiziertErreichbareRente:
          type: number
          format: double
        garantiertErreichterKapitalwert:
          type: number
          format: double
        prognostiziertErreichterKapitalwert:
          type: number
          format: double
        garantiertErreichbarerKapitalwert:
          type: number
          format: double
        prognostiziertErreichbarerKapitalwert:
          type: number
          format: double
        garantiertErreichterEinmalbetrag:
          type: number
          format: double
        prognostiziertErreichterEinmalbetrag:
          type: number
          format: double
        garantiertErreichbarerEinmalbetrag:
          type: number
          format: double
        prognostiziertErreichbarerEinmalbetrag:
          type: number
          format: double
        standKapital:
          type: number
          format: double
        ratenzahlung:
          type: string
        invalidenAbsicherung:
          type: boolean
        rentenanpassung:
          type: boolean
        hinterbliebenenAbsicherung:
          type: boolean
        steuerpflicht:
          type: boolean
        sozialabgabenpflicht:
          type: boolean
        anrechnung:
          type: boolean
        intervallRentenangabe:
          type: string
        leistungArt:
          type: string