Brein API

Route Student

Get all route-student associations with pagination

GET

/api/v1/route-student

Retrieve a paginated list of route-student associations based on query parameters

Get all route-student associations with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
routeIdnumber
Route ID
keystring
Filter by multiples key
activeSuspensionsboolean
Filter for active suspensions (students currently suspended)
pastSuspensionsboolean
Filter for past suspensions (students with completed suspensions)

Get all route-student associations with pagination › Responses

No data returned

Create a route-student association

POST

/api/v1/route-student

Create a new association between a route and a student

Create a route-student association › Request Body

routeIdnumber · required
studentIdnumber · required

Create a route-student association › Responses

RouteStudent created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/route-student

curl --request POST \
  --url /api/v1/route-student \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeId": 0,
  "studentId": 0
}
'

shell

Show example in

Request Body Example

{
  "routeId": 0,
  "studentId": 0
}

json

Example Responses

No example

json

application/json

Download route students as Excel file

GET

/api/v1/route-student/route/{routeId}/download

Generate and download an Excel file with students for a specific route

Download route students as Excel file › path Parameters

routeIdnumber · required

Download route students as Excel file › Responses

File download URL generated successfully

fileNamestring
Name of the generated file
urlstring
Signed S3 URL to download the file
expiresInnumber
URL expiration time in seconds

GET /api/v1/route-student/route/{routeId}/download

curl --request GET \
  --url /api/v1/route-student/route/:routeId/download

shell

Show example in

Example Responses

No example

json

application/json

Get route students by route ID

GET

/api/v1/route-student/route/{routeId}

Retrieve a paginated list of students associated with a specific route

Get route students by route ID › path Parameters

routeIdnumber · required

Get route students by route ID › query Parameters

pagenumber
Current page
pageSizenumber
Page size
routeIdnumber
Route ID
keystring
Filter by multiples key
activeSuspensionsboolean
Filter for active suspensions (students currently suspended)
pastSuspensionsboolean
Filter for past suspensions (students with completed suspensions)

Get route students by route ID › 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/route-student/route/{routeId}

curl --request GET \
  --url /api/v1/route-student/route/:routeId

shell

Show example in

Example Responses

No example

json

application/json

Get route-student association by ID

GET

/api/v1/route-student/{id}

Retrieve a specific route-student association by its ID with all relations

Get route-student association by ID › path Parameters

idnumber · min: 1 · required
Id

Get route-student association by ID › Responses

RouteStudent detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GET /api/v1/route-student/{id}

curl --request GET \
  --url /api/v1/route-student/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a route-student association

PUT

/api/v1/route-student/{id}

Update an existing route-student association by its ID

Update a route-student association › path Parameters

idnumber · min: 1 · required
Id

Update a route-student association › Request Body

routeIdnumber
studentIdnumber

Update a route-student association › Responses

RouteStudent updated

No data returned

PUT /api/v1/route-student/{id}

curl --request PUT \
  --url /api/v1/route-student/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeId": 0,
  "studentId": 0
}
'

shell

Show example in

Request Body Example

{
  "routeId": 0,
  "studentId": 0
}

json

Example Responses

No example

plain

Delete a route-student association

DELETE

/api/v1/route-student/{id}

Delete a route-student association by its ID

Delete a route-student association › path Parameters

idnumber · min: 1 · required
Id

Delete a route-student association › Responses

RouteStudent deleted

No data returned

DELETE /api/v1/route-student/{id}

curl --request DELETE \
  --url /api/v1/route-student/:id

shell

Show example in

Example Responses

No example

plain

Upload file with route students

POST

/api/v1/route-student/bulk

Upload file with route students › Request Body

filestring

Upload file with route students › Responses

No data returned

POST /api/v1/route-student/bulk

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

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Suspend a route-student association

PUT

/api/v1/route-student/{id}/suspend

Suspend a route-student association temporarily

Suspend a route-student association › path Parameters

idnumber · min: 1 · required
Id

Suspend a route-student association › Request Body

Suspend a route-student association › Responses

RouteStudent suspended

No data returned

PUT /api/v1/route-student/{id}/suspend

curl --request PUT \
  --url /api/v1/route-student/:id/suspend \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

plain

Cancel suspension of route-student association

PATCH

/api/v1/route-student/{id}/suspend/cancel

Cancel the suspension of a previously suspended route-student association

Cancel suspension of route-student association › path Parameters

idnumber · min: 1 · required
Id

Cancel suspension of route-student association › Responses

RouteStudent suspend canceled

No data returned

PATCH /api/v1/route-student/{id}/suspend/cancel

curl --request PATCH \
  --url /api/v1/route-student/:id/suspend/cancel

shell

Show example in

Example Responses

No example

plain

Delete multiple RouteStudents by IDs

POST

/api/v1/route-student/delete/bulk

Delete multiple route-student associations by their IDs

Delete multiple RouteStudents by IDs › Request Body

idsnumber[] · required
Array of RouteStudent IDs to delete
Example: [1,2,3,4,5]

Delete multiple RouteStudents by IDs › Responses

RouteStudents deleted successfully

No data returned

POST /api/v1/route-student/delete/bulk

curl --request POST \
  --url /api/v1/route-student/delete/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "ids": [
    0
  ]
}

json

Example Responses

No example

plain

Student Route

Brein API

Route Student

Get all route-student associations with pagination

GET

/api/v1/route-student

Retrieve a paginated list of route-student associations based on query parameters

Get all route-student associations with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
routeIdnumber
Route ID
keystring
Filter by multiples key
activeSuspensionsboolean
Filter for active suspensions (students currently suspended)
pastSuspensionsboolean
Filter for past suspensions (students with completed suspensions)

Get all route-student associations with pagination › Responses

No data returned

Create a route-student association

POST

/api/v1/route-student

Create a new association between a route and a student

Create a route-student association › Request Body

routeIdnumber · required
studentIdnumber · required

Create a route-student association › Responses

RouteStudent created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

POST /api/v1/route-student

curl --request POST \
  --url /api/v1/route-student \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeId": 0,
  "studentId": 0
}
'

shell

Show example in

Request Body Example

{
  "routeId": 0,
  "studentId": 0
}

json

Example Responses

No example

json

application/json

Download route students as Excel file

GET

/api/v1/route-student/route/{routeId}/download

Generate and download an Excel file with students for a specific route

Download route students as Excel file › path Parameters

routeIdnumber · required

Download route students as Excel file › Responses

File download URL generated successfully

fileNamestring
Name of the generated file
urlstring
Signed S3 URL to download the file
expiresInnumber
URL expiration time in seconds

GET /api/v1/route-student/route/{routeId}/download

curl --request GET \
  --url /api/v1/route-student/route/:routeId/download

shell

Show example in

Example Responses

No example

json

application/json

Get route students by route ID

GET

/api/v1/route-student/route/{routeId}

Retrieve a paginated list of students associated with a specific route

Get route students by route ID › path Parameters

routeIdnumber · required

Get route students by route ID › query Parameters

pagenumber
Current page
pageSizenumber
Page size
routeIdnumber
Route ID
keystring
Filter by multiples key
activeSuspensionsboolean
Filter for active suspensions (students currently suspended)
pastSuspensionsboolean
Filter for past suspensions (students with completed suspensions)

Get route students by route ID › 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/route-student/route/{routeId}

curl --request GET \
  --url /api/v1/route-student/route/:routeId

shell

Show example in

Example Responses

No example

json

application/json

Get route-student association by ID

GET

/api/v1/route-student/{id}

Retrieve a specific route-student association by its ID with all relations

Get route-student association by ID › path Parameters

idnumber · min: 1 · required
Id

Get route-student association by ID › Responses

RouteStudent detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date

GET /api/v1/route-student/{id}

curl --request GET \
  --url /api/v1/route-student/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a route-student association

PUT

/api/v1/route-student/{id}

Update an existing route-student association by its ID

Update a route-student association › path Parameters

idnumber · min: 1 · required
Id

Update a route-student association › Request Body

routeIdnumber
studentIdnumber

Update a route-student association › Responses

RouteStudent updated

No data returned

PUT /api/v1/route-student/{id}

curl --request PUT \
  --url /api/v1/route-student/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeId": 0,
  "studentId": 0
}
'

shell

Show example in

Request Body Example

{
  "routeId": 0,
  "studentId": 0
}

json

Example Responses

No example

plain

Delete a route-student association

DELETE

/api/v1/route-student/{id}

Delete a route-student association by its ID

Delete a route-student association › path Parameters

idnumber · min: 1 · required
Id

Delete a route-student association › Responses

RouteStudent deleted

No data returned

DELETE /api/v1/route-student/{id}

curl --request DELETE \
  --url /api/v1/route-student/:id

shell

Show example in

Example Responses

No example

plain

Upload file with route students

POST

/api/v1/route-student/bulk

Upload file with route students › Request Body

filestring

Upload file with route students › Responses

No data returned

POST /api/v1/route-student/bulk

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

shell

Show example in

Request Body Example

{
  "file": "file"
}

json

Example Responses

No example

plain

Suspend a route-student association

PUT

/api/v1/route-student/{id}/suspend

Suspend a route-student association temporarily

Suspend a route-student association › path Parameters

idnumber · min: 1 · required
Id

Suspend a route-student association › Request Body

Suspend a route-student association › Responses

RouteStudent suspended

No data returned

PUT /api/v1/route-student/{id}/suspend

curl --request PUT \
  --url /api/v1/route-student/:id/suspend \
  --header 'Content-Type: application/json' \
  --data '{}'

shell

Show example in

Request Body Example

{}

json

Example Responses

No example

plain

Cancel suspension of route-student association

PATCH

/api/v1/route-student/{id}/suspend/cancel

Cancel the suspension of a previously suspended route-student association

Cancel suspension of route-student association › path Parameters

idnumber · min: 1 · required
Id

Cancel suspension of route-student association › Responses

RouteStudent suspend canceled

No data returned

PATCH /api/v1/route-student/{id}/suspend/cancel

curl --request PATCH \
  --url /api/v1/route-student/:id/suspend/cancel

shell

Show example in

Example Responses

No example

plain

Delete multiple RouteStudents by IDs

POST

/api/v1/route-student/delete/bulk

Delete multiple route-student associations by their IDs

Delete multiple RouteStudents by IDs › Request Body

idsnumber[] · required
Array of RouteStudent IDs to delete
Example: [1,2,3,4,5]

Delete multiple RouteStudents by IDs › Responses

RouteStudents deleted successfully

No data returned

POST /api/v1/route-student/delete/bulk

curl --request POST \
  --url /api/v1/route-student/delete/bulk \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    0
  ]
}
'

shell

Show example in

Request Body Example

{
  "ids": [
    0
  ]
}

json

Example Responses

No example

plain

Student Route