Classrooms
You can create , update , delete classrooms using our api and also you can assign
users
to and groups to classrooms.
Create a new classroom
{Tenant endpoint}/classrooms
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
name
|
YES
|
string
|
The classroom name must be unique and cannot be duplicated.
|
|
description
|
OPTIONAL
|
string
|
a brief description about the classroom to be created.
|
|
image
|
OPTIONAL
|
image
|
supported types:png,jpeg,jpg,webp
|
|
students
|
OPTIONAL
|
array
|
array of integers , which are the id's of the users in the
database.
|
|
teachers
|
OPTIONAL
|
array
|
array of integers , which are the id's of the users in the
database.
|
|
group_id
|
OPTIONAL
|
integer
|
id of the group which you'd like to add it's students to the classroom.
|
Get all classrooms
{Tenant endpoint}/classrooms
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
No parameters required for this request.
|
Get specific classroom
{Tenant endpoint}/classrooms/{classroom_id}
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
classroom_id
|
YES
|
Integer
|
the id of the desired classroom to get (send in the url not in the body of the
request).
|
Update a classroom
{Tenant endpoint}/classrooms/{classroom_id}
type : or (if you send data as form data)
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
classroom_id
|
YES
|
Integer
|
the id of the desired classroom to get (send in the url not in the body of the
request).
|
|
name
|
YES
|
string
|
The classroom name must be unique and cannot be duplicated.
|
|
description
|
OPTIONAL
|
string
|
a brief description about the classroom to be created.
|
|
image
|
OPTIONAL
|
image
|
supported types:png,jpeg,jpg,webp
|
|
students
|
OPTIONAL
|
array
|
array of integers , which are the id's of the users in the
database.
|
|
teachers
|
OPTIONAL
|
array
|
array of integers , which are the id's of the users in the
database.
|
|
group_id
|
OPTIONAL
|
integer
|
the id of the group you'd like to add it's students to the classroom.
|
Delete a classroom
{Tenant endpoint}/classrooms/{classroom_id}
type :
headers
| Name |
required |
type |
description |
|
referer
|
YES
|
string
|
The root of the application that is sending the request
(your
website at jusoorlabs.com)
|
|
accept
|
YES
|
string
|
the basic accept header (always send it as application/json)
|
|
token
|
YES
|
string
|
The token provided to you once you've registerd with
Jusoor Labs API.
|
parameters
| Name |
required |
type |
description |
|
classroom_id
|
YES
|
Integer
|
the id of the desired classroom to get (send in the url not in the body of the
request).
|