Brein API

TrustedAddress

Get all trusted addresses with pagination

GET

/api/v1/trusted-address

Retrieve a paginated list of trusted addresses based on query parameters

Get all trusted addresses with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
statusstring · enum
Filter by status
Enum values:
PENDING
APPROVED
DELETED
familyIdnumber
Filter by family ID
keystring
Search by family number or family name

Get all trusted addresses 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/trusted-address

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new trusted address

POST

/api/v1/trusted-address

Create a new trusted address. Only parents can create trusted addresses

Create a new trusted address › Request Body

aliasstring · required
Address alias
familyIdnumber · required
Family ID
addressobject · required
Address data

alternativeAddressobject
Alternative address data
routeIdnumber
Route ID

Create a new trusted address › Responses

TrustedAddress created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
aliasstring · required
Address alias
addressobject · required
Address reference
statusstring · required
Status
requestedByobject · required
Parent who requested the trusted address

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

POST /api/v1/trusted-address

curl --request POST \
  --url /api/v1/trusted-address \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}
'

shell

Show example in

Request Body Example

{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}

json

Example Responses

No example

json

application/json

Get trusted address by ID

GET

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

Retrieve a specific trusted address by its ID

Get trusted address by ID › path Parameters

idnumber · min: 1 · required
Id

Get trusted address by ID › Responses

TrustedAddress detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
aliasstring · required
Address alias
addressobject · required
Address reference
statusstring · required
Status
requestedByobject · required
Parent who requested the trusted address

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

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

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

shell

Show example in

Example Responses

No example

json

application/json

Update a trusted address

PUT

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

Update an existing trusted address by its ID

Update a trusted address › path Parameters

idnumber · min: 1 · required
Id

Update a trusted address › Request Body

aliasstring
Address alias
alternativeAddressobject
Alternative address data
familyIdnumber
Family ID
addressobject
Address data
routeIdnumber
Route ID

Update a trusted address › Responses

TrustedAddress updated

No data returned

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

curl --request PUT \
  --url /api/v1/trusted-address/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}
'

shell

Show example in

Request Body Example

{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}

json

Example Responses

No example

plain

Delete a trusted address

DELETE

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

Delete a trusted address by its ID

Delete a trusted address › path Parameters

idnumber · min: 1 · required
Id

Delete a trusted address › Responses

TrustedAddress deleted

No data returned

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

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

shell

Show example in

Example Responses

No example

plain

Update trusted address status

PATCH

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

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

Update trusted address status › path Parameters

idnumber · min: 1 · required
Id

Update trusted address status › Request Body

statusstring · enum · required
Enum values:
PENDING
APPROVED
DELETED

Update trusted address status › Responses

TrustedAddress status updated

No data returned

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

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

shell

Show example in

Request Body Example

{
  "status": "PENDING"
}

json

Example Responses

No example

plain

TrustedPeople Invitations

Brein API

TrustedAddress

Get all trusted addresses with pagination

GET

/api/v1/trusted-address

Retrieve a paginated list of trusted addresses based on query parameters

Get all trusted addresses with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
statusstring · enum
Filter by status
Enum values:
PENDING
APPROVED
DELETED
familyIdnumber
Filter by family ID
keystring
Search by family number or family name

Get all trusted addresses 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/trusted-address

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

shell

Show example in

Example Responses

No example

json

application/json

Create a new trusted address

POST

/api/v1/trusted-address

Create a new trusted address. Only parents can create trusted addresses

Create a new trusted address › Request Body

aliasstring · required
Address alias
familyIdnumber · required
Family ID
addressobject · required
Address data

alternativeAddressobject
Alternative address data
routeIdnumber
Route ID

Create a new trusted address › Responses

TrustedAddress created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
aliasstring · required
Address alias
addressobject · required
Address reference
statusstring · required
Status
requestedByobject · required
Parent who requested the trusted address

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

POST /api/v1/trusted-address

curl --request POST \
  --url /api/v1/trusted-address \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}
'

shell

Show example in

Request Body Example

{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}

json

Example Responses

No example

json

application/json

Get trusted address by ID

GET

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

Retrieve a specific trusted address by its ID

Get trusted address by ID › path Parameters

idnumber · min: 1 · required
Id

Get trusted address by ID › Responses

TrustedAddress detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
aliasstring · required
Address alias
addressobject · required
Address reference
statusstring · required
Status
requestedByobject · required
Parent who requested the trusted address

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

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

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

shell

Show example in

Example Responses

No example

json

application/json

Update a trusted address

PUT

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

Update an existing trusted address by its ID

Update a trusted address › path Parameters

idnumber · min: 1 · required
Id

Update a trusted address › Request Body

aliasstring
Address alias
alternativeAddressobject
Alternative address data
familyIdnumber
Family ID
addressobject
Address data
routeIdnumber
Route ID

Update a trusted address › Responses

TrustedAddress updated

No data returned

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

curl --request PUT \
  --url /api/v1/trusted-address/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}
'

shell

Show example in

Request Body Example

{
  "alias": "alias",
  "alternativeAddress": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "familyId": 0,
  "address": {
    "formattedAddress": "Main St",
    "zipCode": "10001",
    "city": "New York",
    "country": "USA",
    "placeId": "placeId",
    "latitude": 0,
    "longitude": 0
  },
  "routeId": 0
}

json

Example Responses

No example

plain

Delete a trusted address

DELETE

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

Delete a trusted address by its ID

Delete a trusted address › path Parameters

idnumber · min: 1 · required
Id

Delete a trusted address › Responses

TrustedAddress deleted

No data returned

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

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

shell

Show example in

Example Responses

No example

plain

Update trusted address status

PATCH

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

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

Update trusted address status › path Parameters

idnumber · min: 1 · required
Id

Update trusted address status › Request Body

statusstring · enum · required
Enum values:
PENDING
APPROVED
DELETED

Update trusted address status › Responses

TrustedAddress status updated

No data returned

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

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

shell

Show example in

Request Body Example

{
  "status": "PENDING"
}

json

Example Responses

No example

plain

TrustedPeople Invitations