Run immunization crawler job | SchoolSet

Starts a crawler job for the selected academic year and returns submitted student/job metadata.

AuthorizationBearer

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

This endpoint expects an object.

academic_year_idinteger or nullOptional

academic year ID identifier.

year_idinteger or nullOptional

year ID identifier.

crawler_namestring or nullOptional

crawler name display value.

Successful POST response for /api/v1/immunization/crawler/run.

statusenum

Allowed values:

messagestring

dataobject

1	curl -X POST https://app.schoolset.io/app/api/v1/immunization/crawler/run \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{}'

1	{
2	"status": "success",
3	"message": "Crawler job completed successfully.",
4	"data": {
5	"students_submitted": 245,
6	"academic_year_id": 2023,
7	"job_id": "job_9f8b7c6d5e4a3b2c1d0e"
8	}
9	}