How it Works
URL Parameters
code - (string) This is the "orgcode" of the school district. It is an 8 digit integer.
format - ("json" or "html") This is the format you want the results to be in. It can be
"json" or "html"".
- "json": returns the raw JSON from the cach. It includes the years, demographics, and metadata.
- "html": returns an HTML table of values with the rows as years, and the columns as demographics.
It
also
includes the metadata from the cache.
year - (string) This sets a specific year to look at. It only applies to JSON format.
statistic - (string) This sets a specific statistic to look at ("Enrollment by
Race/Ethnicity",
"Enrollment
by Gender", "Selected Populations" or "Total"). It only applies to JSON format, if there is also a year
specified.
force-preserve - ("on" or "off") This forces the server to not fetch new data from the
DOE.
force-update - ("on" or "off") This forces the server to fetch new data from the DOE. If
both
force-preserve and force-update are "on", then the server will not update the
data
passcode - (string) This is a passkey that the server requires for a forced update, if the
passkey
is not
present or incorrect, force-update will be ignored.
JSON
├ 2022
├ 2021
├ 2020
├ ...
└ metadata
├ updated
├ status
├ code
├ name
├ non-op
└ [updated-from]
{year} - (object) This is the parent to all of the statistic objects, each of which has
a
hirearchy
of statistic → option → number or statistic → number
metadata - (object) This is the parent to all of the metadata
updated - (integer) This is the time (in milliseconds) that the current data was
fetched
status - (string) This is what the server did to get current data ("updated",
"forced-updated",
"created", "normal" or "forced-normal")
code - (string) 8 digit org code of the school district
name - (string) This is the name of the district
non-op - (boolean) Whether the distric is "non-operating"
updated-from - (integer) This is the time (in milliseconds) that the previous data was
from. It
only exists when the status is "updated" or "forced-updated".
├2022├2021├2020├ ... └metadata├updated├status├code├name├non-op└[updated-from]
{year} - (object) This is the parent to all of the statistic objects, each of which has
a
hirearchy
of statistic → option → number or statistic → numbermetadata - (object) This is the parent to all of the metadataupdated - (integer) This is the time (in milliseconds) that the current data was
fetchedstatus - (string) This is what the server did to get current data ("updated",
"forced-updated",
"created", "normal" or "forced-normal")code - (string) 8 digit org code of the school districtname - (string) This is the name of the districtnon-op - (boolean) Whether the distric is "non-operating"updated-from - (integer) This is the time (in milliseconds) that the previous data was
from. It
only exists when the status is "updated" or "forced-updated".