SchoolSet APICustom Document Templates

Generate a PDF from a custom template

Generates one or more documents for selected school entities. A single PDF returns a temporary file descriptor; ZIP output or more than ten entities is queued and returns a background-job descriptor.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired>=1
Custom document template ID.

Request

This endpoint expects an object.
entity_typestringRequired
entity_idintegerOptional>=1
entity_idslist of integersOptional
node_idslist of integersOptional
class_idslist of integersOptional
excluded_node_idslist of integersOptional
excluded_class_idslist of integersOptional
excluded_entity_idslist of integersOptional
output_typeenumOptional
Allowed values:
academic_year_idintegerOptional>=1

Response

PDF descriptor or queued-generation descriptor.

statusstring
messagestring
datamap from strings to any

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
502
Bad Gateway Error