Knowledge Center
Referenzen: Benutzer erhalten [GET] - REST API
Letzte Änderung: 21.08.2024

Beschreibung

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

Erhalten Sie Informationen über Benutzer in Ihrer Organisation.

Anfrage URL

{SERVER_BASE_URL}/rest/api/benutzer/Benutzer_erhalten

Headers

Accept: application/json

Abfrageparameter

  • Benutzer_ID STRING Optional
    Wenn der Parameter angegeben wird, werden die Daten für die angegebene Benutzer-ID ermittelt. Wenn der Parameter nicht angegeben wird, werden die Daten für alle Benutzer in der Organisation ermittelt.

  • Felder ARRAY Optional
    Die zu ermittelnden Felder sollten durch ein Komma (",") getrennt werden. Wenn der Parameter nicht angegeben wird, werden alle Felder der Anfrage ermittelt.
    Mögliche Werte: NACHNAME, VORNAME, EMAIL, ENTLASSEN, ENTLASSUNGSDATUM, ROLLEN, BLOCKIERT, BENUTZER_ID

  • MaximaleErgebnisse INTEGER Optional
    Die maximale Anzahl an Ergebnissen, die ermittelt werden. Standardwert: 50.

  • Seite INTEGER Optional
    Die durch die Anfrage ermittelten Benutzer werden nach "Seiten" entsprechend dem Wert des Parameters "MaximaleErgebnisse" unterteilt. Wenn der Parameter "Seite" angegeben ist, wird die entsprechende Seite ermittelt. Standardwert: 1.

Beispiel

Einzelnutzer:
{SERVER_BASE_URL}/rest/api/benutzer/Benutzer_erhalten?Benutzer_ID=max.mustermann@organisation.de

Alle Benutzer:
{SERVER_BASE_URL}/rest/api/benutzer/Benutzer_erhalten?MaximaleErgebnisse=2&Felder=NACHNAME,VORNAME,EMAIL

Antworten

Einzelnutzer

{
"SUCCESS":"1",
"BENUTZER":  [
    {
        "NACHNAME":"Mustermann",
        "BLOCKIERT":"Nein",
        "VORNAME":"Max",
        "EMAIL":"max.mustermann@organisation.de",
        "ENTLASSUNGSDATUM":"",
        "ROLLEN":"Benutzer, AS Planungsverantwortlicher, Kampagnenverantwortlicher (KV), Antragsverantwortlicher, Mandanten Admin, Antragsteller - Alle Anträge bearbeiten",
        "BENUTZER_ID":"max.mustermann@organisation.de",
        "ENTLASSEN":"Nein"
    }],
"TYP":"BenutzerErhaltenErfolg",
"DETAIL":"Die Benutzerliste wird bereitgestellt."
}

Alle Benutzer

{
"SUCCESS":"1",
"BENUTZER": [
    {
        "NACHNAME":"Mustermann",
        "VORNAME":"Max",
        "EMAIL":"max.mustermann@organisation.de"
    },
    {
        "NACHNAME":"Volger",
        "VORNAME":"Sophie",
        "EMAIL":"Sophie.Volger@organisation.de"
    } ],
"TYP":"BenutzerErhaltenErfolg",
"DETAIL":"Die Benutzerliste wird bereitgestellt."
}

Fehler

{
"RESPONSE_CODE":"G400.008",
"SUCCESS":"0",
"TYP":"BenutzerErhaltenFehler",
"DETAIL":"Falsche Daten für Feld 'Felder' angegeben."
}