neis_plus library

NEIS+ reads Korean school data from the NEIS open API (open.neis.go.kr): schools, meals, timetables, calendars, classes, departments, classrooms, and academies.

NeisClient has a method for every service NEIS publishes, and NeisService names them all for NeisClient.call.

Classes

NeisAcademy
A 학원 or 교습소, from acaInsTiInfo.
NeisClass
One class of a school, from classInfo.
NeisClassroom
A classroom a timetable can be taught in, from tiClrminfo.
NeisClient
Reads school data from the NEIS open API (open.neis.go.kr).
NeisDish
One dish of a school meal, with the allergens NEIS marks on it.
NeisLesson
One period of a class timetable.
NeisMajor
A department of a school, from schoolMajorinfo.
NeisMeal
A school meal served on one day.
NeisOffice
An office of education, the ATPT_OFCDC_SC_CODE every service is keyed by.
NeisRow
One row of a NEIS response, for services this package has no model for.
NeisScheduleEvent
One entry of a school calendar.
NeisSchool
A school registered with NEIS.
NeisService
One service of the NEIS open API.
NeisTrack
A track of a school, from schulAflcoinfo.

Enums

NeisSchoolKind
School level, from SCHUL_KND_SC_NM. It decides which timetable service a school uses.

Constants

neisAllergens → const List<String>
The 19 allergens NEIS numbers in meal listings, in order.

Functions

formatNeisDate(DateTime date) → String
Formats a date the way NEIS parameters expect.
neisErrorCodeFor(String? resultCode) → String
Maps a NEIS result code to a stable NeisException.code.
neisIsNoData(String? resultCode) → bool
Whether a result code means the query matched nothing, which this package reports as an empty list instead of an error.
neisIsOk(String? resultCode) → bool
Whether a result code means the request succeeded.
parseNeisDate(String value) → DateTime?
Parses a NEIS yyyyMMdd date, or returns null.
parseNeisDishes(String menu) → List<NeisDish>
Splits a DDISH_NM menu into dishes and their allergen numbers.

Exceptions / Errors

NeisException
A failed call to the NEIS open API.