Interface Results

List of all possible Requests with their Parameters and Response ":" is used to separate Module and Endpoint "+" is used to separate multiple Requests with same Id but different Parameters and Response

Hierarchy

  • Results

Properties

calendar:get-events-for-user classbook:get-statistics+subject classbook:get-statistics+time exams:get-exams letters:get-letters messenger:count-new-messages messenger:get-messages-by-subscription messenger:get-remote-storage-url messenger:get-subscriptions null:get-current-term null:get-institution null:get-new-notifications-count null:get-notifications null:get-settings null:get-websocket-push-url null:set-notification-read schedules:get-actual-lessons schedules:poqa+classhour

Properties

calendar:get-events-for-user

calendar:get-events-for-user: {
    parameters: EventsRequest;
    response: Events;
}

Type declaration

classbook:get-statistics+subject

classbook:get-statistics+subject: {
    parameters: StatisticsRequest<"subject">;
    response: StatisticBySubject[];
}

Type declaration

classbook:get-statistics+time

classbook:get-statistics+time: {
    parameters: StatisticsRequest<"time">;
    response: StatisticByTime;
}

Type declaration

exams:get-exams

exams:get-exams: {
    parameters: ExamRequest;
    response: Exam[];
}

Type declaration

letters:get-letters

letters:get-letters: {
    parameters: undefined;
    response: Letter[];
}

Type declaration

  • parameters: undefined
  • response: Letter[]

messenger:count-new-messages

messenger:count-new-messages: {
    parameters: undefined;
    response: number;
}

Type declaration

  • parameters: undefined
  • response: number

messenger:get-messages-by-subscription

messenger:get-messages-by-subscription: {
    parameters: MessagesRequest;
    response: undefined | Messages;
}

Type declaration

messenger:get-remote-storage-url

messenger:get-remote-storage-url: {
    parameters: undefined;
    response: string;
}

Type declaration

  • parameters: undefined
  • response: string

messenger:get-subscriptions

messenger:get-subscriptions: {
    parameters: undefined;
    response: Subscription[];
}

Type declaration

null:get-current-term

null:get-current-term: {
    parameters: undefined;
    response: Term;
}

Type declaration

  • parameters: undefined
  • response: Term

null:get-institution

null:get-institution: {
    parameters: undefined;
    response: Institution;
}

Type declaration

null:get-new-notifications-count

null:get-new-notifications-count: {
    parameters: undefined;
    response: number;
}

Type declaration

  • parameters: undefined
  • response: number

null:get-notifications

null:get-notifications: {
    parameters: NotificationsRequest;
    response: Notification[];
}

Type declaration

null:get-settings

null:get-settings: {
    parameters: undefined;
    response: Settings;
}

Type declaration

  • parameters: undefined
  • response: Settings

null:get-websocket-push-url

null:get-websocket-push-url: {
    parameters: undefined;
    response: string;
}

Type declaration

  • parameters: undefined
  • response: string

null:set-notification-read

null:set-notification-read: {
    parameters: SetNotificationReadRequest;
    response: null;
}

Type declaration

schedules:get-actual-lessons

schedules:get-actual-lessons: {
    parameters: LessonRequest;
    response: Lesson[];
}

Type declaration

schedules:poqa+classhour

schedules:poqa+classhour: {
    parameters: ScheduleClassHourRequest;
    response: ScheduleClassHourResponse;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc