Interfaces

All Interfaces

Any and all interfaces are exported. The interfaces that are missing the Structure Response subheading aren't too important/isn't the response type of a function.

SchoolSoft.LunchMenu

The lunch menu interface for the <SchoolSoft>.getLunchMenu() function.

Interface Structure

export interface LunchMenu {
  heading: string;
  menu: {
    title: string;
    lunch: string;
  }[];
}

Structure Response

{
  heading,
  menu: [{
    title,
    lunch
  }]
}

SchoolSoft.NewsKeys

Keys for the SchoolSoft.News interface.

Interface Structure

export interface NewsKeys {
  heading: string;
  content: string;
  date: string;
  from: string;
  to: string;
}

SchoolSoft.NewsCategoryAndNews

Category and news for the news.

Interface Structure

export interface NewsCategoryAndNews {
  category: string;
  news: NewsKeys[];
}

SchoolSoft.News

The news interface for the <SchoolSoft>.getNews() function.

Interface Structure

export interface News {
  [index: number]: NewsCategoryAndNews;
}

Structure Response

[{
  category,
  news: [{
    heading,
    content,
    date,
    from,
    to
  }]
}]

SchoolSoft.AssignmentKeys

Keys for the SchoolSoft.Assignments interface.

Interface Structure

export interface AssignmentKeys {
  heading: string;
  content: string;
  date: string;
  lesson: string;
  teacher: string;
  type: string;
  id: number;
}

SchoolSoft.Assignments

The assignments interface for the <SchoolSoft>.getAssignments() function.

Interface Structure

export interface Assignments {
  upcoming: AssignmentKeys[];
  old: AssignmentKeys[];
}

Structure Response

{
  upcoming: [{
    heading,
    content,
    date,
    lesson,
    teacher,
    type,
    id
  }],
  old: [{
    heading,
    content,
    date,
    lesson,
    teacher,
    type,
    id
  }]
}

SchoolSoft.ResultKeys

The keys for the SchoolSoft.Results interface.

Interface Structure

export interface ResultKeys {
  heading: string;
  comment: string;
  description: string;
  date: string;
  lesson: string;
  teacher: string;
  type: string;
  id: number;
}

SchoolSoft.Results

The results interface for the <SchoolSoft>.getResults() function.

Interface Structure

export interface Results {
  new: ResultKeys[];
  old: ResultKeys[];
}

Structure Response

{
  new: [{
    heading,
    comment,
    description,
    date,
    lesson,
    teacher,
    type,
    id
  }],
  old: [{
    heading,
    comment,
    description,
    date,
    lesson,
    teacher,
    type,
    id
  }]
}

SchoolSoft.WeeklyPlanningKeys

Keys for the SchoolSoft.WeeklyPlanning interface.

Interface Structure

export interface WeeklyPlanningKeys {
  week: number;
  duration: string;
  content: string;
}

SchoolSoft.WeeklyPlanningSubjectAndPlanning

Subject and planning for the weekly planning.

Interface Structure

export interface WeeklyPlanningSubjectAndPlanning {
  subject: string;
  planning: WeeklyPlanningKeys[];
}

SchoolSoft.WeeklyPlanning

The weekly planning interface for the <SchoolSoft>.getWeeklyPlanning() function.

Interface Structure

export interface WeeklyPlanning {
  [index: number]: WeeklyPlanningSubjectAndPlanning;
}

Structure Response

[{
  subject,
  planning: [{
    week,
    duration,
    content
  }]
}]