Immunizations
extends BaseEndpoint
in package
Table of Contents
Properties
- $url : string
Methods
- getByUserId() : array<string|int, StudentImmunizationRead>
- Returns a collection of medical immunizations for the specified ```user\_id```.
Properties
$url
protected
string
$url
= "https://api.sky.blackbaud.com/school/v1/medical/users/{user_id}/immunizations"
Endpoint URL pattern
Methods
getByUserId()
Returns a collection of medical immunizations for the specified ```user\_id```.
public
getByUserId(array{user_id: int, include_: string} $params) : array<string|int, StudentImmunizationRead>
Requires at least one of the following roles in the Education Management system:
- Nurse
Parameters
- $params : array{user_id: int, include_: string}
-
An associative array
- user_id: Format - int32. The ID of the student
- include_: Show all required immunizations or just those completed or missing. Allowed values: all, completed, missing.
Tags
Return values
array<string|int, StudentImmunizationRead> —Success