Request rooms where the user is last admin

v1.0.0

🚀 Since v4.10.0

Description:

Retrieve a list of all rooms where the user is last admin (except homeroom and its subordinary rooms).

Precondition:

Right 🔓 change users required.

Postcondition:

List of rooms is returned.

Further Information:

An empty list is returned if no rooms were found where the user is last admin.

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    },
    "user_id": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "user_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of (last admin user) rooms",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of last admin rooms",
      "items": {
        "type": "object",
        "description": "Room information",
        "required": [
          "id",
          "lastAdminInGroup",
          "name",
          "parentPath"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64",
            "description": "Room ID"
          },
          "lastAdminInGroup": {
            "type": "boolean",
            "description": "Determines whether user is last admin of a room due to being the last member of last admin group"
          },
          "lastAdminInGroupId": {
            "type": "integer",
            "format": "int64",
            "description": "ID of the last admin group where the user is the only remaining member\n\n(returned only if `lastAdminInGroup` is `true`)"
          },
          "name": {
            "type": "string",
            "description": "Room name"
          },
          "parentId": {
            "type": "integer",
            "format": "int64",
            "description": "Parent room ID"
          },
          "parentPath": {
            "type": "string",
            "description": "Parent node path\n\n`/` if node is a root node (room)"
          }
        }
      }
    }
  }
}