Create Report Card Files

POST

https://app.schoolset.io/app/api/v1/report-card/files

POST

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

1 curl -X POST https://app.schoolset.io/app/api/v1/report-card/files \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "report_card_batch_id": 42,
6   "student_ids": [
7     1024,
8     2048,
9     4096
10   ]
11 }'

200Successful

1 {
2   "status": "success",
3   "message": "Report card files generated successfully.",
4   "data": [
5     {
6       "id": 1001,
7       "student_id": 1024,
8       "url": "https://app.schoolset.io/files/report_cards/1024_semester1.pdf",
9       "filename": "1024_semester1_report_card.pdf",
10       "file_manager_id": 501
11     },
12     {
13       "id": 1002,
14       "student_id": 2048,
15       "url": "https://app.schoolset.io/files/report_cards/2048_semester1.pdf",
16       "filename": "2048_semester1_report_card.pdf",
17       "file_manager_id": 502
18     },
19     {
20       "id": 1003,
21       "student_id": 4096,
22       "url": "https://app.schoolset.io/files/report_cards/4096_semester1.pdf",
23       "filename": "4096_semester1_report_card.pdf",
24       "file_manager_id": 503
25     }
26   ]
27 }

Generates or returns report card files for the selected batch and student set.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.

report_card_batch_idintegerRequired

report card batch ID identifier.

student_idslist of integersRequired

student IDs list.

Response

Successful POST response for /api/v1/report-card/files.

statusenum

Allowed values:

messagestring

datalist of objects