Brein API

Parent

Get all parents with pagination

GET

/api/v1/parent

Retrieve a paginated list of parents based on query parameters

Get all parents with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
keystring
Key filter
levelsstring[]
Level filter

Get all parents 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 parent

POST

/api/v1/parent

Create a new parent with the provided data

Create a new parent › Request Body

lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z
emailstring · required
Parent email
Default: email@user.com

familyIdnumber
Family ID

Create a new parent › Responses

Parent created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

POST /api/v1/parent

curl --request POST \
  --url /api/v1/parent \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z",
  "familyId": 0,
  "email": "email"
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z",
  "familyId": 0,
  "email": "email"
}

json

Example Responses

No example

json

application/json

Get parent by ID

GET

/api/v1/parent/{id}

Retrieve a specific parent by its ID

Get parent by ID › path Parameters

idnumber · min: 1 · required
Id

Get parent by ID › Responses

Parent detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

GET /api/v1/parent/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a parent

PUT

/api/v1/parent/{id}

Update an existing parent by its ID

Update a parent › path Parameters

idnumber · min: 1 · required
Id

Update a parent › Request Body

lastNamestring
Last name of the parent
Example: Doe
secondLastNamestring
Second last name of the parent
Example: Smith
relationShipstring
Relation ship of the parent with student
Example: Mother
namestring
First name of the parent
Example: Jane
genrestring
Gender of the parent
Example: FEMALE
phonestring
Phone
birthDatestring · date-time
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

Update a parent › Responses

Parent updated

No data returned

PUT /api/v1/parent/{id}

curl --request PUT \
  --url /api/v1/parent/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z"
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z"
}

json

Example Responses

No example

plain

Delete a parent

DELETE

/api/v1/parent/{id}

Delete a parent by its ID

Delete a parent › path Parameters

idnumber · min: 1 · required
Id

Delete a parent › Responses

Parent deleted

No data returned

Role User Notification

Brein API

Parent

Get all parents with pagination

GET

/api/v1/parent

Retrieve a paginated list of parents based on query parameters

Get all parents with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
keystring
Key filter
levelsstring[]
Level filter

Get all parents 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 parent

POST

/api/v1/parent

Create a new parent with the provided data

Create a new parent › Request Body

lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z
emailstring · required
Parent email
Default: email@user.com

familyIdnumber
Family ID

Create a new parent › Responses

Parent created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

POST /api/v1/parent

curl --request POST \
  --url /api/v1/parent \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z",
  "familyId": 0,
  "email": "email"
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z",
  "familyId": 0,
  "email": "email"
}

json

Example Responses

No example

json

application/json

Get parent by ID

GET

/api/v1/parent/{id}

Retrieve a specific parent by its ID

Get parent by ID › path Parameters

idnumber · min: 1 · required
Id

Get parent by ID › Responses

Parent detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the parent
Example: Doe
secondLastNamestring · required
Second last name of the parent
Example: Smith
relationShipstring · required
Relation ship of the parent with student
Example: Mother
namestring · required
First name of the parent
Example: Jane
genrestring · required
Gender of the parent
Example: FEMALE
phonestring · required
Phone
birthDatestring · date-time · required
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

GET /api/v1/parent/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a parent

PUT

/api/v1/parent/{id}

Update an existing parent by its ID

Update a parent › path Parameters

idnumber · min: 1 · required
Id

Update a parent › Request Body

lastNamestring
Last name of the parent
Example: Doe
secondLastNamestring
Second last name of the parent
Example: Smith
relationShipstring
Relation ship of the parent with student
Example: Mother
namestring
First name of the parent
Example: Jane
genrestring
Gender of the parent
Example: FEMALE
phonestring
Phone
birthDatestring · date-time
Birth date of the parent
Example: 1980-02-01T12:30:00.000Z

Update a parent › Responses

Parent updated

No data returned

PUT /api/v1/parent/{id}

curl --request PUT \
  --url /api/v1/parent/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z"
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "relationShip": "Mother",
  "name": "Jane",
  "genre": "FEMALE",
  "phone": "phone",
  "birthDate": "2024-08-25T15:00:00Z"
}

json

Example Responses

No example

plain

Delete a parent

DELETE

/api/v1/parent/{id}

Delete a parent by its ID

Delete a parent › path Parameters

idnumber · min: 1 · required
Id

Delete a parent › Responses

Parent deleted

No data returned

Role User Notification