Brein API

School Administrator

Get all school administrators with pagination

GET

/api/v1/school-administrator

Retrieve a paginated list of school administrators based on query parameters

Get all school administrators with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter
lastNamestring
Last name filter
secondLastNamestring
Second last name filter

Get all school administrators 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/school-administrator

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new school administrator

POST

/api/v1/school-administrator

Create a new school administrator with the provided data

Create a new school administrator › Request Body

lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane
schoolIdnumber · min: 1 · required
School id
Example: 1

Create a new school administrator › Responses

School Administrator created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane

POST /api/v1/school-administrator

curl --request POST \
  --url /api/v1/school-administrator \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane",
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane",
  "schoolId": 1
}

json

Example Responses

No example

json

application/json

Get school administrator by ID

GET

/api/v1/school-administrator/{id}

Retrieve a specific school administrator by its ID

Get school administrator by ID › path Parameters

idnumber · min: 1 · required
Id

Get school administrator by ID › Responses

School Administrator detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane

GET /api/v1/school-administrator/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school administrator

PUT

/api/v1/school-administrator/{id}

Update an existing school administrator by its ID

Update a school administrator › path Parameters

idnumber · min: 1 · required
Id

Update a school administrator › Request Body

lastNamestring
Last name of the administrator
Example: Doe
secondLastNamestring
Second last name of the administrator
Example: Smith
firstNamestring
First name of the administrator
Example: Jane

Update a school administrator › Responses

School Administrator updated

No data returned

PUT /api/v1/school-administrator/{id}

curl --request PUT \
  --url /api/v1/school-administrator/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane"
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane"
}

json

Example Responses

No example

plain

Delete a school administrator

DELETE

/api/v1/school-administrator/{id}

Delete a school administrator by its ID

Delete a school administrator › path Parameters

idnumber · min: 1 · required
Id

Delete a school administrator › Responses

School Administrator deleted

No data returned

DELETE /api/v1/school-administrator/{id}

curl --request DELETE \
  --url /api/v1/school-administrator/:id

shell

Show example in

Example Responses

No example

plain

School Address

Brein API

School Administrator

Get all school administrators with pagination

GET

/api/v1/school-administrator

Retrieve a paginated list of school administrators based on query parameters

Get all school administrators with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
namestring
Name filter
lastNamestring
Last name filter
secondLastNamestring
Second last name filter

Get all school administrators 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/school-administrator

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new school administrator

POST

/api/v1/school-administrator

Create a new school administrator with the provided data

Create a new school administrator › Request Body

lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane
schoolIdnumber · min: 1 · required
School id
Example: 1

Create a new school administrator › Responses

School Administrator created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane

POST /api/v1/school-administrator

curl --request POST \
  --url /api/v1/school-administrator \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane",
  "schoolId": 1
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane",
  "schoolId": 1
}

json

Example Responses

No example

json

application/json

Get school administrator by ID

GET

/api/v1/school-administrator/{id}

Retrieve a specific school administrator by its ID

Get school administrator by ID › path Parameters

idnumber · min: 1 · required
Id

Get school administrator by ID › Responses

School Administrator detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
lastNamestring · required
Last name of the administrator
Example: Doe
secondLastNamestring · required
Second last name of the administrator
Example: Smith
firstNamestring · required
First name of the administrator
Example: Jane

GET /api/v1/school-administrator/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a school administrator

PUT

/api/v1/school-administrator/{id}

Update an existing school administrator by its ID

Update a school administrator › path Parameters

idnumber · min: 1 · required
Id

Update a school administrator › Request Body

lastNamestring
Last name of the administrator
Example: Doe
secondLastNamestring
Second last name of the administrator
Example: Smith
firstNamestring
First name of the administrator
Example: Jane

Update a school administrator › Responses

School Administrator updated

No data returned

PUT /api/v1/school-administrator/{id}

curl --request PUT \
  --url /api/v1/school-administrator/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane"
}
'

shell

Show example in

Request Body Example

{
  "lastName": "Doe",
  "secondLastName": "Smith",
  "firstName": "Jane"
}

json

Example Responses

No example

plain

Delete a school administrator

DELETE

/api/v1/school-administrator/{id}

Delete a school administrator by its ID

Delete a school administrator › path Parameters

idnumber · min: 1 · required
Id

Delete a school administrator › Responses

School Administrator deleted

No data returned

DELETE /api/v1/school-administrator/{id}

curl --request DELETE \
  --url /api/v1/school-administrator/:id

shell

Show example in

Example Responses

No example

plain

School Address