Brein API

Application Module

Get all application modules with pagination

GET

/api/v1/application-module

Retrieve a paginated list of application modules based on query parameters

Get all application modules with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
schoolIdnumber
Filter by school ID
moduleTypestring · enum
Filter by module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
isEnabledboolean
Filter by enabled status

Get all application modules 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)

GET /api/v1/application-module

curl --request GET \
  --url /api/v1/application-module

shell

Show example in

Example Responses

No example

json

application/json

Create a new application module

POST

/api/v1/application-module

Create a new application module with the provided data

Create a new application module › Request Body

moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false
schoolIdnumber · required
School ID
Example: 1

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

Create a new application module › Responses

ApplicationModule created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

POST /api/v1/application-module

curl --request POST \
  --url /api/v1/application-module \
  --header 'Content-Type: application/json' \
  --data '
{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}

json

Example Responses

No example

json

application/json

Get application module by ID

GET

/api/v1/application-module/{id}

Retrieve a specific application module by its ID

Get application module by ID › path Parameters

idnumber · min: 1 · required
Id

Get application module by ID › Responses

ApplicationModule detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

GET /api/v1/application-module/{id}

curl --request GET \
  --url /api/v1/application-module/:id

shell

Show example in

Example Responses

No example

json

application/json

Update an application module

PUT

/api/v1/application-module/{id}

Update an existing application module by its ID

Update an application module › path Parameters

idnumber · min: 1 · required
Id

Update an application module › Request Body

moduleTypestring · enum
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring
Module name
Example: Task Management
descriptionstring
Module description
Example: Module for managing tasks and assignments
isEnabledboolean
Whether the module is enabled for this school
Example: true
isRequiredboolean
Whether the module is required (cannot be disabled)
Example: false
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]
schoolIdnumber
School ID
Example: 1

Update an application module › Responses

ApplicationModule updated

No data returned

PUT /api/v1/application-module/{id}

curl --request PUT \
  --url /api/v1/application-module/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}

json

Example Responses

No example

plain

Delete an application module

DELETE

/api/v1/application-module/{id}

Delete an application module by its ID

Delete an application module › path Parameters

idnumber · min: 1 · required
Id

Delete an application module › Responses

ApplicationModule deleted

No data returned

DELETE /api/v1/application-module/{id}

curl --request DELETE \
  --url /api/v1/application-module/:id

shell

Show example in

Example Responses

No example

plain

Get all modules for a school

GET

/api/v1/application-module/school/{schoolId}

Retrieve all application modules associated with a specific school

Get all modules for a school › path Parameters

schoolIdnumber · required

Get all modules for a school › Responses

School modules

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

GET /api/v1/application-module/school/{schoolId}

curl --request GET \
  --url /api/v1/application-module/school/:schoolId

shell

Show example in

Example Responses

No example

json

application/json

Get enabled modules for a school

GET

/api/v1/application-module/school/{schoolId}/enabled

Retrieve only the enabled application modules for a specific school

Get enabled modules for a school › path Parameters

schoolIdnumber · required

Get enabled modules for a school › Responses

Enabled school modules

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

GET /api/v1/application-module/school/{schoolId}/enabled

curl --request GET \
  --url /api/v1/application-module/school/:schoolId/enabled

shell

Show example in

Example Responses

No example

json

application/json

Check if module is enabled for a school

GET

/api/v1/application-module/school/{schoolId}/module/{moduleType}/status

Check if a specific module type is enabled for a school

Check if module is enabled for a school › path Parameters

schoolIdnumber · required
moduleTypestring · required

Check if module is enabled for a school › Responses

Module enabled status

boolean

GET /api/v1/application-module/school/{schoolId}/module/{moduleType}/status

curl --request GET \
  --url /api/v1/application-module/school/:schoolId/module/:moduleType/status

shell

Show example in

Example Responses

No example

json

application/json

Toggle module status for a school

PUT

/api/v1/application-module/school/{schoolId}/module/{moduleType}/toggle

Enable or disable a specific module type for a school

Toggle module status for a school › path Parameters

schoolIdnumber · required
moduleTypestring · required

Toggle module status for a school › Request Body

isEnabledboolean · required
Whether to enable or disable the module
Example: true

Toggle module status for a school › Responses

Module status updated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

PUT /api/v1/application-module/school/{schoolId}/module/{moduleType}/toggle

curl --request PUT \
  --url /api/v1/application-module/school/:schoolId/module/:moduleType/toggle \
  --header 'Content-Type: application/json' \
  --data '
{
  "isEnabled": true
}
'

shell

Show example in

Request Body Example

{
  "isEnabled": true
}

json

Example Responses

No example

json

application/json

Bulk toggle modules for a school

PUT

/api/v1/application-module/school/{schoolId}/bulk-toggle

Enable or disable multiple modules for a school at once

Bulk toggle modules for a school › path Parameters

schoolIdnumber · required

Bulk toggle modules for a school › Request Body

modulesarray[] · required
Array of module updates

Bulk toggle modules for a school › Responses

Modules updated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

PUT /api/v1/application-module/school/{schoolId}/bulk-toggle

curl --request PUT \
  --url /api/v1/application-module/school/:schoolId/bulk-toggle \
  --header 'Content-Type: application/json' \
  --data '
{
  "modules": [
    []
  ]
}
'

shell

Show example in

Request Body Example

{
  "modules": [
    []
  ]
}

json

Example Responses

No example

json

application/json

Address Family

Brein API

Application Module

Get all application modules with pagination

GET

/api/v1/application-module

Retrieve a paginated list of application modules based on query parameters

Get all application modules with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
schoolIdnumber
Filter by school ID
moduleTypestring · enum
Filter by module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
isEnabledboolean
Filter by enabled status

Get all application modules 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)

GET /api/v1/application-module

curl --request GET \
  --url /api/v1/application-module

shell

Show example in

Example Responses

No example

json

application/json

Create a new application module

POST

/api/v1/application-module

Create a new application module with the provided data

Create a new application module › Request Body

moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false
schoolIdnumber · required
School ID
Example: 1

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

Create a new application module › Responses

ApplicationModule created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

POST /api/v1/application-module

curl --request POST \
  --url /api/v1/application-module \
  --header 'Content-Type: application/json' \
  --data '
{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}

json

Example Responses

No example

json

application/json

Get application module by ID

GET

/api/v1/application-module/{id}

Retrieve a specific application module by its ID

Get application module by ID › path Parameters

idnumber · min: 1 · required
Id

Get application module by ID › Responses

ApplicationModule detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

GET /api/v1/application-module/{id}

curl --request GET \
  --url /api/v1/application-module/:id

shell

Show example in

Example Responses

No example

json

application/json

Update an application module

PUT

/api/v1/application-module/{id}

Update an existing application module by its ID

Update an application module › path Parameters

idnumber · min: 1 · required
Id

Update an application module › Request Body

moduleTypestring · enum
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring
Module name
Example: Task Management
descriptionstring
Module description
Example: Module for managing tasks and assignments
isEnabledboolean
Whether the module is enabled for this school
Example: true
isRequiredboolean
Whether the module is required (cannot be disabled)
Example: false
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]
schoolIdnumber
School ID
Example: 1

Update an application module › Responses

ApplicationModule updated

No data returned

PUT /api/v1/application-module/{id}

curl --request PUT \
  --url /api/v1/application-module/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "moduleType": "TASK",
  "name": "Task Management",
  "description": "Module for managing tasks and assignments",
  "isEnabled": true,
  "isRequired": false,
  "dependencies": [
    "string"
  ],
  "schoolId": 1
}

json

Example Responses

No example

plain

Delete an application module

DELETE

/api/v1/application-module/{id}

Delete an application module by its ID

Delete an application module › path Parameters

idnumber · min: 1 · required
Id

Delete an application module › Responses

ApplicationModule deleted

No data returned

DELETE /api/v1/application-module/{id}

curl --request DELETE \
  --url /api/v1/application-module/:id

shell

Show example in

Example Responses

No example

plain

Get all modules for a school

GET

/api/v1/application-module/school/{schoolId}

Retrieve all application modules associated with a specific school

Get all modules for a school › path Parameters

schoolIdnumber · required

Get all modules for a school › Responses

School modules

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

GET /api/v1/application-module/school/{schoolId}

curl --request GET \
  --url /api/v1/application-module/school/:schoolId

shell

Show example in

Example Responses

No example

json

application/json

Get enabled modules for a school

GET

/api/v1/application-module/school/{schoolId}/enabled

Retrieve only the enabled application modules for a specific school

Get enabled modules for a school › path Parameters

schoolIdnumber · required

Get enabled modules for a school › Responses

Enabled school modules

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

GET /api/v1/application-module/school/{schoolId}/enabled

curl --request GET \
  --url /api/v1/application-module/school/:schoolId/enabled

shell

Show example in

Example Responses

No example

json

application/json

Check if module is enabled for a school

GET

/api/v1/application-module/school/{schoolId}/module/{moduleType}/status

Check if a specific module type is enabled for a school

Check if module is enabled for a school › path Parameters

schoolIdnumber · required
moduleTypestring · required

Check if module is enabled for a school › Responses

Module enabled status

boolean

GET /api/v1/application-module/school/{schoolId}/module/{moduleType}/status

curl --request GET \
  --url /api/v1/application-module/school/:schoolId/module/:moduleType/status

shell

Show example in

Example Responses

No example

json

application/json

Toggle module status for a school

PUT

/api/v1/application-module/school/{schoolId}/module/{moduleType}/toggle

Enable or disable a specific module type for a school

Toggle module status for a school › path Parameters

schoolIdnumber · required
moduleTypestring · required

Toggle module status for a school › Request Body

isEnabledboolean · required
Whether to enable or disable the module
Example: true

Toggle module status for a school › Responses

Module status updated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

PUT /api/v1/application-module/school/{schoolId}/module/{moduleType}/toggle

curl --request PUT \
  --url /api/v1/application-module/school/:schoolId/module/:moduleType/toggle \
  --header 'Content-Type: application/json' \
  --data '
{
  "isEnabled": true
}
'

shell

Show example in

Request Body Example

{
  "isEnabled": true
}

json

Example Responses

No example

json

application/json

Bulk toggle modules for a school

PUT

/api/v1/application-module/school/{schoolId}/bulk-toggle

Enable or disable multiple modules for a school at once

Bulk toggle modules for a school › path Parameters

schoolIdnumber · required

Bulk toggle modules for a school › Request Body

modulesarray[] · required
Array of module updates

Bulk toggle modules for a school › Responses

Modules updated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
moduleTypestring · enum · required
Module type
Enum values:
TASK
CALENDAR
SESSIONS
EXIT_PERMISSION
LOST_ARTICLE
POST
TRANSPORT
Example: TASK
namestring · required
Module name
Example: Task Management
isEnabledboolean · required
Whether the module is enabled for this school
Example: true
isRequiredboolean · required
Whether the module is required (cannot be disabled)
Example: false

descriptionstring
Module description
Example: Module for managing tasks and assignments
dependenciesstring[]
Dependencies required for this module
Example: ["TASK","CALENDAR"]

PUT /api/v1/application-module/school/{schoolId}/bulk-toggle

curl --request PUT \
  --url /api/v1/application-module/school/:schoolId/bulk-toggle \
  --header 'Content-Type: application/json' \
  --data '
{
  "modules": [
    []
  ]
}
'

shell

Show example in

Request Body Example

{
  "modules": [
    []
  ]
}

json

Example Responses

No example

json

application/json

Address Family