Brein API

Transport

Get all transports for school

GET

/api/v1/transport

Retrieve all transports for the current school

Get all transports for school › 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 transport

POST

/api/v1/transport

Create a new transport for the current school

Create a new transport › Request Body

routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

Create a new transport › Responses

Transport created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

POST /api/v1/transport

curl --request POST \
  --url /api/v1/transport \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}
'

shell

Show example in

Request Body Example

{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}

json

Example Responses

No example

json

application/json

Get transport by ID

GET

/api/v1/transport/{id}

Retrieve a specific transport by its ID

Get transport by ID › path Parameters

idnumber · min: 1 · required
Id

Get transport by ID › Responses

Transport detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

GET /api/v1/transport/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a transport

PUT

/api/v1/transport/{id}

Update an existing transport by its ID

Update a transport › path Parameters

idnumber · min: 1 · required
Id

Update a transport › Request Body

routeNumbernumber
Route number
unitNumbernumber
Unit number
unitCapacitynumber
Maximum capacity of the unit
licencePlatestring
Licence plate of the unit

Update a transport › Responses

Transport updated

No data returned

PUT /api/v1/transport/{id}

curl --request PUT \
  --url /api/v1/transport/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}
'

shell

Show example in

Request Body Example

{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}

json

Example Responses

No example

plain

Delete a transport

DELETE

/api/v1/transport/{id}

Delete a transport by its ID

Delete a transport › path Parameters

idnumber · min: 1 · required
Id

Delete a transport › Responses

Transport deleted

No data returned

School Holiday Cycle Health

Brein API

Transport

Get all transports for school

GET

/api/v1/transport

Retrieve all transports for the current school

Get all transports for school › 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 transport

POST

/api/v1/transport

Create a new transport for the current school

Create a new transport › Request Body

routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

Create a new transport › Responses

Transport created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

POST /api/v1/transport

curl --request POST \
  --url /api/v1/transport \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}
'

shell

Show example in

Request Body Example

{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}

json

Example Responses

No example

json

application/json

Get transport by ID

GET

/api/v1/transport/{id}

Retrieve a specific transport by its ID

Get transport by ID › path Parameters

idnumber · min: 1 · required
Id

Get transport by ID › Responses

Transport detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
routeNumbernumber · required
Route number
unitCapacitynumber · required
Maximum capacity of the unit

unitNumbernumber
Unit number
licencePlatestring
Licence plate of the unit

GET /api/v1/transport/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a transport

PUT

/api/v1/transport/{id}

Update an existing transport by its ID

Update a transport › path Parameters

idnumber · min: 1 · required
Id

Update a transport › Request Body

routeNumbernumber
Route number
unitNumbernumber
Unit number
unitCapacitynumber
Maximum capacity of the unit
licencePlatestring
Licence plate of the unit

Update a transport › Responses

Transport updated

No data returned

PUT /api/v1/transport/{id}

curl --request PUT \
  --url /api/v1/transport/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}
'

shell

Show example in

Request Body Example

{
  "routeNumber": 0,
  "unitNumber": 0,
  "unitCapacity": 0,
  "licencePlate": "licencePlate"
}

json

Example Responses

No example

plain

Delete a transport

DELETE

/api/v1/transport/{id}

Delete a transport by its ID

Delete a transport › path Parameters

idnumber · min: 1 · required
Id

Delete a transport › Responses

Transport deleted

No data returned

School Holiday Cycle Health