Skip to content

Commit 8a350e2

Browse files
committed
Update API docs with new add users to room method
1 parent 7cb887c commit 8a350e2

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

documentation/api.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ This document will explain how is used the Licensoft-Web API.
1919
* [Add user to room](#add-user-to-room)
2020
* [Get assistants](#get-assistants)
2121
* [Create rooms](#create-rooms)
22+
* [Add users to room](#add-users-to-room)
2223
* [Raise hand](#raise-hand)
2324
* [Lower hand](#lower-hand)
2425
* [Get hand raised users](#get-hand-raised-users)
@@ -423,6 +424,57 @@ Creates rooms with the specified names. Two rooms cannot have the same name.
423424
- **Response**:
424425
200 OK
425426

427+
### Add users to room ###
428+
Adds already existing users to a room with the specified role for each one of them.
429+
- **URL**
430+
`/ovTeachingApi/room/{roomName}/users`
431+
- **Method**
432+
`POST`
433+
- **Required role**:
434+
System: ADMIN
435+
Room: Moderator
436+
- **Data Params**
437+
* Body:
438+
~~~~ typescript
439+
{
440+
"moderators"?: [
441+
{
442+
"name": string
443+
}
444+
],
445+
"presenters"?: [
446+
{
447+
"name": string
448+
}
449+
],
450+
"participants"?: [
451+
{
452+
"name": string
453+
}
454+
]
455+
}
456+
~~~~
457+
- **Example**
458+
- **Request**:
459+
`/ovTeachingApi/room/roomA/users`\
460+
Username: teacher
461+
Password: pass
462+
* Body:
463+
~~~~ typescript
464+
{
465+
"participants": [
466+
{
467+
"name": "participant1"
468+
},
469+
{
470+
"name": "participant2"
471+
}
472+
]
473+
}
474+
~~~~
475+
- **Response**:
476+
200 OK
477+
426478
### Raise hand ###
427479
Makes the user raise their hand. This method does not send signals to other users, it just acknowledges that the user did it in the backend.
428480
- **URL**

0 commit comments

Comments
 (0)