Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Set room assignments

PUT
/api/v1/ttx/{ttx_id}/rooms/assignments

Set which room each Player sits in.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
RoomAssignmentsRequest
object
assignments
required
Assignments
Array<object>
>= 1 items <= 500 items
RoomAssignment
object
room_id
Any of:
string format: uuid
user_id
required
User Id
string format: uuid

Example generated

{
  "assignments": [
    {
      "room_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    }
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
RoomsRead

Creator -> Exercise -> Rooms: whether the exercise uses rooms, its rooms and its Players with their seat.

object
players
required
Players
Array<object>
RoomPlayerRead
object
email
required
Email
string
full_name
required
Full Name
string
joined_at
required
Joined At
string format: date-time
last_login_at
Any of:
string format: date-time
room_id
Any of:
string format: uuid
user_id
required
User Id
string format: uuid
rooms
required
Rooms
Array<object>
RoomRead
object
code
required
Code
string
description
required
Description
string
id
required
Id
string format: uuid
name
required
Name
string
player_count
required
Player Count
integer
structure_locked
required
Structure Locked
boolean
team
Team
Array<object>
default:
RoomTeamMemberRead

A team member who follows the session, and the room their view of it opens on (null: the main room). They can still look at any room.

object
email
required
Email
string
full_name
required
Full Name
string
roles
required
Roles
Array<string>
room_id
Any of:
string format: uuid
user_id
required
User Id
string format: uuid
uses_rooms
required
Uses Rooms
boolean

Example 

{
  "team": []
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}