Page Comparison

Info
Teil des Integration Service

Table of Contents

minLevel	2
maxLevel	2

Benutzer Status abrufen

Endpunkt: GET - api/v1/userstatus/{userid}

Version: 2.22.117

Beschreibung: Gibt den Status des angegebenen Benutzers zurück

Beispiel Request:

Code Block

language	json

 /v1/userstatus/2

Beispiel Reponse:

Code Block

language	json

[
    {
        "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": ""
    }
]

...

Beschreibung: Erstellt einen Benutzerstatus

Beispiel requestRequest:

Code Block

language	json

 /v1/userstatus/2

Body:

Code Block

language	json

{
  "tag": "string",
  "moduleKey": "stringde.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-04T0804T10:13:47.534Z",
  "imageAsSvg": "string",<?xml version=\"1.0\" encoding=\"UTF-8\"?><svg xmlns=\"http://www.w3.org/2000/svg\" width=\"1\" height=\"1\"/>"
  "message": "stringAktuell unterwegs",
  "link": "stringhttps://google.de",
  "linkTitle": "stringGoogle"
}

Info

Das Im ImageAsSvg Feld ist ein Base64 Encodeter SVG string.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. Mögliche Werte: 0 = Verfügbar, 1 = Teilweise Verfügbar 2 = Nicht Verfügbar
category	Setzt die Kategorie des Status Mögliche Werte: 0 = Keine Kategorie 1 = Basis Kategorie 2 = Sprachanruf 3 = Videoanruf
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.:

Image Removed

Image Added		Zeit als UTC angeben im ISO Format! Beispiel: `2024-06-20T00:00:00.000Z` Wenn man am 20.06.2024 um 02:00 Uhr den Status erstellen möchte
tooDate	Kann gesetzt werden um anzugeben bis wann dieser Status existiert. In antony steht bei dem Status dann z.B.:

Image Removed

Image Added In Kombination mit dem ‘fromDate’ steht dann z.B. folgendes in antony: Image Modified		Zeit als UTC angeben im ISO Format! Beispiel: `2024-06-20T02:00:00.000Z` 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:

Code Block

language	json

{
  "StatusId": "f5f65f25-0f07-4e9d-99bd-fbefd6caac02",
  "ReturnCode": 0 // 0 = Success, 1 = NoModuleKey
}

...

Beschreibung: Aktualisiert den angegebenen status

Beispiel requestRequest:

Code Block

language	json

 /v1/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02

Body:

Code Block

language	json

{
  "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"
}

Info

Das Im ImageAsSvg Feld ist ein Base64 Encodeter SVG string.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	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. Mögliche Werte: 0 = Verfügbar, 1 = Teilweise Verfügbar 2 = Nicht Verfügbar
category	Setzt die Kategorie des Status Mögliche Werte: 0 = Keine Kategorie 1 = Basis Kategorie 2 = Sprachanruf 3 = Videoanruf
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.: Image Added	Zeit als UTC angeben im ISO Format! Beispiel: `2024-06-20T00:00:00.000Z` Wenn man am 20.06.2024 um 02:00 Uhr den Status erstellen möchte
tooDate	Kann gesetzt werden um anzugeben bis wann dieser Status existiert. In antony steht bei dem Status dann z.B.: Image Added In Kombination mit dem ‘fromDate’ steht dann z.B. folgendes in antony: Image Added	Zeit als UTC angeben im ISO Format! Beispiel: `2024-06-20T02:00:00.000Z` 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:

Code Block

language	json

{
  "ReturnCode": 0 // 0 = Success, 1 = NoSuchUserStatus
}

...

Beschreibung: Löschen des angegebenen Benutzerstatus

Beispiel Request:

Code Block

language	json

 /v1/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02

Beispiel response:

Code Block

language	json

{
  "ReturnCode": 0 // 0 = Success, 1 = NoSuchUserStatus, 2 = WrongUserForState
}

...

Version	Old Version 4	New Version Current
Changes made by	Pascal Kordas	Pascal Kordas
Saved on	May 17, 2023	Jul 25, 2024

Page Comparison

Versions Compared

Key

Teil des Integration Service

Benutzer Status abrufen