List approved report-card files

POST

https://ssuccessv2.com/app/api/v1/report-card/files

POST

/app/api/v1/report-card/files

$ curl -X POST https://ssuccessv2.com/app/api/v1/report-card/files \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "report_card_batch_id": 42,
>   "student_ids": [
>     1007,
>     1008
>   ]
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 5501,
7       "student_id": 1007,
8       "student_name": "Maya Chen",
9       "grade_id": 11,
10       "grade_name": "Grade 5",
11       "class_id": 4,
12       "class_name": "5A",
13       "family_id": 88,
14       "family_name": "Chen Family",
15       "parents": [
16         {}
17       ],
18       "filename": "string",
19       "file_original_name": "string",
20       "file_mime_type": "string",
21       "file_hash": "string",
22       "file_size": 1,
23       "file_manager_id": 1,
24       "printed_at": "2024-01-15T09:30:00Z",
25       "email_sent_at": "2024-01-15T09:30:00Z"
26     }
27   ]
28 }

Returns approved report-card file metadata for the requested batch and students, optionally filtered by printed/email status and sorted by student, family, grade, or class.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

report_card_batch_idintegerRequired

student_idslist of integersRequired

printedboolean or nullOptional

email_sentboolean or nullOptional

sort_byenum or nullOptional

Allowed values:

sort_directionenum or nullOptional

Allowed values:

Response

Approved file metadata returned; data is an array.

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error