Brein API

Family

Get all families with pagination

GET

/api/v1/family

Retrieve a paginated list of families based on query parameters

Get all families with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all families 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 family

POST

/api/v1/family

Create a new family with the provided data

Create a new family › Request Body

familyNumberstring · required
Family number
Example: 2000
parentsobject[] · required
Parents
studentsobject[] · required
Students

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

Create a new family › Responses

Family created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

POST /api/v1/family

curl --request POST \
  --url /api/v1/family \
  --header 'Content-Type: application/json' \
  --data '
{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf",
  "parents": [
    {
      "lastName": "Doe",
      "secondLastName": "Doe",
      "relationShip": "Mother",
      "name": "Jane",
      "genre": "FEMALE",
      "phone": "phone",
      "birthDate": "2024-08-25T15:00:00Z",
      "address": "Jane",
      "email": "email"
    }
  ],
  "students": [
    {
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ]
}
'

shell

Show example in

Request Body Example

{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf",
  "parents": [
    {
      "lastName": "Doe",
      "secondLastName": "Doe",
      "relationShip": "Mother",
      "name": "Jane",
      "genre": "FEMALE",
      "phone": "phone",
      "birthDate": "2024-08-25T15:00:00Z",
      "address": "Jane",
      "email": "email"
    }
  ],
  "students": [
    {
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ]
}

json

Example Responses

No example

json

application/json

Get family members by family number

GET

/api/v1/family/{familyNumber}/members

Retrieve all members of a family by its family number

Get family members by family number › path Parameters

familyNumberstring · required

Get family members by family number › Responses

Family members

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{familyNumber}/members

curl --request GET \
  --url /api/v1/family/:familyNumber/members

shell

Show example in

Example Responses

No example

json

application/json

Check if family exists by family number

GET

/api/v1/family/{familyNumber}/check

Check if a family exists by its family number

Check if family exists by family number › path Parameters

familyNumberstring · required

Check if family exists by family number › Responses

Family members

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{familyNumber}/check

curl --request GET \
  --url /api/v1/family/:familyNumber/check

shell

Show example in

Example Responses

No example

json

application/json

Check parent limit for a family

GET

/api/v1/family/{id}/check-parent-limit

Check if a family has reached the maximum number of parents allowed

Check parent limit for a family › path Parameters

idnumber · min: 1 · required
Id

Check parent limit for a family › Responses

Family members

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{id}/check-parent-limit

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

shell

Show example in

Example Responses

No example

json

application/json

Get family by ID

GET

/api/v1/family/{id}

Retrieve a specific family by its ID

Get family by ID › path Parameters

idnumber · min: 1 · required
Id

Get family by ID › Responses

Family detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a family

PUT

/api/v1/family/{id}

Update an existing family by its ID

Update a family › path Parameters

idnumber · min: 1 · required
Id

Update a family › Request Body

familyNumberstring
Family number
Example: 2000
routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

Update a family › Responses

Family updated

No data returned

PUT /api/v1/family/{id}

curl --request PUT \
  --url /api/v1/family/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf"
}
'

shell

Show example in

Request Body Example

{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf"
}

json

Example Responses

No example

plain

Delete a family

DELETE

/api/v1/family/{id}

Delete a family by its ID

Delete a family › path Parameters

idnumber · min: 1 · required
Id

Delete a family › Responses

Family deleted

No data returned

Upload file with families

POST

/api/v1/family/bulk

Upload file with families › Request Body

filestring

Upload file with families › Responses

No data returned

POST /api/v1/family/bulk

curl --request POST \
  --url /api/v1/family/bulk \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file"
}'

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Validate that a list of family IDs exist

POST

/api/v1/family/validate-family-numbers

Validate that a list of family IDs exist › Request Body

familyNumbersstring[] · required
Array of family numbers to validate
Example: ["1","2","3","4","5"]

Validate that a list of family IDs exist › Responses

All family IDs exist

nonExistingFamilyNumbersstring[] · required
Array of non-existing family numbers
Example: ["2","4"]

existingFamilyNumbersobject
Mapping of existing family numbers to their IDs
Example: {"1":123,"3":125,"5":127}

POST /api/v1/family/validate-family-numbers

curl --request POST \
  --url /api/v1/family/validate-family-numbers \
  --header 'Content-Type: application/json' \
  --data '
{
  "familyNumbers": [
    "string"
  ]
}
'

shell

Show example in

Request Body Example

{
  "familyNumbers": [
    "string"
  ]
}

json

Example Responses

No example

json

application/json

Application Module DeviceToken

Brein API

Family

Get all families with pagination

GET

/api/v1/family

Retrieve a paginated list of families based on query parameters

Get all families with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all families 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 family

POST

/api/v1/family

Create a new family with the provided data

Create a new family › Request Body

familyNumberstring · required
Family number
Example: 2000
parentsobject[] · required
Parents
studentsobject[] · required
Students

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

Create a new family › Responses

Family created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

POST /api/v1/family

curl --request POST \
  --url /api/v1/family \
  --header 'Content-Type: application/json' \
  --data '
{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf",
  "parents": [
    {
      "lastName": "Doe",
      "secondLastName": "Doe",
      "relationShip": "Mother",
      "name": "Jane",
      "genre": "FEMALE",
      "phone": "phone",
      "birthDate": "2024-08-25T15:00:00Z",
      "address": "Jane",
      "email": "email"
    }
  ],
  "students": [
    {
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ]
}
'

shell

Show example in

Request Body Example

{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf",
  "parents": [
    {
      "lastName": "Doe",
      "secondLastName": "Doe",
      "relationShip": "Mother",
      "name": "Jane",
      "genre": "FEMALE",
      "phone": "phone",
      "birthDate": "2024-08-25T15:00:00Z",
      "address": "Jane",
      "email": "email"
    }
  ],
  "students": [
    {
      "bloodType": "O+",
      "birthDate": "2024-08-25T15:00:00Z",
      "grade": "1",
      "level": "Primary",
      "enrollment": "12345",
      "firstName": "John",
      "lastName": "Doe",
      "secondLastName": "Smith",
      "genre": "FEMALE"
    }
  ]
}

json

Example Responses

No example

json

application/json

Get family members by family number

GET

/api/v1/family/{familyNumber}/members

Retrieve all members of a family by its family number

Get family members by family number › path Parameters

familyNumberstring · required

Get family members by family number › Responses

Family members

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{familyNumber}/members

curl --request GET \
  --url /api/v1/family/:familyNumber/members

shell

Show example in

Example Responses

No example

json

application/json

Check if family exists by family number

GET

/api/v1/family/{familyNumber}/check

Check if a family exists by its family number

Check if family exists by family number › path Parameters

familyNumberstring · required

Check if family exists by family number › Responses

Family members

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{familyNumber}/check

curl --request GET \
  --url /api/v1/family/:familyNumber/check

shell

Show example in

Example Responses

No example

json

application/json

Check parent limit for a family

GET

/api/v1/family/{id}/check-parent-limit

Check if a family has reached the maximum number of parents allowed

Check parent limit for a family › path Parameters

idnumber · min: 1 · required
Id

Check parent limit for a family › Responses

Family members

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{id}/check-parent-limit

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

shell

Show example in

Example Responses

No example

json

application/json

Get family by ID

GET

/api/v1/family/{id}

Retrieve a specific family by its ID

Get family by ID › path Parameters

idnumber · min: 1 · required
Id

Get family by ID › Responses

Family detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
familyNumberstring · required
Family number
Example: 2000

routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

GET /api/v1/family/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a family

PUT

/api/v1/family/{id}

Update an existing family by its ID

Update a family › path Parameters

idnumber · min: 1 · required
Id

Update a family › Request Body

familyNumberstring
Family number
Example: 2000
routeDocumentSlugstring
Slug for the uploaded route document PDF
Example: family-2000-route-document-20250127.pdf

Update a family › Responses

Family updated

No data returned

PUT /api/v1/family/{id}

curl --request PUT \
  --url /api/v1/family/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf"
}
'

shell

Show example in

Request Body Example

{
  "familyNumber": "2000",
  "routeDocumentSlug": "family-2000-route-document-20250127.pdf"
}

json

Example Responses

No example

plain

Delete a family

DELETE

/api/v1/family/{id}

Delete a family by its ID

Delete a family › path Parameters

idnumber · min: 1 · required
Id

Delete a family › Responses

Family deleted

No data returned

Upload file with families

POST

/api/v1/family/bulk

Upload file with families › Request Body

filestring

Upload file with families › Responses

No data returned

POST /api/v1/family/bulk

curl --request POST \
  --url /api/v1/family/bulk \
  --header 'Content-Type: application/json' \
  --data '{
  "file": "file"
}'

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Validate that a list of family IDs exist

POST

/api/v1/family/validate-family-numbers

Validate that a list of family IDs exist › Request Body

familyNumbersstring[] · required
Array of family numbers to validate
Example: ["1","2","3","4","5"]

Validate that a list of family IDs exist › Responses

All family IDs exist

nonExistingFamilyNumbersstring[] · required
Array of non-existing family numbers
Example: ["2","4"]

existingFamilyNumbersobject
Mapping of existing family numbers to their IDs
Example: {"1":123,"3":125,"5":127}

POST /api/v1/family/validate-family-numbers

curl --request POST \
  --url /api/v1/family/validate-family-numbers \
  --header 'Content-Type: application/json' \
  --data '
{
  "familyNumbers": [
    "string"
  ]
}
'

shell

Show example in

Request Body Example

{
  "familyNumbers": [
    "string"
  ]
}

json

Example Responses

No example

json

application/json

Application Module DeviceToken