Brein API

TrustedPeople

Get all trusted people with pagination

GET

/api/v1/trusted-people

Retrieve a paginated list of trusted people based on query parameters

Get all trusted people with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
statusstring · enum
Filter by status
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
REVOKED
familyIdnumber
Filter by family ID
searchstring
Search by last names
withRevokedboolean
Include revoked (deleted) trusted people
keystring
Search by family number or family name

Get all trusted people with pagination › Responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

GET /api/v1/trusted-people

curl --request GET \
  --url /api/v1/trusted-people

shell

Show example in

Example Responses

No example

json

application/json

Create a new trusted person

POST

/api/v1/trusted-people

Create a new trusted person. Only parents can create trusted people

Create a new trusted person › Request Body

namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
familyIdnumber · required
Family ID

Create a new trusted person › Responses

TrustedPeople created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

POST /api/v1/trusted-people

curl --request POST \
  --url /api/v1/trusted-people \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}

json

Example Responses

No example

json

application/json

Get trusted person by ID

GET

/api/v1/trusted-people/{id}

Retrieve detailed information about a specific trusted person by its ID

Get trusted person by ID › path Parameters

idnumber · min: 1 · required
Id

Get trusted person by ID › Responses

TrustedPeople detail

idnumber · required
Trusted person basic information
studentsobject[] · required
Student information
requestedByobject · required
Creator information (parent)
historyobject[] · required
Action history

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR

GET /api/v1/trusted-people/{id}

curl --request GET \
  --url /api/v1/trusted-people/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a trusted person

PUT

/api/v1/trusted-people/{id}

Update an existing trusted person by its ID

Update a trusted person › path Parameters

idnumber · min: 1 · required
Id

Update a trusted person › Request Body

namestring
Name or names of the trusted person
paternalLastNamestring
Paternal last name of the trusted person
maternalLastNamestring
Maternal last name of the trusted person
phonestring
Phone number of the trusted person
genrestring · enum
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring
S3 image slug for the official identification
familyIdnumber
Family ID

Update a trusted person › Responses

TrustedPeople updated

No data returned

PUT /api/v1/trusted-people/{id}

curl --request PUT \
  --url /api/v1/trusted-people/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}

json

Example Responses

No example

plain

Delete a trusted person

DELETE

/api/v1/trusted-people/{id}

Delete a trusted person by its ID

Delete a trusted person › path Parameters

idnumber · min: 1 · required
Id

Delete a trusted person › Responses

TrustedPeople deleted

No data returned

DELETE /api/v1/trusted-people/{id}

curl --request DELETE \
  --url /api/v1/trusted-people/:id

shell

Show example in

Example Responses

No example

plain

Update trusted person status

PATCH

/api/v1/trusted-people/{id}/status

Update the status of a trusted person (approve/reject)

Update trusted person status › path Parameters

idnumber · min: 1 · required
Id

Update trusted person status › Request Body

statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED

Update trusted person status › Responses

TrustedPeople updated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

PATCH /api/v1/trusted-people/{id}/status

curl --request PATCH \
  --url /api/v1/trusted-people/:id/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PENDING"
}
'

shell

Show example in

Request Body Example

{
  "status": "PENDING"
}

json

Example Responses

No example

json

application/json

Exit Permission TrustedAddress

Brein API

TrustedPeople

Get all trusted people with pagination

GET

/api/v1/trusted-people

Retrieve a paginated list of trusted people based on query parameters

Get all trusted people with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
statusstring · enum
Filter by status
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
REVOKED
familyIdnumber
Filter by family ID
searchstring
Search by last names
withRevokedboolean
Include revoked (deleted) trusted people
keystring
Search by family number or family name

Get all trusted people with pagination › Responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

GET /api/v1/trusted-people

curl --request GET \
  --url /api/v1/trusted-people

shell

Show example in

Example Responses

No example

json

application/json

Create a new trusted person

POST

/api/v1/trusted-people

Create a new trusted person. Only parents can create trusted people

Create a new trusted person › Request Body

namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
familyIdnumber · required
Family ID

Create a new trusted person › Responses

TrustedPeople created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

POST /api/v1/trusted-people

curl --request POST \
  --url /api/v1/trusted-people \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}

json

Example Responses

No example

json

application/json

Get trusted person by ID

GET

/api/v1/trusted-people/{id}

Retrieve detailed information about a specific trusted person by its ID

Get trusted person by ID › path Parameters

idnumber · min: 1 · required
Id

Get trusted person by ID › Responses

TrustedPeople detail

idnumber · required
Trusted person basic information
studentsobject[] · required
Student information
requestedByobject · required
Creator information (parent)
historyobject[] · required
Action history

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR

GET /api/v1/trusted-people/{id}

curl --request GET \
  --url /api/v1/trusted-people/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a trusted person

PUT

/api/v1/trusted-people/{id}

Update an existing trusted person by its ID

Update a trusted person › path Parameters

idnumber · min: 1 · required
Id

Update a trusted person › Request Body

namestring
Name or names of the trusted person
paternalLastNamestring
Paternal last name of the trusted person
maternalLastNamestring
Maternal last name of the trusted person
phonestring
Phone number of the trusted person
genrestring · enum
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring
S3 image slug for the official identification
familyIdnumber
Family ID

Update a trusted person › Responses

TrustedPeople updated

No data returned

PUT /api/v1/trusted-people/{id}

curl --request PUT \
  --url /api/v1/trusted-people/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}
'

shell

Show example in

Request Body Example

{
  "name": "name",
  "paternalLastName": "paternalLastName",
  "maternalLastName": "maternalLastName",
  "phone": "phone",
  "genre": "MALE",
  "relationship": "Grandparent",
  "slugImage": "slugImage",
  "familyId": 0
}

json

Example Responses

No example

plain

Delete a trusted person

DELETE

/api/v1/trusted-people/{id}

Delete a trusted person by its ID

Delete a trusted person › path Parameters

idnumber · min: 1 · required
Id

Delete a trusted person › Responses

TrustedPeople deleted

No data returned

DELETE /api/v1/trusted-people/{id}

curl --request DELETE \
  --url /api/v1/trusted-people/:id

shell

Show example in

Example Responses

No example

plain

Update trusted person status

PATCH

/api/v1/trusted-people/{id}/status

Update the status of a trusted person (approve/reject)

Update trusted person status › path Parameters

idnumber · min: 1 · required
Id

Update trusted person status › Request Body

statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED

Update trusted person status › Responses

TrustedPeople updated

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
namestring · required
Name or names of the trusted person
paternalLastNamestring · required
Paternal last name of the trusted person
maternalLastNamestring · required
Maternal last name of the trusted person
phonestring · required
Phone number of the trusted person
genrestring · enum · required
Gender of the trusted person
Enum values:
MALE
FEMALE
OTHER
relationshipstring · enum · required
Relationship of the trusted person with the student
Enum values:
Grandparent
Aunt/Uncle
Friend
Collaborator
slugImagestring · required
S3 image slug for the official identification
statusstring · enum · required
Status of the trusted person
Enum values:
PENDING
APPROVED
REJECTED
REVOKED
requestedByobject · required
Parent who requested the trusted person
requestedAtstring · date-time · required
Date and time when the trusted person was requested
reviewedAtstring · date-time · required
Date and time when the trusted person was reviewed
revokedAtstring · date-time · required
Date and time when the trusted person was revoked

reviewedByobject
User who reviewed the trusted person
reviewedByRolestring · enum
Role of the user who reviewed the trusted person
Enum values:
PARENT
DELEGATE
DIRECTOR
TEACHER
ADMINISTRATIVE_COMMUNICATION
ADMINISTRATIVE_LOST_AND_FOUND
ADMINISTRATIVE_PERMISSIONS_MANAGER
SCHOOL_ADMINISTRATOR
revokedByobject
User who revoked the trusted person

PATCH /api/v1/trusted-people/{id}/status

curl --request PATCH \
  --url /api/v1/trusted-people/:id/status \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "PENDING"
}
'

shell

Show example in

Request Body Example

{
  "status": "PENDING"
}

json

Example Responses

No example

json

application/json

Exit Permission TrustedAddress