Create Bussing Run Setup | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/bussing/run-setup/create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "academic_year_id": 2024,
  "name": "Morning Bus Run",
  "start_time": "07:15:00",
  "end_time": "08:30:00",
  "time_type_id": 2,
  "stop_type_id": 3,
  "amount_of_routes": 12
}'

{
  "status": "success",
  "message": "Bus run setup created successfully.",
  "data": {
    "id": 101,
    "name": "Morning Bus Run",
    "start_time": "07:15:00",
    "end_time": "08:30:00",
    "time_type": {},
    "stop_type": {},
    "amount_of_routes": 12,
    "days_of_week": [
      "Monday",
      "Wednesday",
      "Friday"
    ],
    "school_grades": [
      {
        "id": 5,
        "name": "Grade 5"
      },
      {
        "id": 6,
        "name": "Grade 6"
      }
    ],
    "school_classes": [
      {
        "id": 12,
        "name": "5A"
      },
      {
        "id": 13,
        "name": "6B"
      }
    ],
    "created_by": "admin_user",
    "created_at": "2024-06-01T09:00:00Z",
    "updated_at": "2024-06-01T09:00:00Z"
  }
}

Creates bus run setup data from submitted details.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.

academic_year_iddoubleRequired

academic year ID identifier.

namestringRequired

name display value.

start_timestringRequired

Must be a valid date in the format H:i:s.

end_timestringRequired

Must be a valid date in the format H:i:s.

time_type_iddoubleRequired

time type ID type value.

stop_type_iddoubleRequired

stop type ID type value.

amount_of_routesdoubleRequired

amount of routes numeric value.

class_idsobject or nullOptional

class IDs list.

grade_idsobject or nullOptional

grade IDs list.

days_of_weeklist of enumsOptional

days of week list.

Response

Successful POST response for /api/v1/bussing/run-setup/create.

statusenum

Allowed values:

messagestring

dataobject