Get students with due immunizations | SchoolSet

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

{
  "status": "success",
  "message": "Immunization shots due for student ID 12345 retrieved successfully.",
  "data": {
    "id": 12345,
    "status": "due",
    "immunization_name": "MMR (Measles, Mumps, Rubella)",
    "next_due_date": "2024-09-15",
    "shots": [
      {
        "id": 987,
        "immunization_student_id": 12345,
        "shot_number": 2,
        "due": "2024-09-15",
        "date_given": null,
        "doctor_name": null,
        "from_crawl": false,
        "created_by_user_id": 42,
        "updated_by_user_id": 42,
        "appointment": [
          {
            "id": 555,
            "immunization_student_shot_id": 987,
            "date": "2024-09-10T10:00:00Z",
            "created_by_user_id": 42,
            "updated_by_user_id": 42,
            "attachments": [
              {
                "id": 1001,
                "file_hash": "a1b2c3d4e5f67890",
                "file_name": "immunization_record.pdf",
                "file_original_name": "MMR_vaccine_record.pdf",
                "file_mime_type": "application/pdf",
                "caption": "Vaccination record document",
                "url": "https://app.schoolset.io/files/1001",
                "file_size": 24576,
                "created_by": "nurse.jones",
                "created_at": "2024-04-01T08:30:00Z",
                "updated_at": "2024-04-01T08:30:00Z",
                "related_to": "appointment",
                "model_name": "ImmunizationAppointment",
                "model_id": 555
              }
            ]
          }
        ],
        "attachments": [
          {
            "id": 2002,
            "file_hash": "f1e2d3c4b5a69788",
            "file_name": "consent_form.jpg",
            "file_original_name": "parent_consent_form.jpg",
            "file_mime_type": "image/jpeg",
            "caption": "Signed consent form",
            "url": "https://app.schoolset.io/files/2002",
            "file_size": 102400,
            "created_by": "admin.smith",
            "created_at": "2024-03-20T09:15:00Z",
            "updated_at": "2024-03-20T09:15:00Z",
            "related_to": "immunization_shot",
            "model_name": "ImmunizationShot",
            "model_id": 987
          }
        ]
      }
    ]
  }
}

Returns immunization shots that are due for the specified student and still not recorded as given.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/immunization/due/{id}.

statusenum

Allowed values:

messagestring

dataobject