Brein API

School

Initialize modules for a school

POST

/api/v1/school/{id}/initialize-modules

Initialize all required modules for a school by its ID

Initialize modules for a school › path Parameters

idnumber · min: 1 · required
Id

Initialize modules for a school › Responses

Modules initialized successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

POST /api/v1/school/{id}/initialize-modules

curl --request POST \
  --url /api/v1/school/:id/initialize-modules

shell

Show example in

Example Responses

No example

json

application/json

Get all available school levels

GET

/api/v1/school/levels

Retrieve a list of all available school levels

Get all available school levels › Responses

string

GET /api/v1/school/levels

curl --request GET \
  --url /api/v1/school/levels

shell

Show example in

Example Responses

No example

json

application/json

Get available levels for current school

GET

/api/v1/school/levels/available

Retrieve the list of available levels for the current school

Get available levels for current school › Responses

string

GET /api/v1/school/levels/available

curl --request GET \
  --url /api/v1/school/levels/available

shell

Show example in

Example Responses

No example

json

application/json

Get all schools with pagination

GET

/api/v1/school

Retrieve a paginated list of schools. Returns current school if tenant is not brein

Get all schools with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all schools 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 school

POST

/api/v1/school

Create a new school with the provided data

Create a new school › Request Body

namestring · required
Name of the school
Example: Springfield High School
administratorobject · required
School Administrator

workCenterKeystring
Work center key of the school
Example: 0000001

Create a new school › Responses

School created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

POST /api/v1/school

curl --request POST \
  --url /api/v1/school \
  --header 'Content-Type: application/json' \
  --data '
{
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "administrator": {
    "lastName": "Doe",
    "secondLastName": "Smith",
    "firstName": "Jane",
    "phone": "+541175975884",
    "email": "email"
  }
}
'

shell

Show example in

Request Body Example

{
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "administrator": {
    "lastName": "Doe",
    "secondLastName": "Smith",
    "firstName": "Jane",
    "phone": "+541175975884",
    "email": "email"
  }
}

json

Example Responses

No example

json

application/json

Get school by ID

GET

/api/v1/school/{id}

Retrieve a specific school by its ID with all relations

Get school by ID › path Parameters

idnumber · min: 1 · required
Id

Get school by ID › Responses

School detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

GET /api/v1/school/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school

PUT

/api/v1/school/{id}

Update an existing school by its ID

Update a school › path Parameters

idnumber · min: 1 · required
Id

Update a school › Request Body

tenantIdstring
Tenant ID for the school
Example: tenant-123
workCenterKeystring
Work center key of the school
Example: 0000001
namestring
Name of the school
Example: Springfield High School
emailstring
Email school
Example: contact@school.com
phonestring
Phone school
Example: +521148863257
slugImgstring
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[]
Levels of the school
Example: Middle School, High School
statusstring · enum
School status
Enum values:
INITIAL_DATA
CONFIGURED
addressobject
School address

Update a school › Responses

School updated

No data returned

PUT /api/v1/school/{id}

curl --request PUT \
  --url /api/v1/school/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": "tenant-123",
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "email": "contact@school.com",
  "phone": "+521148863257",
  "slugImg": "/slug-school/school-123.png",
  "levels": [
    "string"
  ],
  "status": "INITIAL_DATA",
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  }
}
'

shell

Show example in

Request Body Example

{
  "tenantId": "tenant-123",
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "email": "contact@school.com",
  "phone": "+521148863257",
  "slugImg": "/slug-school/school-123.png",
  "levels": [
    "string"
  ],
  "status": "INITIAL_DATA",
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  }
}

json

Example Responses

No example

plain

Delete a school

DELETE

/api/v1/school/{id}

Delete a school by its ID

Delete a school › path Parameters

idnumber · min: 1 · required
Id

Delete a school › Responses

School deleted

No data returned

Get school statistics

GET

/api/v1/school/{id}/stats

Retrieve statistics for a school including counts of students, teachers, etc.

Get school statistics › path Parameters

idnumber · min: 1 · required
Id

Get school statistics › Responses

School statistics

studentsCountnumber · required
Students count
Example: 150
mothersCountnumber · required
Mothers count
Example: 120
fathersCountnumber · required
Fathers count
Example: 100
delegatesCountnumber · required
Delegates count
Example: 25
teachersCountnumber · required
Teachers count
Example: 30
administrativeCountnumber · required
Administrative count
Example: 15
usersCountnumber · required
Users count
Example: 440

GET /api/v1/school/{id}/stats

curl --request GET \
  --url /api/v1/school/:id/stats

shell

Show example in

Example Responses

No example

json

application/json

Generate signed URL for school logo

PUT

/api/v1/school/logo/signed-url

Generate a signed URL for uploading or accessing school logo

Generate signed URL for school logo › Request Body

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de image
Example: image/webp

Generate signed URL for school logo › Responses

No data returned

PUT /api/v1/school/logo/signed-url

curl --request PUT \
  --url /api/v1/school/logo/signed-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "contentType": "image/webp"
}
'

shell

Show example in

Request Body Example

{
  "method": "GET",
  "contentType": "image/webp"
}

json

Example Responses

No example

plain

Delete multiple schools

DELETE

/api/v1/school/bulk

Delete multiple schools by their IDs

Delete multiple schools › Request Body

idsnumber[] · required
Group list of Ids

Delete multiple schools › Responses

School deleted

No data returned

DELETE /api/v1/school/bulk

curl --request DELETE \
  --url /api/v1/school/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "ids": [
    0
  ]
}

json

Example Responses

No example

plain

Update school address

PUT

/api/v1/school/address

Update the address of the current school. For SUPER_ADMIN, schoolId must be provided in the body.

Update school address › Request Body

addressIdnumber · min: 1 · required
Address id
Example: 1

schoolIdnumber · min: 1
School id (required for SUPER_ADMIN)
Example: 1

Update school address › Responses

School updated

No data returned

PUT /api/v1/school/address

curl --request PUT \
  --url /api/v1/school/address \
  --header 'Content-Type: application/json' \
  --data '
{
  "addressId": 1,
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "addressId": 1,
  "schoolId": 1
}

json

Example Responses

No example

plain

Teacher School Administrator

Brein API

School

Initialize modules for a school

POST

/api/v1/school/{id}/initialize-modules

Initialize all required modules for a school by its ID

Initialize modules for a school › path Parameters

idnumber · min: 1 · required
Id

Initialize modules for a school › Responses

Modules initialized successfully

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

POST /api/v1/school/{id}/initialize-modules

curl --request POST \
  --url /api/v1/school/:id/initialize-modules

shell

Show example in

Example Responses

No example

json

application/json

Get all available school levels

GET

/api/v1/school/levels

Retrieve a list of all available school levels

Get all available school levels › Responses

string

GET /api/v1/school/levels

curl --request GET \
  --url /api/v1/school/levels

shell

Show example in

Example Responses

No example

json

application/json

Get available levels for current school

GET

/api/v1/school/levels/available

Retrieve the list of available levels for the current school

Get available levels for current school › Responses

string

GET /api/v1/school/levels/available

curl --request GET \
  --url /api/v1/school/levels/available

shell

Show example in

Example Responses

No example

json

application/json

Get all schools with pagination

GET

/api/v1/school

Retrieve a paginated list of schools. Returns current school if tenant is not brein

Get all schools with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter

Get all schools 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 school

POST

/api/v1/school

Create a new school with the provided data

Create a new school › Request Body

namestring · required
Name of the school
Example: Springfield High School
administratorobject · required
School Administrator

workCenterKeystring
Work center key of the school
Example: 0000001

Create a new school › Responses

School created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

POST /api/v1/school

curl --request POST \
  --url /api/v1/school \
  --header 'Content-Type: application/json' \
  --data '
{
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "administrator": {
    "lastName": "Doe",
    "secondLastName": "Smith",
    "firstName": "Jane",
    "phone": "+541175975884",
    "email": "email"
  }
}
'

shell

Show example in

Request Body Example

{
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "administrator": {
    "lastName": "Doe",
    "secondLastName": "Smith",
    "firstName": "Jane",
    "phone": "+541175975884",
    "email": "email"
  }
}

json

Example Responses

No example

json

application/json

Get school by ID

GET

/api/v1/school/{id}

Retrieve a specific school by its ID with all relations

Get school by ID › path Parameters

idnumber · min: 1 · required
Id

Get school by ID › Responses

School detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tenantIdstring · required
Tenant ID for the school
Example: tenant-123
namestring · required
Name of the school
Example: Springfield High School
emailstring · required
Email school
Example: contact@school.com
phonestring · required
Phone school
Example: +521148863257
slugImgstring · required
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[] · required
Levels of the school
Example: Middle School, High School
statusstring · enum · required
School status
Enum values:
INITIAL_DATA
CONFIGURED

workCenterKeystring
Work center key of the school
Example: 0000001

GET /api/v1/school/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school

PUT

/api/v1/school/{id}

Update an existing school by its ID

Update a school › path Parameters

idnumber · min: 1 · required
Id

Update a school › Request Body

tenantIdstring
Tenant ID for the school
Example: tenant-123
workCenterKeystring
Work center key of the school
Example: 0000001
namestring
Name of the school
Example: Springfield High School
emailstring
Email school
Example: contact@school.com
phonestring
Phone school
Example: +521148863257
slugImgstring
Slug of the school image
Example: /slug-school/school-123.png
levelsstring[]
Levels of the school
Example: Middle School, High School
statusstring · enum
School status
Enum values:
INITIAL_DATA
CONFIGURED
addressobject
School address

Update a school › Responses

School updated

No data returned

PUT /api/v1/school/{id}

curl --request PUT \
  --url /api/v1/school/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": "tenant-123",
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "email": "contact@school.com",
  "phone": "+521148863257",
  "slugImg": "/slug-school/school-123.png",
  "levels": [
    "string"
  ],
  "status": "INITIAL_DATA",
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  }
}
'

shell

Show example in

Request Body Example

{
  "tenantId": "tenant-123",
  "workCenterKey": "0000001",
  "name": "Springfield High School",
  "email": "contact@school.com",
  "phone": "+521148863257",
  "slugImg": "/slug-school/school-123.png",
  "levels": [
    "string"
  ],
  "status": "INITIAL_DATA",
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  }
}

json

Example Responses

No example

plain

Delete a school

DELETE

/api/v1/school/{id}

Delete a school by its ID

Delete a school › path Parameters

idnumber · min: 1 · required
Id

Delete a school › Responses

School deleted

No data returned

Get school statistics

GET

/api/v1/school/{id}/stats

Retrieve statistics for a school including counts of students, teachers, etc.

Get school statistics › path Parameters

idnumber · min: 1 · required
Id

Get school statistics › Responses

School statistics

studentsCountnumber · required
Students count
Example: 150
mothersCountnumber · required
Mothers count
Example: 120
fathersCountnumber · required
Fathers count
Example: 100
delegatesCountnumber · required
Delegates count
Example: 25
teachersCountnumber · required
Teachers count
Example: 30
administrativeCountnumber · required
Administrative count
Example: 15
usersCountnumber · required
Users count
Example: 440

GET /api/v1/school/{id}/stats

curl --request GET \
  --url /api/v1/school/:id/stats

shell

Show example in

Example Responses

No example

json

application/json

Generate signed URL for school logo

PUT

/api/v1/school/logo/signed-url

Generate a signed URL for uploading or accessing school logo

Generate signed URL for school logo › Request Body

methodstring · required
Method of request (GET | PUT)
Example: GET
contentTypestring · required
Content type of de image
Example: image/webp

Generate signed URL for school logo › Responses

No data returned

PUT /api/v1/school/logo/signed-url

curl --request PUT \
  --url /api/v1/school/logo/signed-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "GET",
  "contentType": "image/webp"
}
'

shell

Show example in

Request Body Example

{
  "method": "GET",
  "contentType": "image/webp"
}

json

Example Responses

No example

plain

Delete multiple schools

DELETE

/api/v1/school/bulk

Delete multiple schools by their IDs

Delete multiple schools › Request Body

idsnumber[] · required
Group list of Ids

Delete multiple schools › Responses

School deleted

No data returned

DELETE /api/v1/school/bulk

curl --request DELETE \
  --url /api/v1/school/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "ids": [
    0
  ]
}

json

Example Responses

No example

plain

Update school address

PUT

/api/v1/school/address

Update the address of the current school. For SUPER_ADMIN, schoolId must be provided in the body.

Update school address › Request Body

addressIdnumber · min: 1 · required
Address id
Example: 1

schoolIdnumber · min: 1
School id (required for SUPER_ADMIN)
Example: 1

Update school address › Responses

School updated

No data returned

PUT /api/v1/school/address

curl --request PUT \
  --url /api/v1/school/address \
  --header 'Content-Type: application/json' \
  --data '
{
  "addressId": 1,
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "addressId": 1,
  "schoolId": 1
}

json

Example Responses

No example

plain

Teacher School Administrator