List school immunizations for an academic year

GET

https://ssuccessv2.com/app/api/v1/immunizations/:yearId

Returns every student in the active school for the requested academic year, including family contacts, crawl status, class/grade, and calculated immunization details.

Authentication

AuthorizationBearer

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

Path parameters

yearIdintegerRequired

Academic year ID.

Response

Student immunization list returned; this endpoint is not paginated.

statusstring

messagestring

datalist of maps from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

1	{
2	"status": "success",
3	"message": "",
4	"data": [
5	{
6	"id": 1042,
7	"firstname": "Maya",
8	"lastname": "Cohen",
9	"dob": {},
10	"immunizations": {
11	"DTP": {
12	"status": "Completed",
13	"status_id": 3
14	}
15	}
16	}
17	]
18	}