| Info |
|---|
Teil des Integration Service |
| Table of Contents | ||||
|---|---|---|---|---|
|
Benutzer Status abrufen
Endpunkt: GET - api/v1/userstatus/{userid}
...
| Info |
|---|
Das ImageAsSvg Feld ist ein Base64 Encodeter SVG string. 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.
| |
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:
| Code Block | ||
|---|---|---|
| ||
{
"StatusId": "f5f65f25-0f07-4e9d-99bd-fbefd6caac02",
"ReturnCode": 0 // 0 = Success, 1 = NoModuleKey
} |
...
| Info |
|---|
Das ImageAsSvg Feld ist ein Base64 Encodeter SVG string. 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:
| Code Block | ||
|---|---|---|
| ||
{
"ReturnCode": 0 // 0 = Success, 1 = NoSuchUserStatus
} |
...