Generate course schedule slots

POST

https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/:scheduleId/generate-slots

POST

/app/api/v2/report-cards/calendar-schedules/:scheduleId/generate-slots

$ curl -X POST https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/generate-slots \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "academic_year_id": 12,
>   "mode": "preview",
>   "existing_slots_mode": "keep",
>   "course_ids": [
>     44
>   ],
>   "grade_ids": [
>     7
>   ],
>   "class_ids": []
> }'

1 {
2   "status": "success",
3   "message": "Updated successfully.",
4   "data": {
5     "mode": "preview",
6     "existing_slots_mode": "keep",
7     "created_slots": [
8       {}
9     ],
10     "skipped_items": [
11       {}
12     ],
13     "conflicts": [
14       {}
15     ],
16     "summary": {
17       "created_count": 4,
18       "skipped_count": 1,
19       "conflict_count": 0,
20       "replaced_existing_slot_count": 0
21     }
22   }
23 }

Previews or applies course slots against a calendar schedule using existing-slot behavior and optional course, grade, and class filters.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

scheduleIdintegerRequired>=1

Calendar schedule identifier.

Request

This endpoint expects an object.

academic_year_idintegerRequired

modeenumRequired

Allowed values:

existing_slots_modeenumRequired

Allowed values:

course_idslist of integersOptional

grade_idslist of integersOptional

class_idslist of integersOptional

Response

Slot generation results with created slots, skipped items, conflicts, and replacement counts were returned.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error