List immunization compliance for a specific academic year

GET

https://app.schoolset.io/app/api/v1/immunization/compliance/:yearId

GET

/app/api/v1/immunization/compliance/:yearId

1 curl https://app.schoolset.io/app/api/v1/immunization/compliance/yearId \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Compliance gaps found for academic year 2023-2024.",
4   "data": [
5     {
6       "id": 1024,
7       "lastname": "Johnson",
8       "parents": [
9         {
10           "name": "Emily Johnson",
11           "contact": "emily.johnson@example.com",
12           "phone": "+1-555-123-4567"
13         },
14         {
15           "name": "Michael Johnson",
16           "contact": "michael.johnson@example.com",
17           "phone": "+1-555-987-6543"
18         }
19       ],
20       "immunization": [
21         {
22           "vaccine": "MMR",
23           "dueDate": "2024-05-15",
24           "status": "missing"
25         },
26         {
27           "vaccine": "DTaP",
28           "dueDate": "2024-06-01",
29           "status": "overdue"
30         }
31       ]
32     }
33   ]
34 }

Returns families with compliance gaps for the requested academic year.

Authentication

AuthorizationBearer

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

Path parameters

yearIdstringRequired

Response

Successful GET response for /api/v1/immunization/compliance/{yearId}.

statusenum

Allowed values:

messagestring

datalist of objects