List immunizations for a specific academic year | SchoolSet

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

{
  "status": "success",
  "message": "Immunization summaries retrieved successfully for academic year 2023-2024.",
  "data": [
    {
      "id": 1024,
      "student": {
        "firstname": "Ethan",
        "firstname_hebrew": "איתן",
        "lastname": "Goldberg",
        "lastname_hebrew": "גולדברג",
        "full_name": "Ethan Goldberg",
        "dob": "2010-05-14",
        "dob_hebrew": "תשס\"א אייר י\"ד",
        "grade": {
          "year": 5,
          "name": "5th Grade"
        },
        "no_results": false
      },
      "parents": [
        {
          "name": "Rachel Goldberg",
          "phone": "+1-555-123-4567",
          "email": "rachel.goldberg@example.com"
        }
      ],
      "immunizations": {
        "MMR": {
          "date_administered": "2016-06-20",
          "status": "complete",
          "notes": "Second dose administered on schedule."
        },
        "DTaP": {
          "date_administered": "2015-11-10",
          "status": "complete",
          "notes": "All doses up to date."
        },
        "Varicella": {
          "date_administered": "2016-01-15",
          "status": "complete",
          "notes": "No adverse reactions."
        }
      }
    }
  ]
}

Returns immunization summaries for all students scoped to the provided academic year ID.

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/immunizations/{yearId}.

statusenum

Allowed values:

messagestring

datalist of objects