Download or merge report-card PDFs

POST

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

Returns a single approved PDF as an attachment when one file matches; for multiple files it merges them and returns a temporary PDF URL in the success envelope. No matching files returns an error envelope.

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

One matching file is streamed as a PDF attachment; multiple files produce a temporary merged-file success payload.

statusstring

messagestring

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v1/report-card/files/merged \
>	-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	"url": "https://files.schoolset.test/tmp/report_card_bulk.pdf",
6	"file_name": "report_card_bulk.pdf",
7	"file_mime_type": "application/pdf"
8	}
9	}