Knowledge CenterNWL REST API Dokumentation
Referenzen: Feldwerteliste erhalten [GET] - REST API
Letzte Änderung: 31.10.2023

Beschreibung

REST API, um eine Liste von Stammdaten zu erhalten. Die Stammdaten / Referenzdaten, die in der Funktion Antrag Aktualisierung verwendet werden sollen.

  • Antragsteller-Anlagen erhalten
    Um eine Liste Antragsteller-Anlagen zu erhalten
    Dies wird durch Antragsteller_Institution/Mandanten ID eingeschränkt. Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Antragsteller-Anlagen

  • Abfalleigentümer erhalten
    Um eine Liste Abfalleigentümer zu erhalten

  • Behältertypen erhalten
    Um eine Liste Behältertypen zu erhalten
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Behältertyp
    Diese Funktion liefert mehrere Parameter pro Behältertyp, wie z.B. Volumen - "Behältertyp Volume [m3]".

  • Abfallarten erhalten
    Um eine Liste Abfallprodukte-Abfallarten zu erhalten
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Abfallart

  • Standorte erhalten
    Um eine Liste Lagerorte zu erhalten. Um eine Liste Konditionierungsstandorte zu erhalten.
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Aktueller/Abgebender Lagerort, Konditionierungsstandort

  • Abfallprodukte - Form der Bereitstellung erhalten
    Um eine Liste Abfallprodukte - Form der Bereitstellung zu erhalten. Um eine Liste Abfallbehälter Typ zu erhalten.
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Form der Bereitstellung, Abfallbehälter Typ

  • Konditionierungsverfahren erhalten
    Um eine Liste Konditionierungsverfahren zu erhalten.
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Geplantes Konditionierungsverfahren

  • Konditionierungsdienstleister erhalten
    Um eine Liste Konditionierungsdienstleister zu erhalten.
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Konditionierungsdienstleister

  • Konditionierungsanlagen erhalten
    Um eine Liste Konditionierungsanlagen zu erhalten.
    Feldtitel in Antrag Angaben, wo die Referenz verwendet wird: Konditionierungsanlage


Request Parameter

  • Feldcode 
    Siehe ausführliche Dokumentation zu Antrag erstellen und Antrag aktualisieren. Liste aller Codes siehe in der Funktionsdokumentation.
    Bitte geben Sie einen der folgenden Parameter an, indem Sie diese Funktion verwenden: Objekt_Typ ODER Objekt_Id 

  • Objekt_Typ
    Case: Antrag erstellen
    Für Antrag Erstellung - geben Sie den Antragstyp an, siehe Codes der Felder in der Methodendokumentation Antrag aktualisieren.
  • Objekt_Id
    Case: Antrag aktualisieren
    Geben Sie ANTRAGS_ID an 

Base URL

Case: Antrag erstellen
{SERVER_BASE_URL}/rest/api/stammdaten/Feldwerteliste_erhalten?Feldcode=ANTRAGSVERANTWORTLICHER_ID&Objekt_Typ=P_010_QV_ANTRAG

Case: Antrag aktualisieren
{SERVER_BASE_URL}/rest/api/stammdaten/Feldwerteliste_erhalten?Feldcode=KONDITIONIERUNGSZEITRAUM_VON&Objekt_Id=ORG-23-448

Beispiel

Case: Antrag aktualisieren

Antwort Beispiel Success (Status: 200 OK)

{
"SUCCESS": "1",
"FELD": "KONDITIONIERUNGSZEITRAUM_VON",
"TYP": "FeldwertelisteErhaltenErfolg",
"DETAIL": "Die Werteliste wird bereitgestellt.",
"FELDWERTE": [
{
"TITEL": 2021,
"ID": 2021
},
{
"TITEL": 2022,
"ID": 2022
},
{
"TITEL": 2023,
"ID": 2023
},
{
"TITEL": 2024,
"ID": 2024
},
{
"TITEL": 2025,
"ID": 2025
}
]
}

Fehler Beispiel (Status: 404 Not Found)

{
"SUCCESS": "0",
"DETAIL": "Objekt ist nicht gefunden.",
"TYP": "FeldwertelisteErhaltenFehler"
}

Fehler Beispiel (Status: 403 Forbidden)

{
"SUCCESS": "0",
"DETAIL": "Objekt ist nicht editierbar.",
"TYP": "FeldwertelisteErhaltenFehler"
}

Fehler Beispiel (Status: 400 Bad request)

{
"SUCCESS": "0",
"DETAIL": "Unvollständige Daten im Anfragetext.",
"TYP": "FeldwertelisteErhaltenFehler"
}

{
"SUCCESS": "0",
"DETAIL": "Die bereitgestellte Zeichenfolge/String ist kein JSON.",
"TYP": "FeldwertelisteErhaltenFehler"
}

{
"SUCCESS": "0",
"DETAIL": "Objekttyp nicht gefunden.",
"TYP": "FeldwertelisteErhaltenFehler"
}

{
"SUCCESS": "0",
"DETAIL": "Fehlender Anfragetext.",
"TYP": "FeldwertelisteErhaltenFehler"
}

{
"SUCCESS": "0",
"DETAIL": "Unvollständige Daten im Anfragetext.",
"TYP": "FeldwertelisteErhaltenFehler"
}

Fehler Beispiel (Status: 500 Internal Server Error)

{
"SUCCESS": "0",
"DETAIL": "Serverfehler.",
"TYP": "FeldwertelisteErhaltenFehler"
}

Fehler Beispiel (Status: 401 Unauthorized)

{
"SUCCESS": "0",
"DETAIL": "Authentifizierungsfehler.",
"TYP": "FeldwertelisteErhaltenFehler"
}

{
"SUCCESS": "0",
"DETAIL": "Fehlende Berechtigungen zum Erstellen des angegebenen Objekts.",
"TYP": "FeldwertelisteErhaltenFehler"
}

Fehler Beispiel (Status: 406 Not Acceptable)

{
"SUCCESS": "0",
"DETAIL": "Falsche Parameter der HTTP-Anfrage.",
"TYP": "FeldwertelisteErhaltenFehler"
}