Create a report-card ZIP download

POST

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

Archives approved report-card files for the selected batch and students, stores the temporary ZIP, and returns a private URL valid for 15 minutes.

AuthorizationBearer

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

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:

ZIP metadata and a temporary private download URL.

statusstring

messagestring

dataobject

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/report-card/files/zip \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"report_card_batch_id": 2026,
>	"student_ids": [
>	4812,
>	4813
>	],
>	"printed": false,
>	"email_sent": false,
>	"sort_by": "student",
>	"sort_direction": "asc"
>	}'

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"id": 91234,
6	"url": "https://files.schoolset.test/temp/abc123/report_cards.zip",
7	"file_name": "report_cards.zip",
8	"file_original_name": "report_cards.zip",
9	"file_mime_type": "application/zip"
10	}
11	}