Create a calendar override rule | SchoolSet

Creates a recurring calendar closure or opening rule, materializes its generated date overrides, and returns the saved rule resource.

AuthorizationBearer

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

scheduleIdintegerRequired>=1

Calendar schedule identifier.

This endpoint expects an object.

namestringRequired<=255 characters

recurrence_typestringRequired

is_openbooleanRequired

start_timestring or nullOptional

end_timestring or nullOptional

monthinteger or nullOptional1-12

dayinteger or nullOptional1-31

weekdayinteger or nullOptional1-7

week_of_monthinteger or nullOptional1-5

range_start_monthinteger or nullOptional1-12

range_start_dayinteger or nullOptional1-31

range_end_monthinteger or nullOptional1-12

range_end_dayinteger or nullOptional1-31

holiday_keystring or nullOptional<=255 characters

day_offsetinteger or nullOptional-366-366

activebooleanOptional

The override rule was created and returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/report-cards/calendar-schedules/31/override-rules \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"name": "Labor Day",
>	"recurrence_type": "fixed_date",
>	"is_open": false,
>	"month": 9,
>	"day": 7,
>	"active": true
>	}'

1	{
2	"status": "success",
3	"message": "Created successfully.",
4	"data": {
5	"id": 8,
6	"calendar_schedule_id": 31,
7	"name": "Labor Day",
8	"recurrence_type": "fixed_date",
9	"is_open": false,
10	"active": true
11	}
12	}