Knowledge CenterNWL REST API Dokumentation
Anträge: Antrag löschen [DEL] - REST API
Letzte Änderung: 31.10.2023

Beschreibung

Funktion zum Löschen von Anträgen.

Hinweis: Als Antrag kann nur während der „Phase 1 Antragstellung“ gelöscht werden.

Base URL und API Parameter

{SERVER_BASE_URL}/rest/api/antraege/Antrag_loeschen?objekt_id=<ANTRAG_ID>
Parameters: ANTRAGS_ID

Beispiel

Antwort Beispiel Success

{
    "SUCCESS": 1,
    "TYP": "LöschenErfolg",
    "OBJEKT_ID": "ORG-23-481",
    "DETAIL": "Der Antrag wurde gelöscht."
}

Fehler Beispiel (Status: 400 Bad request)

{
    "SUCCESS": 0,
    "TYP": "LöschenFehler",
    "OBJEKT_ID": "RWE-23-481",
    "DETAIL": <Custom error message from GetCaesar in case of deletion error>
}
{
    "SUCCESS": "0",
    "DETAIL": "Unvollständige Daten im Anfragetext.",
    "TYP": "LöschenFehler"
}

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

{
    "SUCCESS": "0",
    "DETAIL": "Objekttyp nicht gefunden.",
    "TYP": "LöschenFehler"
}

{
    "SUCCESS": "0",
    "DETAIL": "Fehlender Anfragetext.",
    "TYP": "LöschenFehler"
}

Fehler Beispiel (Status: 500 Internal Server Error)

{
    "SUCCESS": "0",
    "DETAIL": "Serverfehler.",
    "TYP": "LöschenFehler"
}

Fehler Beispiel (Status: 401 Unauthorized)

{
    "SUCCESS": "0",
    "DETAIL": "Serverfehler.",
    "TYP": "LöschenFehler"
}

Fehler Beispiel (Status: 406 Not Acceptable)

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

Fehler Beispiel (Status: 403 Forbidden)

{
    "SUCCESS": "0",
    "TYP": "LöschenFehler",
    "DETAIL": "Berechtigung nicht ausreichend!"
}

{
    "SUCCESS": "0",
    "DETAIL": "Objekt ist nicht editierbar.",
    "TYP": "LöschenFehler"
}