Advanced and easy-to-use object-oriented module for the Student, Guardian and Teacher Kreta API.

Disclaimer • Features • Installation • Example • Exports • Methods • Licence • Issues • Contributing

Disclaimer

[!CAUTION] This project is not affiliated with the eKRÉTA Informatikai Zrt.. This is an unofficial API client for the Kréta Mobile API. Use the library at your own risk. The author does not take any responsibility for any damage caused by the usage of this library.

Features

• Object-oriented library
• Easy-to-use methods and classes
• Easy JSON conversion
• Object validation
• TypeScript support

Installation

Install the module with your favorite package manager.

$ npm install kreta.js
$ yarn add kreta.js
$ pnpm add kreta.js

Build the module from source.

# Clone the repository
$ git clone https://github.com/blazsmaster/kreta.js.git

# Go to the project directory
$ cd kreta.js

# Install dependencies (with your favorite package manager)
$ npm install

# Build the module
$ npm run build

Example

// Import the module (CommonJS)
const { IdpApiV1, MobileApiV3 } = require('kreta.js');

// Import the module (ES6)
import { IdpApiV1, MobileApiV3 } from 'kreta.js';

// Login with personal credentials
const idp = new IdpApiV1({
	instituteCode: 'pelda-intezmeny',
	password: 'abcd1234',
	username: '1234567890',
});

// Example function implements the login and getStudent methods
async function tanuloNeve() {
	// Obtain the access token
	await idp.login().then(async (tokenObj) => {
		// Create a new MobileApiV3 instance for the student API
		const api = new MobileApiV3({
			// Use the institute code from the IdpApiV1 instance (optional, but recommended)
			instituteCode: idp.instituteCode,
			// Use the access token from the response
			accessToken: tokenObj.access_token,
		});

		// Get the student data
		await api.getStudent().then((tanulo) => {
			// Every method has a `json` property to return parsed and validated data
			console.log(tanulo.json);
			// Returns the student's name
			return tanulo.Nev;
		});
	});
}

console.log(await tanuloNeve()); // Minta János

Exports

Classes

• EAdminApiV1 - E-Ügyintézés API methods

  new EAdminApiV1({
    accessToken: '',
  });

  • Params:
    • accessToken – Access token obtained from IdpApiV1.login() or IdpApiV1.extendToken() or manually

• GlobalApiV1 - Global API methods (unauthorized access)

  new GlobalApiV1();

• IdpApiV1 - Authentication API (& util) methods

  new IdpApiV1({
    instituteCode: '',
    password: '',
    username: '',
  });

  • Params:
    • instituteCode – Unique institute code string
    • password – Kreta password string
    • username – Kreta username string

• MobileApiV3 - Student and Guardian API methods

  new MobileApiV3({
    instituteCode: '',
    accessToken: '',
  });

  • Params:
    • instituteCode – Unique institute code string
    • accessToken – Access token obtained from IdpApiV1.login() or IdpApiV1.extendToken() or manually
    • tokenType – Access token type (optional) string

• NaploApiV3 - Teacher API methods

  new NaploApiV3({
    instituteCode: '',
    accessToken: '',
  });

  • Params:
    • instituteCode – Unique institute code string
    • accessToken – Access token obtained from IdpApiV1.login() or IdpApiV1.extendToken() or manually

Functions

• createKretaInsult - Generate a random Kreta insult based on the famous "DirtyWords.xml" file

  createKretaInsult('');

  • Args:
    • prefix - Prefix of the insult (optional) string (default: "Te")

Namespaces and Interfaces

• EAdminApiTypes - E-Ügyintézés API types

• GlobalApiTypes - Global API types

• IdpApiTypes - Authentication API types

• MobileApiTypes - Student and Guardian API types

• NaploApiTypes - Teacher API types

• DateFilter - Date filter interface

• TimeTableDateFilter - Time table date filter interface

Methods

IdpApiV1

• getNonce – Query nonce

  idp.getNonce();

  • Returns: Promise<string>

• login – Query token information

  idp.login();

  • Returns: Promise<AuthenticationDto>

• extendToken – Renews the access token

  idp.extendToken({
    instituteCode: '',
    refreshToken: '',
    refreshUserData: true,
    username: '',
    accessToken: '',
    tokenType: '',
  });

  • Params:

    • instituteCode – Unique institute code string
    • refreshToken – Refresh token string
    • refreshUserData – Refresh user data boolean
    • username – Kreta username string
    • accessToken – Access token (optional) string
    • tokenType – Token type (optional) string

  • Returns: Promise<AuthenticationDto>

• revokeRefreshToken – Revokes the refresh token

  idp.revokeRefreshToken('');

  • Args:

    • token – Refresh token string

  • Returns: Promise<void>

• isValidToken – Checks if the token is valid

  idp.isValidToken('');

  • Args:

    • token – Token string

  • Returns: boolean

• resolveTokenData – Resolves the token data

  idp.resolveTokenData('');

  • Args:

    • token – Token string

  • Returns: TokenDto

GlobalApiV1

• getGlobalConfigurationDescriptors – Query global configuration descriptors

  globalApi.getGlobalConfigurationDescriptors();

  • Returns: Promise<Record<string, string>>

• getInstitutesV1 – Query all institutes (old version)

  globalApi.getInstitutesV1();

  • Returns: Promise<Array<InstituteV1Dto>>

• getInstitutes – Query all institutes

  globalApi.getInstitutes();

  • Returns: Promise<Array<InstituteDto>>

MobileApiV3

• deleteBankAccountNumber – Deletes student's bank account data

  mobileApi.deleteBankAccountNumber();

  • Returns: Promise<void>

• deleteReservation – Cancels reservation for a scheduled consultation hour

  mobileApi.deleteReservation('');

  • Args:

    • uid – Consultation hour unique identifier string

  • Returns: Promise<void>

• downloadAttachment – Downloads an attachment

  mobileApi.downloadAttachment('');

  • Args:

    • uid – Attachment unique identifier string

  • Returns: Promise<Blob>

• getAnnouncedTests – Retrieves announced tests within a specified date range

  mobileApi.getAnnouncedTests({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date (optional) string
    • endDate – End date (optional) string

  • Returns: Promise<Array<AnnouncedTestDto>>

• getAnnouncedTest – Retrieves details of an announced test by its unique identifier

  mobileApi.getAnnouncedTest('');

  • Args:

    • uid – Announced test unique identifier string

  • Returns: Promise<AnnouncedTestDto>

• getAnnouncedTestsByUids – Retrieves announced tests by their unique identifiers

  mobileApi.getAnnouncedTestsByUids(['']);

  • Args:

    • uids – Announced test unique identifiers string | Array<string>

  • Returns: Promise<Array<AnnouncedTestDto>>

• getClassAverage – Retrieves class averages for subjects

  mobileApi.getClassAverage('');

  • Args:

    • oktatasiNevelesiFeladatUid – Educational task unique identifier string
    • tantargyUid – Subject unique identifier (optional) string

  • Returns: Promise<Array<ClassAverageDto>>

• getClassMaster – Retrieves class masters by their unique identifiers

  mobileApi.getClassMaster(['']);

  • Args:

    • uids – Class master unique identifiers string | Array<string>

  • Returns: Promise<Array<ClassMasterDto>>

• getConsultingHour – Retrieves consulting hour details for guardians

  mobileApi.getConsultingHour('');

  • Args:

    • uid – Consulting hour unique identifier string

  • Returns: Promise<ConsultingHourDto>

• getConsultingHours – Retrieves consulting hours for guardians within a specified date range

  mobileApi.getConsultingHours({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date (optional) string
    • endDate – End date (optional) string

  • Returns: Promise<Array<ConsultingHourDto>>

• getDeviceGivenState – Checks if a device has been allocated to the student

  mobileApi.getDeviceGivenState();

  • Returns: Promise<boolean>

• getEvaluations – Retrieves student's evaluations within a specified date range

  mobileApi.getEvaluations({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date string
    • endDate – End date string

  • Returns: Promise<Array<EvaluationDto>>

• getEvaluation – Retrieves details of an evaluation by its unique identifier

  mobileApi.getEvaluation('');

  • Args:

    • uid – Evaluation unique identifier string

  • Returns: Promise<EvaluationDto>

• getCertificateEvaluations – Retrieves student's certificate evaluations

  mobileApi.getCertificateEvaluations();

  • Returns: Promise<Array<EvaluationDto>>

• getNonCertificateEvaluations – Retrieves student's non-certificate evaluations

  mobileApi.getNonCertificateEvaluations();

  • Returns: Promise<Array<EvaluationDto>>

• getGroups – Retrieves groups and classes associated with the student

  mobileApi.getGroups();

  • Returns: Promise<Array<GroupDto>>

• getGuardian4T – Retrieves guardian's information

  mobileApi.getGuardian4T();

  • Returns: Promise<Guardian4TDto>

• getHomework – Retrieves homework details by its unique identifier

  mobileApi.getHomework('');

  • Args:

    • uid – Homework unique identifier string

  • Returns: Promise<HomeworkDto>

• getHomeworks – Retrieves homework within a specified date range

  mobileApi.getHomeworks({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date string
    • endDate – End date string

  • Returns: Promise<Array<HomeworkDto>>

• getLEPEvents – Retrieves Lázár Ervin Program events

  mobileApi.getLEPEvents();

  • Returns: Promise<Array<LEPEventDto>>

• getLesson – Retrieves lesson details by its unique identifier

  mobileApi.getLesson('');

  • Args:

    • orarendElemUid – Lesson unique identifier string

  • Returns: Promise<LessonDto>

• getLessons – Retrieves lessons within a specified date range

  mobileApi.getLessons({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date string
    • endDate – End date string

  • Returns: Promise<Array<LessonDto>>

• getNotes – Retrieves notes created by teachers during lessons within a specified date range

  mobileApi.getNotes({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date string
    • endDate – End date string

  • Returns: Promise<Array<NoteDto>>

• getNote – Retrieves a note by its unique identifier

  mobileApi.getNote('');

  • Args:

    • uid – Note unique identifier string

  • Returns: Promise<NoteDto>

• getNoticeBoardItems – Retrieves notice board items visible to the student

  mobileApi.getNoticeBoardItems();

  • Returns: Promise<Array<NoticeBoardItemDto>>

• getOmissions – Retrieves student's absences within a specified date range

  mobileApi.getOmissions({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date (optional) string
    • endDate – End date (optionAl) string

  • Returns: Promise<Array<OmissionDto>>

• getOmission – Retrieves absence details by its unique identifier

  mobileApi.getOmission('');

  • Args:

    • uid – Absence unique identifier string

  • Returns: Promise<OmissionDto>

• getRegistrationState – Checks if the guardian has registered

  mobileApi.getRegistrationState();

  • Returns: Promise<boolean>

• getSchoolYearCalendar – Retrieves school year calendar entries

  mobileApi.getSchoolYearCalendar();

  • Returns: Promise<Array<SchoolYearCalendarDto>>

• getStudent – Retrieves student's information

  mobileApi.getStudent();

  • Returns: Promise<StudentDto>

• getSubjectAverage – Retrieves subject averages for the student

  mobileApi.getSubjectAverage('');

  • Args:

    • oktatasiNevelesiFeladatUid – Educational task unique identifier string

  • Returns: Promise<Array<SubjectAverageDto>>

• getTeszekRegistration – Retrieves information regarding requested guardian devices

  mobileApi.getTeszekRegistration();

  • Returns: Promise<TeszekRegistrationDto>

• getTimeTableWeeks – Retrieves timetable week entries

  mobileApi.getTimeTableWeeks({
    startDate: 'YYYY-MM-DD',
    endDate: 'YYYY-MM-DD',
  });

  • Params:

    • startDate – Start date string
    • endDate – End date string

  • Returns: Promise<Array<TimeTableWeekDto>>

• getInstitution – Retrieves information about the institution

  mobileApi.getInstitution();

  • Returns: Promise<InstitutionDto>

• getDailyNotificationSummary – Retrieves a summary of daily notifications

  mobileApi.getDailyNotificationSummary();

  • Returns: Promise<DailyNotificationSummaryDto>

• getGuardianIsLegalRepresentative – Checks if the guardian is a legal representative

  mobileApi.getGuardianIsLegalRepresentative();

  • Returns: Promise<boolean>

• postBankAccountNumber – Posts student's bank account number

  mobileApi.postBankAccountNumber({
    BankszamlaSzam: '',
    BankszamlaTulajdonosNeve: '',
    BankszamlaTulajdonosTipusId: 0,
    SzamlavezetoBank: '',
  });

  • Params:

    • BankszamlaSzam – Bank account number string
    • BankszamlaTulajdonosNeve – Bank account owner's name string
    • BankszamlaTulajdonosTipusId – Bank account owner's type identifier number
    • SzamlavezetoBank – Bank name string

  • Returns: Promise<void>

• postContact – Posts contact information for the student or guardian

  mobileApi.postContact('', '');

  • Args:

    • email – Email address string
    • phoneNumber – Phone number string

  • Returns: Promise<void>

• postCovidReport – Reports a COVID infection

  mobileApi.postCovidReport();

  • Returns: Promise<void>

• postReservation – Registers for a scheduled consultation hour

  mobileApi.postReservation('');

  • Args:

    • uid – Consultation hour unique identifier string

  • Returns: Promise<void>

• postTeszekRegistration – Posts required data for guardian device requests

  mobileApi.postTeszekRegistration({
    SzuletesiDatum: 'YYYY-MM-DD',
    Utonev: '',
    SzuletesiUtonev: '',
    IsElfogadottAszf: true,
    AnyjaUtonev: '',
    AnyjaVezeteknev: '',
    Elotag: '',
    SzuletesiHely: '',
    Vezeteknev: '',
    SzuletesiVezeteknev: '',
  });

  • Params:

    • SzuletesiDatum – Birth date Date
    • Utonev – Last name string
    • SzuletesiUtonev – Birth last name string
    • IsElfogadottAszf – Is accepted ASZF boolean
    • AnyjaUtonev – Mother's last name string
    • AnyjaVezeteknev – Mother's first name string
    • Elotag – Prefix string
    • SzuletesiHely – Birth place string
    • Vezeteknev – First name string
    • SzuletesiVezeteknev – Birth first name string

  • Returns: Promise<void>

• updateGuardian4T – Updates guardian 4T data

  mobileApi.updateGuardian4T({
    SzuletesiDatum: 'YYYY-MM-DD',
    Utonev: '',
    SzuletesiUtonev: '',
    IsElfogadottAszf: true,
    AnyjaUtonev: '',
    AnyjaVezeteknev: '',
    Elotag: '',
    SzuletesiHely: '',
    Vezeteknev: '',
    SzuletesiVezeteknev: '',
  });

  • Params:

    • SzuletesiDatum – Birth date Date
    • Utonev – Last name string
    • SzuletesiUtonev – Birth last name string
    • IsElfogadottAszf – Is accepted ASZF boolean
    • AnyjaUtonev – Mother's last name string
    • AnyjaVezeteknev – Mother's first name string
    • Elotag – Prefix string
    • SzuletesiHely – Birth place string
    • Vezeteknev – First name string
    • SzuletesiVezeteknev – Birth first name string

  • Returns: Promise<void>

• updateLepEventPermission – Updates permission for Lázár Ervin Program events

  mobileApi.updateLepEventPermission({
      EloadasId: 0,
      Dontes: true,
  });

  • Params:

    • EloadasId – Lecture identifier number
    • Dontes – Decision (optional) boolean

  • Returns: Promise<void>

EAdminApiV1

• createAttachment – Creates an attachment

  eAdminApi.createAttachment(Buffer.from(''));

  • Args:

    • part – Attachment data Buffer | string

  • Returns: Promise<TemporaryFileDto>

• createRectification – Creates a rectification

  eAdminApi.createRectification('', {
    azonosito: '',
    tipus: {},
    tipusKod: '',
    csatolmanyok: [],
    statusz: {},
  });

  • Args:

    • ugyId – Case unique identifier string
    • body – Rectification data RectificationPost

  • Params body:

    • azonosito – Identifier string
    • tipus – Type Type
    • tipusKod – Type code string
    • csatolmanyok – Attachments Array<OtherThingsToDoAttachments>
    • statusz – Status State

  • Returns: Promise<any>

• createTmgiCase – Creates a TMGI case

  eAdminApi.createTmgiCase({
    igazolasTipus: {},
    tanuloOsztaly: '',
    igazoltTavolletVegeDatum: 'YYYY-MM-DD',
    kerelemKotelezoDokumentumLista: [],
    csatolmanyok: [],
    igazoltTavolletKezdeteDatum: 'YYYY-MM-DD',
    tanuloCsaladiNev: '',
    tanuloKeresztNev: '',
    tipus: {},
    tipusKod: '',
  });

  • Params:

    • igazolasTipus – Confirmation type Type
    • tanuloOsztaly – Student class string
    • igazoltTavolletVegeDatum – End date of the justified absence Date
    • kerelemKotelezoDokumentumLista – List of mandatory documents Array<ApplicationMandatoryDocument>
    • csatolmanyok – Attachments Array<OtherThingsToDoAttachments>
    • igazoltTavolletKezdeteDatum – Start date of the justified absence Date
    • tanuloCsaladiNev – Student's last name string
    • tanuloKeresztNev – Student's first name string
    • tipus – Type Type
    • tipusKod – Type code string

  • Returns: Promise<any>

• deleteMessagePermanently – Deletes a message permanently

  eAdminApi.deleteMessagePermanently([''], true);

  • Args:

    • postaladaElemAzonositok – Mailbox item unique identifiers Array<number | string>
    • isKuka – Is trash (optional) boolean

  • Returns: Promise<any>

• getAccessControlSystemEvents – Retrieves access control system events

  eAdminApi.getAccessControlSystemEvents();

  • Returns: Promise<Array<AccessControlSystemItemDto>

• getAddressableClasses – Retrieves addressable classes

  eAdminApi.getAddressableClasses('');

  • Args:

    • cimzettKod – Recipient code string

  • Returns: Promise<Array<KretaClassDto>

• getAddressableGuardiansForClass – Retrieves addressable guardians for a class

  eAdminApi.getAddressableGuardiansForClass('');

  • Args:

    • osztalyKretaAzonosito – Class unique identifier number | string

  • Returns: Promise<Array<GuardianEAdminDto>

• getAddressableSzmkRepesentative – Retrieves addressable SZMK representative

  eAdminApi.getAddressableSzmkRepesentative();

  • Returns: Promise<Array<GuardianEAdminDto>

• getAddressableType – Retrieves addressable type

  eAdminApi.getAddressableType();

  • Returns: Promise<Array<AddresseeTypeDto>

• getAddresseeType – Retrieves addressee type

  eAdminApi.getAddresseeType();

  • Returns: Promise<Array<AddresseeTypeDto>

• getAdministrators – Retrieves administrators

  eAdminApi.getAdministrators();

  • Returns: Promise<Array<EmployeeDetailsDto>

• getCase – Retrieves a case

  eAdminApi.getCase('');

  • Args:

    • ugyId – Case unique identifier string

  • Returns: Promise<CaseDto>

• getCaseTypes – Retrieves case types

  eAdminApi.getCaseTypes();

  • Returns: Promise<Array<TypeDto>

• getCases – Retrieves cases

  eAdminApi.getCases(true);

  • Args:

    • isLezartakIs – Is closed (optional) boolean

  • Returns: Promise<Array<CaseDto>

• getChildData – Retrieves child data

  eAdminApi.getChildData();

  • Returns: Promise<ChildDto>

• getClassMasters – Retrieves class masters

  eAdminApi.getClassMasters();

  • Returns: Promise<Array<EmployeeDetailsDto>

• getCurrentInstitutionDetails – Retrieves current institution details

  eAdminApi.getCurrentInstitutionDetails();

  • Returns: Promise<CurrentInstitutionDetailsDto>

• getCurrentInstitutionModules – Retrieves current institution modules

  eAdminApi.getCurrentInstitutionModules();

  • Returns: Promise<Array<string>

• getDirectors – Retrieves directors

  eAdminApi.getDirectors();

  • Returns: Promise<Array<EmployeeDetailsDto>

• getMessage – Retrieves a message

  eAdminApi.getMessage('');

  • Args:

    • azonosito – Message unique identifier number | string

  • Returns: Promise<MailboxItemDto>

• getMessageLimitations – Retrieves message limitations

  eAdminApi.getMessageLimitations();

  • Returns: Promise<MessageLimitationsDto>

• getMessages – Retrieves messages

  eAdminApi.getMessages();

  • Returns: Promise<Array<MailboxItemDto>

• getSigner – Retrieves a signer

  eAdminApi.getSigner('', '');

  • Args:

    • kerelemAzonosito – Request unique identifier number | string
    • kretaAzonosito – Kreta identifier number | string

  • Returns: Promise<SignerDto>

• getStatus – Retrieves status

  eAdminApi.getStatus();

  • Returns: Promise<StatusDto>

• getSzmk – Retrieves SZMK

  eAdminApi.getSzmk();

  • Returns: Promise<Array<GuardianDto>

• getTeachers – Retrieves teachers

  eAdminApi.getTeachers();

  • Returns: Promise<Array<EmployeeDetailsDto>

• getTmgiCaseTypes – Retrieves TMGI case types

  eAdminApi.getTmgiCaseTypes();

  • Returns: Promise<Array<TypeDto>

• getUnreadMessagesCount – Retrieves unread messages count

  eAdminApi.getUnreadMessagesCount();

  • Returns: Promise<number>

• readMessage – Reads a message

  eAdminApi.readMessage({
    postaladaElemAzonositok: [],
    isKuka: true,
  });

  • Args:

    • body – Read message request fields ReadMessageRequest

  • Params:

    • postaladaElemAzonositok – Mailbox item unique identifiers Array<number>
    • isKuka – Is trash boolean

  • Returns: Promise<any>

• sendMessage – Sends a message

  eAdminApi.sendMessage({
    cimzettLista: [],
    csatolmanyok: [],
    azonosito: 0,
    feladoNev: '',
    feladoTitulus: '',
    kuldesDatum: new Date(),
    targy: '',
    szoveg: '',
    elozoUzenetAzonosito: 0,
  });

  • Args:

    • body – Message fields Message

  • Params body:

    • cimzettLista – Recipient list Array<AddresseeDto>
    • csatolmanyok – Attachments Array<AttachmentDto>
    • azonosito – Identifier number
    • feladoNev – Sender name string
    • feladoTitulus – Sender title string
    • kuldesDatum – Sending date Date
    • targy – Subject string
    • szoveg – Text string
    • elozoUzenetAzonosito – Previous message identifier number

  • Returns: Promise<any>

• sendMessageToBin – Sends a message to the bin

  eAdminApi.sendMessageToBin({
    isKuka: true,
    postaladaElemAzonositoLista: [],
  });

  • Args:

    • body – Send message to bin request fields SendMessageToBinRequest

  • Params body:

    • isKuka – Is trash boolean
    • postaladaElemAzonositoLista – Mailbox item unique identifiers Array<number>

  • Returns: Promise<any>

NaploApiV3

• getEvaluationMode – Retrieves evaluation mode

  naploApi.getEvaluationMode('');

  • Args:

    • enumTipus – Enum type string

  • Returns: Promise<Array<EvaluationModeDto>>

• getHomework – Retrieves homework

  naploApi.getHomework('');

  • Args:

    • uid – Homework unique identifier string | number

  • Returns: Promise<HomeworkGetDto>

• postHomework – Posts homework

  naploApi.postHomework({
      OsztalyCsoportId: 0,
      HataridoDatuma: 'YYYY-MM-DD',
  	Szoveg: '',
      OraDatum: 'YYYY-MM-DD',
      TantargyId: 0,
  });

  • Args:

    • body – Homework fields HomeworkPostFields

  • Params body:

    • OsztalyCsoportId – Class group identifier number
    • HataridoDatuma – Deadline date Date
    • Szoveg – Text string
    • OraDatum – Hour date Date
    • TantargyId – Subject identifier number

  • Returns: Promise<number>

• putHomework – Updates homework

  naploApi.putHomework('', {
    HataridoDatuma: 'YYYY-MM-DD',
    Szoveg: '',
  });

  • Args:

    • uid – Homework unique identifier string | number
    • body – Homework fields HomeworkPutFields

  • Params body:

    • HataridoDatuma – Deadline date Date
    • Szoveg – Text string

  • Returns: Promise<void>

• deleteHomework – Deletes homework

  naploApi.deleteHomework('');

  • Args:

    • uid – Homework unique identifier string | number

  • Returns: Promise<void>

• deleteHomeworkAttachment – Deletes homework attachment

  naploApi.deleteHomeworkAttachment('');

  • Args:

    • uid – Homework unique identifier string | number

  • Returns: Promise<void>

• getJustification – Retrieves justification

  naploApi.getJustification('');

  • Args:

    • tanuloId – Student identifier number | string

  • Returns: Promise<JustificationDto>

• postJustification – Posts justification

  naploApi.postJustification({
    TanuloId: 0,
    OsztalyCsoportId: 0,
    IgazolasKezdete: 'YYYY-MM-DD',
    IgazolasVege: 'YYYY-MM-DD',
    IgazolasTipus: '',
    IgazolasMegjegyzes: '',
  });

  • Args:

    • body – Justification fields JustificationPostFields

  • Params body:

    • TanuloId – Student identifier number
    • OsztalyCsoportId – Class group identifier number
    • IgazolasKezdete – Justification start date Date
    • IgazolasVege – Justification end date Date
    • IgazolasTipus – Justification type string
    • IgazolasMegjegyzes – Justification comment string

  • Returns: Promise<void>

• deleteJustification – Deletes justification

  naploApi.deleteJustification('');

  • Args:

    • uid – Justification unique identifier string

  • Returns: Promise<void>

• getSchoolGuard – Retrieves school guard

  naploApi.getSchoolGuard();

  • Returns: Promise<Array<SchoolGuardDto>

• getNotes – Retrieves notes

  naploApi.getNotes();

  • Returns: Promise<Array<StudentNotesDto>

• getTimetable – Retrieves timetable

  naploApi.getTimetable({
    datumTol: 'YYYY-MM-DD',
    datumIg: 'YYYY-MM-DD',
  });

  • Args:

    • df – Timetable date filter DateFilter

  • Params df:

    • orarendElemKezdoNapDatuma – Timetable start date Date
    • orarendElemVegNapDatuma – Timetable end date Date

  • Returns: Promise<Array<TimetableElementDto>

• getTimetableElement – Retrieves timetable element

  naploApi.getTimetableElement('');

  • Args:

    • orarendElemUid – Timetable element unique identifier string

  • Returns: Promise<TimetableElementDto>

• getTimetableWeeks – Retrieves timetable weeks

  naploApi.getTimetableWeeks({
    orarendElemKezdoNapDatuma: 'YYYY-MM-DD',
    orarendElemVegNapDatuma: 'YYYY-MM-DD',
  });

  • Args:

    • df – Timetable date filter TimeTableDateFilter

  • Params df:

  • orarendElemKezdoNapDatuma – Timetable start date Date

  • orarendElemVegNapDatuma – Timetable end date Date

  • Returns: Promise<Array<TimetableWeekDto>

• postLogging – Posts logging

  naploApi.postLogging({
    IsElmaradt: true,
    TanuloLista: [],
    OrarendElemUid: '',
    Tema: '',
  });

  • Args:

    • body – Logging fields LessonLoggingRequestFields

  • Params body:

    • IsElmaradt – Is missed boolean
    • TanuloLista – Student list Array<StudentDataForLoggingRequestDto>
    • OrarendElemUid – Timetable element unique identifier string
    • Tema – Topic string

  • Returns: Promise<string>

• deleteLogging – Deletes logging

  naploApi.deleteLogging('');

  • Args:

    • orarendElemUid – Timetable element unique identifier string

  • Returns: Promise<TimetableElementDto>

• getStudentPresence – Retrieves student presence

  naploApi.getStudentPresence('');

  • Args:

    • orarendElemUid – Timetable element unique identifier string

  • Returns: Promise<Array<StudentPresenceDto>

• getAnnouncedTests – Retrieves announced tests

  naploApi.getAnnouncedTests('', '');

  • Args:

    • osztalyCsoportId – Class group identifier number | string
    • datum – Date Date | string | number

  • Returns: Promise<Array<AnnouncedTestDto>

• getAnnouncedTest – Retrieves announced test

  naploApi.getAnnouncedTest('');

  • Args:

    • uid – Announced test unique identifier number | string

  • Returns: Promise<AnnouncedTestDto>

• deleteAnnouncedTest – Deletes announced test

  naploApi.deleteAnnouncedTest('');

  • Args:

    • uid – Announced test unique identifier number | string

  • Returns: Promise<void>

• postAnnouncedTest – Posts announced test

  naploApi.postAnnouncedTest({
    ErtekelesMod: 0,
    ForceSave: true,
    OrarendElemUid: '',
    Tema: '',
  });

  • Args:

    • body – Announced test fields AnnouncedTestRequestFields

  • Params body:

    • ErtekelesMod – Evaluation mode number
    • ForceSave – Force save boolean
    • OrarendElemUid – Timetable element unique identifier string
    • Tema – Topic string

  • Returns: Promise<AnnouncedTestDto>

• getStudentEvaluations – Retrieves student evaluations

  naploApi.getStudentEvaluations('', '', {
    datum: 'YYYY-MM-DD',
    tanuloId: 0,
  });

  • Args:

    • tantargyId – Subject identifier number | string
    • osztalyCsoportId – Class group identifier number | string
    • ops – Options { datum?: Date | string | number, tanuloId?: number | string }

  • Params ops:

    • datum – Date Date | string | number
    • tanuloId – Student identifier (optional) number | string

  • Returns: Promise<Array<StudentEvaluationDto>

• postClassGroupEvaluations – Posts class group evaluations

  naploApi.postClassGroupEvaluations([]);

  • Args:

    • body – Class group evaluations fields Array<StudentEvaluationFields>

  • Returns: Promise<Array<StudentEvaluationDto>

• getSentenceBankItems – Retrieves sentence bank items

  naploApi.getSentenceBankItems('', '');

  • Args:

    • tantargyId – Subject identifier number | string
    • osztalyCsoportId – Class group identifier number | string

  • Returns: Promise<Array<SentenceBankItemDto>

• getStudents – Retrieves students

  naploApi.getStudents('', '');

  • Args:

    • osztalyCsoportId – Class group identifier number | string
    • datum – Date Date | string | number

  • Returns: Promise<Array<StudentDto>

• getStudent – Retrieves student

  naploApi.getStudent('');

  • Args:

    • uid – Student unique identifier number | string

  • Returns: Promise<ClassGroupStudentDto>

• getClassGroups – Retrieves class groups

  naploApi.getClassGroups();

  • Returns: Promise<Array<ClassGroupDto>

• getEvaluations – Retrieves evaluations

  naploApi.getEvaluations('', '', '');

  • Args:

    • tanuloId – Student identifier number | string
    • tantargyId – Subject identifier number | string
    • osztalyCsoportId – Class group identifier number | string

  • Returns: Promise<Array<EvaluationDto>

• updateEvaluation – Updates evaluation

  naploApi.updateEvaluation('', {
    ErtekelesDatum: new Date(),
    ErtekelesOsztalyzatId: 0,
    ErtekelesSzazalek: 0,
    ErtekelesSzoveg: '',
    ErtekelesModId: 0,
    ErtekelesTema: '',
  });

  • Args:

    • uid – Evaluation unique identifier number | string
    • body – Evaluation fields EvaluationUpdateRequestFields

  • Params body:

    • ErtekelesDatum – Evaluation date Date
    • ErtekelesOsztalyzatId – Evaluation grade identifier (optional) number
    • ErtekelesSzazalek – Evaluation percentage (optional) number
    • ErtekelesSzoveg – Evaluation text (optional) string
    • ErtekelesModId – Evaluation mode identifier number
    • ErtekelesTema – Evaluation topic string

  • Returns: Promise<EvaluationDto>

• deleteEvaluation – Deletes evaluation

  naploApi.deleteEvaluation('');

  • Args:

    • uid – Evaluation unique identifier number | string

  • Returns: Promise<void>

• getProfile – Retrieves profile

  naploApi.getProfile();

  • Returns: Promise<TeacherProfileDto>

• getSettings – Retrieves settings

  naploApi.getSettings();

  • Returns: Promise<TeacherSettingsDto>

• postSettings – Posts settings

  naploApi.postSettings({
    ElozoOranHianyzoAjanlasa: true,
  });

  • Args:

    • body – Settings fields TeacherSettingsRequestFields

  • Params body:

    • ElozoOranHianyzoAjanlasa – Previous lesson missing recommendation boolean

  • Returns: Promise<void>

• getSubjectDivision – Retrieves subject division

  naploApi.getSubjectDivision();

  • Returns: Promise<Array<SubjectDivisionDto>

• getSyllabus – Retrieves syllabus

  naploApi.getSyllabus('', '', '');

  • Args:

    • tantargyId – Subject identifier number | string
    • osztalyCsoportId – Class group identifier number | string
    • tanarUid – Teacher unique identifier string

  • Returns: Promise<Array<SyllabusItemDto>

License

MIT

Issues

If you find a bug, please file an issue on the issue tracker.

Contributing

Feel free to contribute to this project. Any kind of help is appreciated!