Create a student's attendance plan

POST

https://ssuccessv2.com/app/api/v1/attendance/student/:student_id/plans

POST

/app/api/v1/attendance/student/:student_id/plans

$ curl -X POST https://ssuccessv2.com/app/api/v1/attendance/student/1001/plans \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "attendance_marking_type_id": 2,
>   "start_date": {},
>   "end_date": {},
>   "attendance_track_id": null,
>   "has_permission": true,
>   "note": "Family vacation"
> }'

1 {
2   "status": "success",
3   "message": "Created successfully.",
4   "data": {
5     "id": 501,
6     "student_id": 1001,
7     "attendance_marking_type_id": 2,
8     "marking_type": {
9       "id": 2,
10       "name": "Excused",
11       "category": "absence",
12       "color": "#f59e0b",
13       "icon": "calendar",
14       "ask_for_permission": true,
15       "allow_note": true,
16       "require_note": false
17     },
18     "attendance_track_id": null,
19     "track_name": null,
20     "start_date": "2023-01-15",
21     "end_date": "2023-01-15",
22     "has_permission": true,
23     "note": "Family vacation"
24   }
25 }

Creates a date-range plan after validating the active marking type, track compatibility, required details, and overlap rules.

Authentication

AuthorizationBearer

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

Path parameters

student_idintegerRequired

Request

This endpoint expects an object.

attendance_marking_type_idintegerRequired

start_datedateRequired

end_datedateRequired

attendance_track_idinteger or nullOptional

has_permissionboolean or nullOptional

notestring or nullOptional

Response

Plan created.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error