Update Bussing Run Setup | SchoolSet

curl -X PATCH https://app.schoolset.io/app/api/v1/bussing/run-setup/update/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Morning Route A",
  "start_time": "07:15:00",
  "end_time": "08:30:00",
  "time_type_id": 2,
  "stop_type_id": 3,
  "amount_of_routes": 5
}'

{
  "status": "success",
  "message": "Bus run setup updated successfully.",
  "data": {
    "id": 42,
    "name": "Morning Route A",
    "start_time": "07:15:00",
    "end_time": "08:30:00",
    "time_type": {},
    "stop_type": {},
    "amount_of_routes": 5,
    "days_of_week": [
      "Monday",
      "Wednesday",
      "Friday"
    ],
    "school_grades": [
      {
        "id": 3,
        "name": "Grade 5"
      },
      {
        "id": 4,
        "name": "Grade 6"
      }
    ],
    "school_classes": [
      {
        "id": 12,
        "name": "5A"
      },
      {
        "id": 15,
        "name": "6B"
      }
    ],
    "created_by": "admin_user",
    "created_at": "2024-04-10T09:00:00Z",
    "updated_at": "2024-06-01T14:45:00Z"
  }
}

Updates the selected bus run setup record.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

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 PATCH response for /api/v1/bussing/run-setup/update/{id}.

statusenum

Allowed values:

messagestring

dataobject