Benutzer

Folgende HTTP-Methoden stehen für Benutzer zur Verfügung:

Zugriff nur für die Benutzergruppe Administrator.

alle Benutzer auflisten

GET /api/v1/users

Antwort:

{
  "meta": {
    "status": 200,
    "perPage": 100,
    "page": 1,
    "totalCount": 23,
    "requestUserID": 1,
    "requestUsername": "Admin1",
    "usergroupName": "Administrator",
    "apiLimitRemaining": 463,
    "apiLimitReset": 802
  },
  "data": [
    {
      "userID": 1,
      "username": "Admin1",
      "userFirstName": "Max",
      "userLastName": "Mustermann",
      "email": "max@testcompany.de",
      "userPhone": "06051 12345678"
    },
    ...
  ]
}

Filterung/Suche

Über Parameter kann gefiltert werden:

GET /api/v1/users?userFirstName=Max
Parameter Beschreibung
username Benutzername
userFirstName Vorname
userLastName Nachname
email E-Mail-Adresse

Sortierung

Nach folgenden Parametern kann sortiert werden (Sortierrichtung ggf. mit ASC bzw. DESC ergänzen):

userID, username, userFirstName, userLastName, email

einen Benutzer aufrufen

GET /api/v1/users/{id}

Antwort:

{
  "meta": {
    "status": 200,
    "requestUserID": 1,
    "requestUsername": "Admin1",
    "usergroupName": "Administrator",
    "apiLimitRemaining": 486,
    "apiLimitReset": 642
  },
  "data": {
    "userID": 1,
    "username": "Admin1",
    "userFirstName": "Max",
    "userLastName": "Mustermann",
    "email": "max@testcompany.de",
    "userPhone": "06051 12345678"
  }
}

einen Benutzer bearbeiten

PUT /api/v1/users/{id}

Mögliche Parameter im Body:

Parameter Beschreibung Typ
username Benutzername String
userFirstName Vorname String
userLastName Nachname String
email E-Mail-Adresse String
userPhone Telefonnummer String

Es müssen nicht alle Parameter für eine Bearbeitung übergeben werden.

Weitere Parameter, wie z.B. das Passwort, können nur über die ProSonata Software geändert werden.