ProSonata API
Folgende HTTP-Methoden stehen für Benutzer zur Verfügung:
Zugriff nur für die Benutzergruppe Administrator.
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"
},
...
]
}
Über Parameter kann gefiltert werden:
GET /api/v1/users?userFirstName=Max
Parameter | Beschreibung |
---|---|
username | Benutzername |
userFirstName | Vorname |
userLastName | Nachname |
E-Mail-Adresse |
Nach folgenden Parametern kann sortiert werden (Sortierrichtung ggf. mit ASC bzw. DESC ergänzen):
userID, username, userFirstName, userLastName, email
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"
}
}
PUT /api/v1/users/{id}
Mögliche Parameter im Body:
Parameter | Beschreibung | Typ |
---|---|---|
username | Benutzername | String |
userFirstName | Vorname | String |
userLastName | Nachname | String |
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.