{{getMsg('Help_YouAreHere')}}:
/
{{page.title}}
{{page.title}}
{{$root.getMsg("downLoadHelpAsPdf")}}
{{helpModel.downloadHelpPdfDataStatus}}
User Status
Returns the status of the current user and allows you to update the status.
GET /api/cowork/user
Returns the status of the current user.
{ "id": "<GUID of the current user>", "displayName": "<the user's display name>", "customStatus": "<a custom status text>", "onlineStatus": "<the current online status>" "isIdle": "<the current idle status>" "flags": "<list of additional flags>" }
| RESPONSE Field | Value Type | Description |
|---|---|---|
| id | String | The GUID of the user |
| displayName | String | The display name of the user, visible in CoWork |
| customStatus | String | A custom text displayed to users in CoWork below the display name. |
| onlineStatus | String | The online status of a user. Available values: online, away, dnd, invisible, offline |
| isIdle | Boolean | If true, indicates that all clients of the user are currently idle |
| flags | String | List of additional flags, added by features like calls |
Example Request
# Request # Use user:password for authorization GET /api/cowork/user HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u # Response HTTP/1.1 200 OK Content-Type: application/json { "id": "000000011733c660ad1d4476d", "displayName": "Jane Doe", "customStatus": "What a nice day", "onlineStatus": "away", "isIdle": true, "flags": [] }
POST /api/cowork/user and PUT /api/cowork/user
Update the status of the current user using the following form:
{ "customStatus": "<a custom status text>", "onlineStatus": "<the current online status>" }
| REQUEST Field | Value Type | Description |
|---|---|---|
| customStatus | String (optional) | A custom text displayed to users in CoWork below the display name. |
| onlineStatus | String (optional) | The online status of a user. Available values: online, away, dnd, invisible, offline |
| isIdle | Boolean (optional) | If set to true, indicates that all clients of the user are currently idle |
Example Request
# Request # Use user:password for authorization POST /api/cowork/user HTTP/1.1 Accept: */* Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u {"onlineStatus":"online","customStatus":"Bring it on!"} # Response HTTP/1.1 200 OK Content-Type: application/json { "id": "000000011733c660ad1d4476d", "displayName": "Jane Doe", "customStatus": "Bring it on!", "onlineStatus": "online", "isIdle": false, "flags": [] }
© Copyright 1996 - 2024, i-net software GmbH; All rights Reserved. Imprint
