Create a calendar schedule

POST

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

POST

/app/api/v2/report-cards/calendar-schedules

$ curl -X POST https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "academic_year_id": 12,
>   "name": "Regular timetable",
>   "days": [
>     {
>       "week_in_cycle": 1,
>       "day_of_week": 1,
>       "is_open": true,
>       "start_time": "08:00",
>       "end_time": "15:00"
>     }
>   ],
>   "cycle_length_weeks": 1,
>   "active": true,
>   "audiences": [
>     {
>       "audience_type": "grade",
>       "audience_id": 7
>     }
>   ],
>   "overrides": []
> }'

1 {
2   "status": "success",
3   "message": "Created successfully.",
4   "data": {
5     "id": 31,
6     "academic_year_id": 12,
7     "name": "Regular timetable",
8     "active": true,
9     "days": [
10       {}
11     ],
12     "audiences": [
13       {}
14     ],
15     "override_rules": [
16       {}
17     ],
18     "overrides": [
19       {}
20     ]
21   }
22 }

Creates a school calendar schedule with cycle days, optional audiences, date overrides, reporting-term linkage, and active-state configuration.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

academic_year_idintegerRequired

namestringRequired<=255 characters

dayslist of objectsRequired

report_card_term_idinteger or nullOptional

effective_start_datedate or nullOptional

effective_end_datedate or nullOptional

cycle_length_weeksintegerOptional1-52

activebooleanOptional

audienceslist of objectsOptional

overrideslist of objectsOptional

Response

The calendar schedule was created and returned as a resource.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error