Brein API

Teacher

Get all teachers with pagination

GET

/api/v1/teacher

Retrieve a paginated list of teachers based on query parameters

Get all teachers with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
keystring
Key filter
ignoreGroupIdnumber
Ignore Group ID

Get all teachers with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

Create a new teacher

POST

/api/v1/teacher

Create a new teacher with the provided data

Create a new teacher › Request Body

gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z
phonestring · required
Phone
Example: +523517894545

emailstring
Email of teacher
Default: email@teacher.com

Create a new teacher › Responses

Teacher created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

POST /api/v1/teacher

curl --request POST \
  --url /api/v1/teacher \
  --header 'Content-Type: application/json' \
  --data '
{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z",
  "phone": "+523517894545",
  "email": "email"
}
'

shell

Show example in

Request Body Example

{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z",
  "phone": "+523517894545",
  "email": "email"
}

json

Example Responses

No example

json

application/json

Get groups for the current teacher

GET

/api/v1/teacher/groups

Retrieve all groups associated with the current teacher

Get groups for the current teacher › Responses

Teacher not found

No data returned

Get teacher by ID

GET

/api/v1/teacher/{id}

Retrieve a specific teacher by its ID

Get teacher by ID › path Parameters

idnumber · min: 1 · required
Id

Get teacher by ID › Responses

Teacher detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

GET /api/v1/teacher/{id}

curl --request GET \
  --url /api/v1/teacher/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a teacher

PUT

/api/v1/teacher/{id}

Update an existing teacher by its ID

Update a teacher › path Parameters

idnumber · min: 1 · required
Id

Update a teacher › Request Body

gradesstring[]
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring
School level the teacher is associated with
Example: Primary
lastNamestring
Last name of the teacher
Example: Doe
firstNamestring
First name of the teacher
Example: Jane
secondLastNamestring
Second last name of the teacher
Example: Smith
birthDatestring · date-time
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

Update a teacher › Responses

Teacher updated

No data returned

PUT /api/v1/teacher/{id}

curl --request PUT \
  --url /api/v1/teacher/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z"
}
'

shell

Show example in

Request Body Example

{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z"
}

json

Example Responses

No example

plain

Delete a teacher

DELETE

/api/v1/teacher/{id}

Delete a teacher by its ID

Delete a teacher › path Parameters

idnumber · min: 1 · required
Id

Delete a teacher › Responses

Teacher deleted

No data returned

Upload file with teachers

POST

/api/v1/teacher/bulk

Upload file with teachers › Request Body

filestring

Upload file with teachers › Responses

No data returned

POST /api/v1/teacher/bulk

curl --request POST \
  --url /api/v1/teacher/bulk \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file"
}'

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Notification Preferences School

Brein API

Teacher

Get all teachers with pagination

GET

/api/v1/teacher

Retrieve a paginated list of teachers based on query parameters

Get all teachers with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
keystring
Key filter
ignoreGroupIdnumber
Ignore Group ID

Get all teachers with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

Create a new teacher

POST

/api/v1/teacher

Create a new teacher with the provided data

Create a new teacher › Request Body

gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z
phonestring · required
Phone
Example: +523517894545

emailstring
Email of teacher
Default: email@teacher.com

Create a new teacher › Responses

Teacher created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

POST /api/v1/teacher

curl --request POST \
  --url /api/v1/teacher \
  --header 'Content-Type: application/json' \
  --data '
{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z",
  "phone": "+523517894545",
  "email": "email"
}
'

shell

Show example in

Request Body Example

{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z",
  "phone": "+523517894545",
  "email": "email"
}

json

Example Responses

No example

json

application/json

Get groups for the current teacher

GET

/api/v1/teacher/groups

Retrieve all groups associated with the current teacher

Get groups for the current teacher › Responses

Teacher not found

No data returned

Get teacher by ID

GET

/api/v1/teacher/{id}

Retrieve a specific teacher by its ID

Get teacher by ID › path Parameters

idnumber · min: 1 · required
Id

Get teacher by ID › Responses

Teacher detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
gradesstring[] · required
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring · required
School level the teacher is associated with
Example: Primary
lastNamestring · required
Last name of the teacher
Example: Doe
firstNamestring · required
First name of the teacher
Example: Jane
secondLastNamestring · required
Second last name of the teacher
Example: Smith
birthDatestring · date-time · required
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

GET /api/v1/teacher/{id}

curl --request GET \
  --url /api/v1/teacher/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a teacher

PUT

/api/v1/teacher/{id}

Update an existing teacher by its ID

Update a teacher › path Parameters

idnumber · min: 1 · required
Id

Update a teacher › Request Body

gradesstring[]
Grade level the teacher is responsible for
Example: ["5th Grade"]
levelstring
School level the teacher is associated with
Example: Primary
lastNamestring
Last name of the teacher
Example: Doe
firstNamestring
First name of the teacher
Example: Jane
secondLastNamestring
Second last name of the teacher
Example: Smith
birthDatestring · date-time
Birth date of the teacher
Example: 1980-02-01T12:30:00.000Z

Update a teacher › Responses

Teacher updated

No data returned

PUT /api/v1/teacher/{id}

curl --request PUT \
  --url /api/v1/teacher/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z"
}
'

shell

Show example in

Request Body Example

{
  "grades": [
    "string"
  ],
  "level": "Primary",
  "lastName": "Doe",
  "firstName": "Jane",
  "secondLastName": "Smith",
  "birthDate": "2024-08-25T15:00:00Z"
}

json

Example Responses

No example

plain

Delete a teacher

DELETE

/api/v1/teacher/{id}

Delete a teacher by its ID

Delete a teacher › path Parameters

idnumber · min: 1 · required
Id

Delete a teacher › Responses

Teacher deleted

No data returned

Upload file with teachers

POST

/api/v1/teacher/bulk

Upload file with teachers › Request Body

filestring

Upload file with teachers › Responses

No data returned

POST /api/v1/teacher/bulk

curl --request POST \
  --url /api/v1/teacher/bulk \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file"
}'

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Notification Preferences School