Teil des Integration Service
Benutzer Status abrufen
Endpunkt: GET - api/v1/userstatus/{userid}
Version: 2.22.117
Beschreibung: Gibt den Status des angegebenen Benutzers zurück
Beispiel Request:
/v1/auth/userstatus/2
Beispiel Reponse:
[
{
"statusId": "35464b26-05d6-45b2-8f5f-88b148d41b88",
"userId": 2,
"tag": "80.1.0",
"moduleKey": "de.die-groupware.legacy",
"status": 1,
"category": 1,
"priority": 100,
"fromDate": "2023-03-30T10:06:45",
"tooDate": "0001-01-01T00:00:00",
"imageAsSvg": Das ist mein erster Benutzerstatus,
"message": "test",
"link": null,
"linkTitle": ""
},
{
"statusId": "f5f65f25-0f07-4e9d-99bd-fbefd6caac02",
"userId": 2,
"tag": "80.2.0",
"moduleKey": "de.die-groupware.legacy",
"status": 0,
"category": 1,
"priority": 50,
"fromDate": "2023-04-04T08:59:59",
"tooDate": "0001-01-01T00:00:00",
"imageAsSvg": null,
"message": "Das ist mein Zweiter Benutzerstatus",
"link": null,
"linkTitle": ""
}
]
Das ImageAsSvg Feld ist ein Base64 Encodeter SVG string.
Benutzerstatus hinzufügen
Endpunkt: POST - /v1/userstatus/{userid}
Version: 2.22.117
Beschreibung: Erstellt einen Benutzerstatus
Beispiel Request:
/v1/auth/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02
Body:
{
"tag": "string",
"moduleKey": "de.de-groupware.de",
"status": 0, // 0 = Available, 1 = PartlyAvailable, 2 = NotAvailable
"category": 0, // 0 = None, 1 = Basic, 2 = AudioCall, 3 = VideoCall
"priority": 0, // Umso höher der Wert, desto höher ist auch die Priorität innerhalb antonys
"fromDate": "2023-04-04T08:13:47.534Z",
"tooDate": "2023-04-04T10:13:47.534Z",
"imageAsSvg": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><svg xmlns=\"http://www.w3.org/2000/svg\" width=\"1\" height=\"1\"/>"
"message": "Aktuell unterwegs",
"link": "https://google.de",
"linkTitle": "Google"
}
Im ImageAsSvg ist stumpf der Inhalt einer SVG (XML) enthalten
Sollte das TooDate Feld nicht gebraucht werden muss hier ein MinDate eingetragen werden.
Felder Beschreibung:
Feldname | Beschreibung | Optional | Besonderheit |
|---|---|---|---|
tag | Kann beliebiges reingeschrieben werden. Ist z.B. dazu da um Metadaten o.Ä. zwischen zu speichern. Die Variable wird von antony aber nicht benutzt! Diese ist nur für die Eigenentwicklung | ||
modulekey | Dient dazu um nachvollziehen zu können woher der Userstatus kommt. | ||
status | Muss gesetzt werden um Anwesenheitsstatus eines Nutzer zu ändern.
| ||
category | Setzt die Kategorie des Status Mögliche Werte: | ||
priority | Wichtig für antony um zu berechnen welcher Kumulierter Status angezeigt wird. Höherer Wert = Höhere Priorität innerhalb antonys | ||
fromDate | Kann gesetzt werden um anzugeben seit wann dieser Status existiert. In antony steht bei dem Status dann z.B.:  | Zeit als UTC angeben im ISO Format! | |
tooDate | Kann gesetzt werden um anzugeben bis wann dieser Status existiert.  In Kombination mit dem ‘fromDate’ steht dann z.B. folgendes in antony:  | Zeit als UTC angeben im ISO Format! Wenn man am 20.06.2024 um 04:00 Uhr den Status erstellen möchte | |
imageAsSvg | Kann genutzt werden um einen SVG string zu übertragen um ein Icon im Userstatus anzuzeigen | Hier nur den xml string aus der .svg Datei angeben | |
message | Kann genutzt werden um eine Nachricht an den Userstatus zu hängen. Dieser wird dann als ‘Titel’ für den Userstatus genutzt | ||
link | Hier kann ein Link zu einem/r Server/Website reingeschrieben werden. Im Userstatus ist wird dieser angezeigt und ist auch klickbar. Es wird dann der Standardbrowser geöffnet mit dem Link | ||
linkText | Wenn ein ‘link’ angegeben wird kann der linkText statt des Links im Userstatus angezeigt werden wie es z.B. bei Hyperlinks der Fall ist |
Beispiel response:
{
"StatusId": "f5f65f25-0f07-4e9d-99bd-fbefd6caac02",
"ReturnCode": 0 // 0 = Success, 1 = NoModuleKey
}
Benutzerstatus aktualisieren
Endpunkt: PUT- /v1/userstatus/{userid}/{statusid}
Version: 2.22.117
Beschreibung: Aktualisiert den angegebenen status
Beispiel Request:
/v1/auth/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02
Body:
{
"tag": "string",
"moduleKey": "string",
"status": 0, // 0 = Available, 1 = PartlyAvailable, 2 = NotAvailable
"category": 0, // 0 = None, 1 = Basic, 2 = AudioCall, 3 = VideoCall
"priority": 0, // Umso höher der Wert, desto höher ist auch die Priorität innerhalb antonys
"fromDate": "2023-04-04T08:13:47.534Z",
"tooDate": "2023-04-04T08:13:47.534Z",
"imageAsSvg": "string",
"message": "string",
"link": "string",
"linkTitle": "string"
}
Im ImageAsSvg ist stumpf der Inhalt einer SVG (XML) enthalten
Sollte das TooDate Feld nicht gebraucht werden muss hier ein MinDate eingetragen werden.
Felder Beschreibung:
Feldname | Beschreibung | Optional |
|---|---|---|
tag | Kann beliebiges reingeschrieben werden. Ist z.B. dazu da um Metadaten o.Ä. zwischen zu speichern. Die Variable wird von antony aber nicht benutzt! Diese ist nur für die Eigenentwicklung | |
modulekey | Dient dazu um nachvollziehen zu können woher der Userstatus kommt. | |
status | Muss gesetzt werden um Anwesenheitsstatus eines Nutzer zu ändern. Mögliche Werte: | |
category | Setzt die Kategorie des Status Mögliche Werte: | |
priority | Wichtig für antony um zu berechnen welcher Kumulierter Status angezeigt wird. Höherer Wert = Höhere Priorität innerhalb antonys | |
fromDate | Kann gesetzt werden um anzugeben seit wann dieser Status existiert. In antony steht bei dem Status dann z.B.:  | |
tooDate | Kann gesetzt werden um anzugeben bis wann dieser Status existiert. In Kombination mit dem ‘fromDate’ steht dann z.B. folgendes in antony: | |
imageAsSvg | Kann genutzt werden um einen SVG string zu übertragen um ein Icon im Userstatus anzuzeigen | |
message | Kann genutzt werden um eine Nachricht an den Userstatus zu hängen. Dieser wird dann als ‘Titel’ für den Userstatus genutzt | |
link | Hier kann ein Link zu einem/r Server/Website reingeschrieben werden. Im Userstatus ist wird dieser angezeigt und ist auch klickbar. Es wird dann der Standardbrowser geöffnet mit dem Link | |
linkText | Wenn ein ‘link’ angegeben wird kann der linkText statt des Links im Userstatus angezeigt werden wie es z.B. bei Hyperlinks der Fall ist |
Beispiel response:
{
"ReturnCode": 0 // 0 = Success, 1 = NoSuchUserStatus
}
Benutzerstatus löschen
Endpunkt: DELETE - /v1/userstatus/{userid}/{statusid}
Version: 2.22.117
Beschreibung: Löschen des angegebenen Benutzerstatus
Beispiel Request:
/v1/auth/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02
Beispiel response:
{
"ReturnCode": 0 // 0 = Success, 1 = NoSuchUserStatus, 2 = WrongUserForState
}