Knowledge CenterNWL REST API Dokumentation
Anträge: Antrag erhalten [GET] - REST API
Letzte Änderung: 21.08.2024

Beschreibung

Funktion zum Abrufen von Daten des Antrags.
Für die angegebene Antrags-ID ermittelt die Anfrage die Werte der angefragten Felder.
Wenn keine Felder angegeben sind, werden alle Daten ermittelt.

Anfrage URL

{SERVER_BASE_URL}/rest/api/antraege/Antrag_erhalten

Headers

Accept: application/json

Abfrageparameter

  • Antrags_ID  Pflicht
    ID des Antrags, für den Informationen extrahiert werden sollen.
  • FeldcodeListe  Optional
    Die zu ermittelnden Felder sollten durch ein Komma (",") getrennt werden.
    Wenn der Parameter nicht angegeben wird, werden alle Felder der Anfrage ermittelt.

Beispiel

Alle Felder:
{SERVER_BASE_URL}/rest/api/antraege/Antrag_erhalten?Antrags_ID=ORG-24-077

Angegebene Felder:
{SERVER_BASE_URL}/rest/api/antraege/Antrag_erhalten?Antrags_ID=ORG-24-077&FeldcodeListe=ANTRAGSTITEL,ANTRAGSTELLER_INTERN_ID

Antworten

Success

{
"ANGABEN":[
    {
    "FELDER": [
        {
            "FELD_ID":"ANTRAGSTITEL",
            "FELD_WERT":"Mengenerhöhung und Verlängerung der Konditionierungsperiode bis 2025",
            "FELD_TYP":"INPUT_TEXT",
            "FELD_TITEL":"Antragstitel",
            "IST_PFLICHT":1,
            "IST_EDITIERBAR":1
        },
        {
            "FELD_ID":"ANTRAGSTELLER_INTERN_ID",
            "FELD_WERT":"",
            "FELD_TYP":"INPUT_TEXT",
            "FELD_TITEL":"Antragsteller - interne Bezeichnung / ID",
            "IST_PFLICHT":0,
            "IST_EDITIERBAR":1
        }],
        "PAGE":"A. Verwaltungstechnische Angaben"
    }],
"SUCCESS":"1",
"TYP":"GetObjectInfoSuccess",
"DETAIL":"Objektinformationen bereitgestellt"
}

Fehler

{
"RESPONSE_CODE":"G400.011",
"SUCCESS":"0",
"TYP":"GetObjectInfoError",
"DETAIL":"Objekt ist nicht gefunden."
}