Update a student's attendance plan

PUT

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

PUT

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

$ curl -X PUT https://ssuccessv2.com/app/api/v1/attendance/student/student_id/plans/plan_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "attendance_marking_type_id": 3,
>   "start_date": {},
>   "end_date": {},
>   "attendance_track_id": 42,
>   "has_permission": true,
>   "note": "Family travel"
> }'

1 {
2   "status": "success",
3   "message": "Updated successfully.",
4   "data": {
5     "id": 8801,
6     "student_id": 12045,
7     "attendance_marking_type_id": 3,
8     "marking_type": {
9       "id": 3,
10       "name": "Excused Absence",
11       "category": "absence",
12       "color": "#2563EB",
13       "icon": "calendar",
14       "ask_for_permission": true,
15       "allow_note": true,
16       "require_note": false
17     },
18     "attendance_track_id": 42,
19     "track_name": "Morning Attendance",
20     "start_date": {},
21     "end_date": {},
22     "has_permission": true,
23     "note": "Family travel"
24   }
25 }

Updates the selected student’s date-bounded attendance plan. The selected active marking type must be valid for the selected track, date ranges may not overlap, and marking types can require permission or a note.

Authentication

AuthorizationBearer

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

Path parameters

student_idstringRequired

plan_idstringRequired

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

Attendance plan updated

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error