Brein API

Route

Get all routes with pagination

GET

/api/v1/route

Retrieve a paginated list of routes with student count based on query parameters

Get all routes with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
keystring
Search by monitor name or operator name

Get all routes 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 route

POST

/api/v1/route

Create a new route for the current school

Create a new route › Request Body

transportobject · required
Transport data

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number
scheduleIdnumber
Schedule ID

Create a new route › Responses

Route created

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

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number

POST /api/v1/route

curl --request POST \
  --url /api/v1/route \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}
'

shell

Show example in

Request Body Example

{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}

json

Example Responses

No example

json

application/json

Get route information for current parent

GET

/api/v1/route/me

Retrieve route information for the current parent user

Get route information for current parent › Responses

Route information for current parent user

monitorobject
Monitor information
transportAdminobject
Transport admin information
routeDocumentSlugstring
Route document slug

Get route by ID

GET

/api/v1/route/{id}

Retrieve a specific route by its ID with transport information

Get route by ID › path Parameters

idnumber · min: 1 · required
Id

Get route by ID › Responses

Route detail

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

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number

Update a route

PUT

/api/v1/route/{id}

Update an existing route by its ID

Update a route › path Parameters

idnumber · min: 1 · required
Id

Update a route › Request Body

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number
scheduleIdnumber
Schedule ID
transportobject
Transport data

Update a route › Responses

Route updated

No data returned

PUT /api/v1/route/{id}

curl --request PUT \
  --url /api/v1/route/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}
'

shell

Show example in

Request Body Example

{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}

json

Example Responses

No example

plain

Delete a route

DELETE

/api/v1/route/{id}

Delete a route by its ID

Delete a route › path Parameters

idnumber · min: 1 · required
Id

Delete a route › Responses

Route deleted

No data returned

Route Student School Schedule

Brein API

Route

Get all routes with pagination

GET

/api/v1/route

Retrieve a paginated list of routes with student count based on query parameters

Get all routes with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size
keystring
Search by monitor name or operator name

Get all routes 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 route

POST

/api/v1/route

Create a new route for the current school

Create a new route › Request Body

transportobject · required
Transport data

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number
scheduleIdnumber
Schedule ID

Create a new route › Responses

Route created

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

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number

POST /api/v1/route

curl --request POST \
  --url /api/v1/route \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}
'

shell

Show example in

Request Body Example

{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}

json

Example Responses

No example

json

application/json

Get route information for current parent

GET

/api/v1/route/me

Retrieve route information for the current parent user

Get route information for current parent › Responses

Route information for current parent user

monitorobject
Monitor information
transportAdminobject
Transport admin information
routeDocumentSlugstring
Route document slug

Get route by ID

GET

/api/v1/route/{id}

Retrieve a specific route by its ID with transport information

Get route by ID › path Parameters

idnumber · min: 1 · required
Id

Get route by ID › Responses

Route detail

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

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number

Update a route

PUT

/api/v1/route/{id}

Update an existing route by its ID

Update a route › path Parameters

idnumber · min: 1 · required
Id

Update a route › Request Body

mapUrlstring
Map URL
operatorFirstNamestring
First name of the operator
operatorLastNamestring
Last name of the operator
monitorFirstNamestring
First name of the monitor
monitorLastNamestring
Last name of the monitor
phonestring
Phone number
scheduleIdnumber
Schedule ID
transportobject
Transport data

Update a route › Responses

Route updated

No data returned

PUT /api/v1/route/{id}

curl --request PUT \
  --url /api/v1/route/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}
'

shell

Show example in

Request Body Example

{
  "mapUrl": "mapUrl",
  "operatorFirstName": "operatorFirstName",
  "operatorLastName": "operatorLastName",
  "monitorFirstName": "monitorFirstName",
  "monitorLastName": "monitorLastName",
  "phone": "phone",
  "scheduleId": 0,
  "transport": {
    "routeNumber": 0,
    "unitNumber": 0,
    "unitCapacity": 0,
    "licencePlate": "licencePlate"
  }
}

json

Example Responses

No example

plain

Delete a route

DELETE

/api/v1/route/{id}

Delete a route by its ID

Delete a route › path Parameters

idnumber · min: 1 · required
Id

Delete a route › Responses

Route deleted

No data returned

Route Student School Schedule