Knowledge CenterNWL REST API Dokumentation
Anträge - REST API - in Bearbeitung
Letzte Änderung: 03.11.2023

APIs in Verbindung mit Anträgen, Antragsangaben.

Es gibt 2 Hauptgeschäftsszenarien, die durch die Antrag Ressourcen unterstützt werden:

  • In der Phase P1 - Zielprozess initiale “Antragstellung / Antragseinreichung”
  • In den Phasen P2, P3 und P4 - Zielprozess “Nachforderungen“ - Einreichen der Antragsaktualisierung als Rückmeldung auf die Anforderungen von BGE und SV

Die folgenden Ressourcen sind verfügbar:

Die folgenden Antrag Typen werden derzeit von NWL unterstützt. Antrag Typen mit gemeinsamen Datenstrukturen in den Antrag Angaben sind zusammen aufgeführt.
Gemeinsame Antrag Angaben-Felder sind in der Dokumentation entsprechend angegeben:

  • P_010 QV Antrag und P_040 QV Änderungsantrag
  • P_210 QV Modul Antrag und P_240 QV Modul Änderungsantrag
  • P_110 APD / AGD Antrag und P_140 Revisionsantrag APD / AGD
  • P_020 Antrag Sonstiges

Phase P1 und Zielprozess “Antragstellung”

Dies beinhaltet die initiale Antragserstellung, die Funktion "Antrag erstellen", das Hochladen von Antrag Dokumenten durch mehrfachen Aufruf der Funktion "Unterlage hochladen" für jedes Dokument. Für die verschiedenen Antragstypen werden unterschiedliche Dokumentenabschnitte mit entsprechenden Codes verwendet.

Es gibt ein Szenariobeispiel für die Verwendung von Funktionen während des Antragstellungsprozesses:

  • Antrag erstellen - 1 Mal mit erfolgreicher Antwort: Antrags_ID

  • Unterlage hochladen - Aufruf der Funktion für alle Dokumente, die nacheinander im Rahmen von Antrag hochgeladen werden sollen, mit Verweis auf zugehörige Abschnitte. Alternativ können Sie die Funktion Antrag aktualisieren verwenden, um Dokumente hochzuladen.

  • Unterlage aktualisieren - bei Bedarf abhängig von den Ergebnissen von PP. 2 und entsprechenden Antworten.

  • Antrag aktualisieren für alle zugehörigen Felder. Zielszenario - Aufruf der Funktion - kann einmalig, aber je nach Antwort mehrmals aufgerufen werden, um die erforderlichen Datenstrukturen zu aktualisieren.

Ausnahmeszenario: Antrag löschen, für den Fall, dass der Antrag gelöscht werden soll.

P2, P3, and P4 – Zielprozess “Nachforderung”

Der Antragsteller kann den Antrag während des gesamten Zyklus aktualisieren, während der Phasen P2, P3 und P4.
Die Änderungen sind für BGE oder SV erst dann sichtbar, wenn die neue Version des Antrags über den Nachforderungsprozess eingereicht wird.

Es gibt ein Szenariobeispiel für die Verwendung von Funktionen während des Nachforderungsprozesses:

  • Überprüfen Sie den Status des Antrags, da es gestattet ist, den Antrag zu aktualisieren, indem Sie die GET Funktion verwenden und die NWL-Antrag-ID als Parameter angeben:
    Antraege_erhalten mit Antrags_ID
  • Aktualisieren Sie Dokumente, wenn nötig durch Verwendung von
    • Unterlage hochladen
    • Unterlage löschen
    • Unterlage aktualisieren
  • Aktualisieren der Antrag Daten durch Aufruf der Funktion Antrag aktualisieren