Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Beschreibung: Gibt den Status des angegebenen Benutzers zurück

Beispiel Request:

Code Block
languagejson
 /v1/auth/userstatus/2

Beispiel Reponse:

Code Block
languagejson
[
    {
        "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
languagejson
 /v1/auth/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02

Body:

Code Block
languagejson
{
  "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-04T08:13:47.534Z",
  "imageAsSvg": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><svg xmlns=\"http://www.w3.org/2000/svg\" "string",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.

...

Beschreibung: Aktualisiert den angegebenen status

Beispiel requestRequest:

Code Block
languagejson
 /v1/auth/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02

Body:

Code Block
languagejson
{
  "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.

...

Beschreibung: Löschen des angegebenen Benutzerstatus

Beispiel Request:

Code Block
languagejson
 /v1/auth/userstatus/2/f5f65f25-0f07-4e9d-99bd-fbefd6caac02

Beispiel response:

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

...