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

Beschreibung

Benutzer erhalten [GET] - um eine Liste der Benutzer zu erhalten für eine AS Organisation.

Ermittelt alle Benutzer, die der Organisation angehören. Dies umfasst nur Benutzer, für die der Benutzer eine Ansichtsberechtigung hat.

Request Parameter

  • BENUTZER_ID: STRING, Optional
    Ermittelt alle Felder für die angeforderte Benutzer-ID.

  • MaximaleErgebnisse: INTEGER, Optional
    Abfrage-Parameter. Die maximale Anzahl der Benutzer, die pro Organisation ermittelt werden sollen. Standardwert: 50.

  • Felder: ARRAY, Optional

    BENUTZER: NACHNAME, VORNAME, EMAIL, ENTLASSEN, ENTLASSUNGSDATUM, ROLLEN, BLOCKIERT, BENUTZER_ID
    Abfrage-Parameter. Die Liste der Felder, die für jeden Benutzer ermittelt werden soll.
    Standardmäßig werden alle aufgelisteten Felder ermittelt.

Base URL

{SERVER_BASE_URL}/rest/api/benutzer/Benutzer_erhalten?MaximaleErgebnisse=&Felder=NACHNAME,VORNAME,EMAIL,ENTLASSEN,ENTLASSUNGSDATUM,ROLLEN,BLOCKIERT,BENUTZER_ID&BENUTZER_ID=

Beispiel

Antwort Beispiel Success (Status: 200 OK)

"SUCCESS": "1",
    "BENUTZER": [
        {
            "NACHNAME": "Mustermann",
            "BLOCKIERT": "Nein",
            "VORNAME": "Max",
            "EMAIL": "max.mustermann@demo_orga.de",
            "ENTLASSUNGSDATUM": "",
            "ROLLEN": "Benutzer, Antragsverantwortlicher, Kampagnenverantwortlicher (KV)",
            "BENUTZER_ID": "max.mustermann@demo_orga.de",
            "ENTLASSEN": "Nein"
        },
        {
            "NACHNAME": "Reiners",
            "BLOCKIERT": "Nein",
            "VORNAME": "Isidor",
            "EMAIL": "isidor.reiners@demo_orga.de",
            "ENTLASSUNGSDATUM": "",
            "ROLLEN": "Benutzer, Antragsverantwortlicher",
            "BENUTZER_ID": "isidor.reiners@demo_orga.de",
            "ENTLASSEN": "Nein"
        }
    ],
    "TYP": "BenutzerErhaltenErfolg",
    "DETAIL": "Liste der Benutzer bereitgestellt."
}

Fehler Beispiel (Status: 401 Unauthorized)

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

Fehler Beispiel (Status: 500 Internal Server Error)

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

Fehler Beispiel (Status: 406 Not Acceptable)

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