Brein API

Time Slot

Get all time slots with pagination

GET

/api/v1/time-slot

Retrieve a paginated list of time slots based on query parameters

Get all time slots with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all time slots 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 time slot

POST

/api/v1/time-slot

Create a new time slot with the provided data

Create a new time slot › Request Body

startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?
idnumber · required
Id

Create a new time slot › Responses

Time Slot created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?

POST /api/v1/time-slot

curl --request POST \
  --url /api/v1/time-slot \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}
'

shell

Show example in

Request Body Example

{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}

json

Example Responses

No example

json

application/json

Get time slot by ID

GET

/api/v1/time-slot/{id}

Retrieve a specific time slot by its ID

Get time slot by ID › path Parameters

idnumber · min: 1 · required
Id

Get time slot by ID › Responses

Time Slot detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?

GET /api/v1/time-slot/{id}

curl --request GET \
  --url /api/v1/time-slot/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a time slot

PUT

/api/v1/time-slot/{id}

Update an existing time slot by its ID

Update a time slot › path Parameters

idnumber · min: 1 · required
Id

Update a time slot › Request Body

startTimestring · date-time
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean
Session available?
idnumber
Id

Update a time slot › Responses

Time Slot updated

No data returned

PUT /api/v1/time-slot/{id}

curl --request PUT \
  --url /api/v1/time-slot/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}
'

shell

Show example in

Request Body Example

{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}

json

Example Responses

No example

plain

Delete a time slot

DELETE

/api/v1/time-slot/{id}

Delete a time slot by its ID

Delete a time slot › path Parameters

idnumber · min: 1 · required
Id

Delete a time slot › Responses

Time Slot deleted

No data returned

Create an appointment for a time slot

POST

/api/v1/time-slot/{id}/appointment

Create an appointment by reserving a time slot for one or more students

Create an appointment for a time slot › path Parameters

idnumber · min: 1 · required
Id

Create an appointment for a time slot › Request Body

studentIdsnumber[]
Student IDs to book the appointment for
Example: [1,2]

Create an appointment for a time slot › Responses

Appointment created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

POST /api/v1/time-slot/{id}/appointment

curl --request POST \
  --url /api/v1/time-slot/:id/appointment \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "studentIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Cancel an appointment

PUT

/api/v1/time-slot/{id}/appointment/cancel

Cancel a previously created appointment for a time slot

Cancel an appointment › path Parameters

idnumber · min: 1 · required
Id

Cancel an appointment › Responses

Appointment cancelled

No data returned

PUT /api/v1/time-slot/{id}/appointment/cancel

curl --request PUT \
  --url /api/v1/time-slot/:id/appointment/cancel

shell

Show example in

Example Responses

No example

plain

Session Day Event

Brein API

Time Slot

Get all time slots with pagination

GET

/api/v1/time-slot

Retrieve a paginated list of time slots based on query parameters

Get all time slots with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all time slots 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 time slot

POST

/api/v1/time-slot

Create a new time slot with the provided data

Create a new time slot › Request Body

startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?
idnumber · required
Id

Create a new time slot › Responses

Time Slot created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?

POST /api/v1/time-slot

curl --request POST \
  --url /api/v1/time-slot \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}
'

shell

Show example in

Request Body Example

{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}

json

Example Responses

No example

json

application/json

Get time slot by ID

GET

/api/v1/time-slot/{id}

Retrieve a specific time slot by its ID

Get time slot by ID › path Parameters

idnumber · min: 1 · required
Id

Get time slot by ID › Responses

Time Slot detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean · required
Session available?

GET /api/v1/time-slot/{id}

curl --request GET \
  --url /api/v1/time-slot/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a time slot

PUT

/api/v1/time-slot/{id}

Update an existing time slot by its ID

Update a time slot › path Parameters

idnumber · min: 1 · required
Id

Update a time slot › Request Body

startTimestring · date-time
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
availableboolean
Session available?
idnumber
Id

Update a time slot › Responses

Time Slot updated

No data returned

PUT /api/v1/time-slot/{id}

curl --request PUT \
  --url /api/v1/time-slot/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}
'

shell

Show example in

Request Body Example

{
  "startTime": "2024-08-25T15:00:00Z",
  "endTime": "2024-08-25T15:00:00Z",
  "available": true,
  "id": 0
}

json

Example Responses

No example

plain

Delete a time slot

DELETE

/api/v1/time-slot/{id}

Delete a time slot by its ID

Delete a time slot › path Parameters

idnumber · min: 1 · required
Id

Delete a time slot › Responses

Time Slot deleted

No data returned

Create an appointment for a time slot

POST

/api/v1/time-slot/{id}/appointment

Create an appointment by reserving a time slot for one or more students

Create an appointment for a time slot › path Parameters

idnumber · min: 1 · required
Id

Create an appointment for a time slot › Request Body

studentIdsnumber[]
Student IDs to book the appointment for
Example: [1,2]

Create an appointment for a time slot › Responses

Appointment created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
descriptionstring · required
Description event
eventTypestring · enum · required
Event type
Enum values:
ON_SITE
REMOTE
BOTH
SESSION
mandatoryboolean · required
Event mandatory?
startTimestring · date-time · required
Start date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
endTimestring · date-time · required
End date time (format ISO8601)
Example: 2025-01-27T18:47:08.505Z
timezonestring · required
Timezone of the event
Example: America/Mexico_City
frequencyTypestring · enum · required
Frequency type
Enum values:
NO_REPEAT
WEEKLY
BIWEEKLY
creatorTypestring · enum · required
Creator type
Enum values:
TEACHER
ADMINISTRATIVE
DELEGATE
SCHOOL_ADMINISTRATOR
levelsstring[] · required
School levels
Example: Primary
documentSlugsstring[] · required
Document slugs

studentsobject[]
Students associated with this event
reasonstring
Reason for deletion

POST /api/v1/time-slot/{id}/appointment

curl --request POST \
  --url /api/v1/time-slot/:id/appointment \
  --header 'Content-Type: application/json' \
  --data '
{
  "studentIds": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "studentIds": [
    0
  ]
}

json

Example Responses

No example

json

application/json

Cancel an appointment

PUT

/api/v1/time-slot/{id}/appointment/cancel

Cancel a previously created appointment for a time slot

Cancel an appointment › path Parameters

idnumber · min: 1 · required
Id

Cancel an appointment › Responses

Appointment cancelled

No data returned

PUT /api/v1/time-slot/{id}/appointment/cancel

curl --request PUT \
  --url /api/v1/time-slot/:id/appointment/cancel

shell

Show example in

Example Responses

No example

plain

Session Day Event