untis-node

Index

Classes

Interfaces

Type aliases

methods

types

types: 1 | 2 | 3 | 4 | 5

Functions

getAbsences

getAbsences(startDate: number, endDate: number): Promise<AbsenceResponse>

- Defined in lib/axios.ts:722
function that gets the absences

Parameters
- startDate: number
  
  the start date of the time period
- endDate: number
  
  the end date of the time period
Returns Promise<AbsenceResponse>

Promise of type AbsenceResponse

getAvailableSchoolyears

getAvailableSchoolyears(): Promise<SchoolyearResponse>

- Defined in lib/axios.ts:408
gets all available schoolyears

Returns Promise<SchoolyearResponse>

Promise of type SchoolyearResponse

getClassByID

getClassByID(klassen: ClassesResponse, id: number): Class | undefined

- Defined in lib/types/klassen.ts:16
Parameters
- klassen: ClassesResponse
- id: number
Returns Class | undefined

getClassRegisterEvents

getClassRegisterEvents(startDate: number, endDate: number): Promise<ClassRegEventResponse>

- Defined in lib/axios.ts:646
function for getting the class register events for a time period

Parameters
- startDate: number
  
  the start date for the time period
- endDate: number
  
  the end date for the time period
Returns Promise<ClassRegEventResponse>

Promise of type ClassRegEventResponse

getClasses

getClasses(): Promise<ClassesResponse>

- Defined in lib/axios.ts:168
gets the classes

Returns Promise<ClassesResponse>

Promise of type ClassesResponse

getCurrentSchoolyear

getCurrentSchoolyear(): Promise<SchoolyearResponse>

- Defined in lib/axios.ts:378
gets the current schoolyear

Returns Promise<SchoolyearResponse>

Promise of type [[SchoolYearResponse]]

getCustomClassRegEvents

getCustomClassRegEvents(startDate: number, endDate: number, _id: string, type: types, keyType: "id" | "name" | "externalkey"): Promise<ClassRegEventResponse>

- Defined in lib/axios.ts:820
function for getting class register events

Parameters
- startDate: number
  
  the start date of the time period
- endDate: number
  
  the end date of the time period
- _id: string
  
  the id for
- type: types
- keyType: "id" | "name" | "externalkey"
Returns Promise<ClassRegEventResponse>

Promise of type ClassRegEventResponse

getCustomizableTimetable

getCustomizableTimetable(_id: string, type: number, keyType: string | "id", startDate: number, endDate: number, onlyBaseTimetable: boolean | false, showBooking: boolean | false, showInfo: boolean | false, showSubstText: boolean | false, showLsText: boolean | false, showLsNumber: boolean | false, showStudentgroup: boolean | false, klasseFields?: string[], roomFields?: string[], subjectFields?: string[], teacherFields?: string[]): Promise<CustomTimetableResponse>

- Defined in lib/axios.ts:497
function for getting a custom timetable

Parameters
- _id: string
  
  an element id, either internal or external
- type: number
  
  type of element
- keyType: string | "id"
  
  keyType for the id
- startDate: number
  
  the start date for the time period
- endDate: number
  
  the end date for the time period
- onlyBaseTimetable: boolean | false
  
  boolean, returns only the base timetable if true (default: false)
- showBooking: boolean | false
  
  boolean, returns the booking info if true (default: false)
- showInfo: boolean | false
  
  boolean, returns the period's information if true (default: false)
- showSubstText: boolean | false
  
  boolean, returns the period's substitution text if true (default: false)
- showLsText: boolean | false
  
  boolean, returns the the text of the period's lessons if true (default: false)
- showLsNumber: boolean | false
  
  boolean, returns the number of the lesson if true (default: false)
- showStudentgroup: boolean | false
  
  boolean, returns the name(s) of the studentgroup(s) if true (default: false)
- Optional klasseFields: string[]
  
  optional, array with an id, name, longname, and external key
- Optional roomFields: string[]
  
  optional, array with an id, name, longname, and external key
- Optional subjectFields: string[]
  
  optional, array with an id, name, longname, and external key
- Optional teacherFields: string[]
  
  optional, array with an id, name, longname, and external key
Returns Promise<CustomTimetableResponse>

Promise of type [[CustomTimeTableResponse]]

getDay

getDay(date: number): object

- Defined in lib/types/time.ts:21
Parameters
- date: number
Returns object

getDepartments

getDepartments(): Promise<DepartmentResponse>

- Defined in lib/axios.ts:258
gets the departments

Returns Promise<DepartmentResponse>

Promise of type DepartmentResponse

getExamTypes

getExamTypes(): void

- Defined in lib/axios.ts:712
Returns void

getExams

getExams(examTypeId: string, startDate: number, endDate: number): Promise<ExamResponse>

- Defined in lib/axios.ts:682
function to get exams

Parameters
- examTypeId: string
  
  type of exam
- startDate: number
  
  start date of the time period
- endDate: number
  
  end date of the time period
Returns Promise<ExamResponse>

PRomise of type ExamResponse

getHolidays

getHolidays(): Promise<HolidaysRepsonse>

- Defined in lib/axios.ts:288
gets all holidays

Returns Promise<HolidaysRepsonse>

Promise of type [[HolidaysResponse]]

getPerson

getPerson(type: number, sn: string, fn: string, dob: number | 0): Promise<PersonResponse>

- Defined in lib/axios.ts:572
function for getting the id of a person

Parameters
- type: number
  
  type of person
- sn: string
  
  surname of person
- fn: string
  
  forename of person
- dob: number | 0
  
  date of birth of the person, default: 0
Returns Promise<PersonResponse>

Promise of type PersonResponse

getRemarks

getRemarks(): Promise<RemarksResponse>

- Defined in lib/axios.ts:755
function for getting the remarks

Returns Promise<RemarksResponse>

Promise of type RemarksResponse

getRemarksForGroups

getRemarksForGroups(): Promise<RemarksGroupResponse>

- Defined in lib/axios.ts:785
function for getting the remarks for groups

Returns Promise<RemarksGroupResponse>

Promise of type RemarksGroupResponse

getRoomByID

getRoomByID(rooms: RoomResponse, id: number): Room | undefined

- Defined in lib/types/rooms.ts:15
Parameters
- rooms: RoomResponse
- id: number
Returns Room | undefined

getRooms

getRooms(): Promise<RoomResponse>

- Defined in lib/axios.ts:228
gets the rooms

Returns Promise<RoomResponse>

Promise of type RoomResponse

getSimpleTimetable

getSimpleTimetable(id: number, type: number, startDate: number, endDate: number): Promise<TimetableResponse>

- Defined in lib/axios.ts:442
function for getting an simple timetable

Parameters
- id: number
  
  the element id
- type: number
  
  the element type
- startDate: number
  
  the start date of the time period
- endDate: number
  
  the end date of the time period
Returns Promise<TimetableResponse>

Promise of type TimetableResponse

getStatusData

getStatusData(): Promise<StatusResponse>

- Defined in lib/axios.ts:348
gets the "status Data" for a institution which are farbcodes for lessons etc.

Returns Promise<StatusResponse>

Promise of type StatusResponse

getStudents

getStudents(): Promise<StudentResponse>

- Defined in lib/axios.ts:138
gets the students

Returns Promise<StudentResponse>

Promise of type StudentResponse

getSubjectById

getSubjectById(subjects: SubjectResponse, id: number): Subject | undefined

- Defined in lib/types/subjects.ts:15
Parameters
- subjects: SubjectResponse
- id: number
Returns Subject | undefined

getSubjects

getSubjects(): Promise<SubjectResponse>

- Defined in lib/axios.ts:198
gets the subjects

Returns Promise<SubjectResponse>

Promise of type SubjectResponse

getSubstitutions

getSubstitutions(startDate: number, endDate: number, departmentId: number | 0): Promise<SubstitutionResponse>

- Defined in lib/axios.ts:610
function for getting the substitutions of a time period and a department

Parameters
- startDate: number
  
  the start date of the time period
- endDate: number
  
  the end date of the time period
- departmentId: number | 0
  
  the departmentId where to search for substitutions, default: 0 (all departments)
Returns Promise<SubstitutionResponse>

Promise of type [[SubstitutionsResponse]]

getTeacherByID

getTeacherByID(teachers: TeacherResponse, id: number): undefined | Teacher

- Defined in lib/types/teachers.ts:15
Parameters
- teachers: TeacherResponse
- id: number
Returns undefined | Teacher

getTeachers

getTeachers(): Promise<TeacherResponse>

- Defined in lib/axios.ts:110
gets the teachers

Returns Promise<TeacherResponse>

Promise of type TeacherResponse

getTime

getTime(time: Time): object

- Defined in lib/types/time.ts:3
Parameters
- time: Time
Returns object

getTimegrid

getTimegrid(): Promise<TimegridResponse>

- Defined in lib/axios.ts:318
gets the timegrid for the institution

Returns Promise<TimegridResponse>

Promise of type TimegridResponse

getURL

getURL(server: string, school: string): string

- Defined in lib/axios.ts:885
Parameters
- server: string
- school: string
Returns string

login

- Defined in lib/axios.ts:40
Signs you into Untis

Parameters
- config: Config
  
  the config of type Config for logging in
Returns Promise<Untis>

Promise of type Untis when successful login

logout

logout(): Promise<boolean>

- Defined in lib/axios.ts:79
Logs you out of your session

Returns Promise<boolean>

returns true if successful logout and false if not

sendCustomRequest

sendCustomRequest(request: Request): Promise<Response>

- Defined in lib/axios.ts:865
function for sending custom requests

Parameters
- request: Request
  
  the custom request you want to send
Returns Promise<Response>

Promise of type Response

Index

Classes

Interfaces

Type aliases

Functions

Type aliases

methods

types

Functions

getAbsences

Parameters

startDate: number

endDate: number

Returns Promise<AbsenceResponse>

getAvailableSchoolyears

Returns Promise<SchoolyearResponse>

getClassByID

Parameters

klassen: ClassesResponse

id: number

Returns Class | undefined

getClassRegisterEvents

Parameters

startDate: number

endDate: number

Returns Promise<ClassRegEventResponse>

getClasses

Returns Promise<ClassesResponse>

getCurrentSchoolyear

Returns Promise<SchoolyearResponse>

getCustomClassRegEvents

Parameters

startDate: number

endDate: number

_id: string

type: types

keyType: "id" | "name" | "externalkey"

Returns Promise<ClassRegEventResponse>

getCustomizableTimetable

Parameters

_id: string

type: number

keyType: string | "id"

startDate: number

endDate: number

onlyBaseTimetable: boolean | false

showBooking: boolean | false

showInfo: boolean | false

showSubstText: boolean | false

showLsText: boolean | false

showLsNumber: boolean | false

showStudentgroup: boolean | false

Optional klasseFields: string[]

Optional roomFields: string[]

Optional subjectFields: string[]

Optional teacherFields: string[]

Returns Promise<CustomTimetableResponse>

getDay

Parameters

date: number

Returns object

getDepartments

Returns Promise<DepartmentResponse>

getExamTypes

Returns void

getExams

Parameters

examTypeId: string

startDate: number

endDate: number

Returns Promise<ExamResponse>

getHolidays

Returns Promise<HolidaysRepsonse>

getPerson

Parameters

type: number

sn: string

fn: string

dob: number | 0

Returns Promise<PersonResponse>