Skip to content

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

License

Notifications You must be signed in to change notification settings

blazsmaster/kreta.js

Repository files navigation


kreta.js

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

NPM Version GitHub Issues or Pull Requests GitHub Issues or Pull Requests GitHub License GitHub Repo stars wakatime

DisclaimerFeaturesInstallationExampleExportsMethodsLicenceIssuesContributing

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();
  • 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();
  • getInstitutes – Query all institutes

    globalApi.getInstitutes();

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',
    });
  • getAnnouncedTest – Retrieves details of an announced test by its unique identifier

    mobileApi.getAnnouncedTest('');
  • getAnnouncedTestsByUids – Retrieves announced tests by their unique identifiers

    mobileApi.getAnnouncedTestsByUids(['']);
  • 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(['']);
  • getConsultingHour – Retrieves consulting hour details for guardians

    mobileApi.getConsultingHour('');
  • getConsultingHours – Retrieves consulting hours for guardians within a specified date range

    mobileApi.getConsultingHours({
      startDate: 'YYYY-MM-DD',
      endDate: 'YYYY-MM-DD',
    });
  • 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',
    });
  • getEvaluation – Retrieves details of an evaluation by its unique identifier

    mobileApi.getEvaluation('');
  • getCertificateEvaluations – Retrieves student's certificate evaluations

    mobileApi.getCertificateEvaluations();
  • getNonCertificateEvaluations – Retrieves student's non-certificate evaluations

    mobileApi.getNonCertificateEvaluations();
  • getGroups – Retrieves groups and classes associated with the student

    mobileApi.getGroups();
  • getGuardian4T – Retrieves guardian's information

    mobileApi.getGuardian4T();
  • getHomework – Retrieves homework details by its unique identifier

    mobileApi.getHomework('');
  • getHomeworks – Retrieves homework within a specified date range

    mobileApi.getHomeworks({
      startDate: 'YYYY-MM-DD',
      endDate: 'YYYY-MM-DD',
    });
  • getLEPEvents – Retrieves Lázár Ervin Program events

    mobileApi.getLEPEvents();
  • getLesson – Retrieves lesson details by its unique identifier

    mobileApi.getLesson('');
  • getLessons – Retrieves lessons within a specified date range

    mobileApi.getLessons({
      startDate: 'YYYY-MM-DD',
      endDate: 'YYYY-MM-DD',
    });
  • getNotes – Retrieves notes created by teachers during lessons within a specified date range

    mobileApi.getNotes({
      startDate: 'YYYY-MM-DD',
      endDate: 'YYYY-MM-DD',
    });
  • getNote – Retrieves a note by its unique identifier

    mobileApi.getNote('');
  • getNoticeBoardItems – Retrieves notice board items visible to the student

    mobileApi.getNoticeBoardItems();
  • getOmissions – Retrieves student's absences within a specified date range

    mobileApi.getOmissions({
      startDate: 'YYYY-MM-DD',
      endDate: 'YYYY-MM-DD',
    });
  • getOmission – Retrieves absence details by its unique identifier

    mobileApi.getOmission('');
  • getRegistrationState – Checks if the guardian has registered

    mobileApi.getRegistrationState();
    • Returns: Promise<boolean>
  • getSchoolYearCalendar – Retrieves school year calendar entries

    mobileApi.getSchoolYearCalendar();
  • getStudent – Retrieves student's information

    mobileApi.getStudent();
  • getSubjectAverage – Retrieves subject averages for the student

    mobileApi.getSubjectAverage('');
  • getTeszekRegistration – Retrieves information regarding requested guardian devices

    mobileApi.getTeszekRegistration();
  • getTimeTableWeeks – Retrieves timetable week entries

    mobileApi.getTimeTableWeeks({
      startDate: 'YYYY-MM-DD',
      endDate: 'YYYY-MM-DD',
    });
  • getInstitution – Retrieves information about the institution

    mobileApi.getInstitution();
  • getDailyNotificationSummary – Retrieves a summary of daily notifications

    mobileApi.getDailyNotificationSummary();
  • 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:

    • 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();
  • getAddressableClasses – Retrieves addressable classes

    eAdminApi.getAddressableClasses('');
  • getAddressableGuardiansForClass – Retrieves addressable guardians for a class

    eAdminApi.getAddressableGuardiansForClass('');
  • getAddressableSzmkRepesentative – Retrieves addressable SZMK representative

    eAdminApi.getAddressableSzmkRepesentative();
  • getAddressableType – Retrieves addressable type

    eAdminApi.getAddressableType();
  • getAddresseeType – Retrieves addressee type

    eAdminApi.getAddresseeType();
  • getAdministrators – Retrieves administrators

    eAdminApi.getAdministrators();
  • getCase – Retrieves a case

    eAdminApi.getCase('');
  • getCaseTypes – Retrieves case types

    eAdminApi.getCaseTypes();
  • getCases – Retrieves cases

    eAdminApi.getCases(true);
  • getChildData – Retrieves child data

    eAdminApi.getChildData();
  • getClassMasters – Retrieves class masters

    eAdminApi.getClassMasters();
  • getCurrentInstitutionDetails – Retrieves current institution details

    eAdminApi.getCurrentInstitutionDetails();
  • getCurrentInstitutionModules – Retrieves current institution modules

    eAdminApi.getCurrentInstitutionModules();
    • Returns: Promise<Array<string>
  • getDirectors – Retrieves directors

    eAdminApi.getDirectors();
  • getMessage – Retrieves a message

    eAdminApi.getMessage('');
  • getMessageLimitations – Retrieves message limitations

    eAdminApi.getMessageLimitations();
  • getMessages – Retrieves messages

    eAdminApi.getMessages();
  • 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();
  • getSzmk – Retrieves SZMK

    eAdminApi.getSzmk();
  • getTeachers – Retrieves teachers

    eAdminApi.getTeachers();
  • getTmgiCaseTypes – Retrieves TMGI case types

    eAdminApi.getTmgiCaseTypes();
  • getUnreadMessagesCount – Retrieves unread messages count

    eAdminApi.getUnreadMessagesCount();
    • Returns: Promise<number>
  • readMessage – Reads a message

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

    • 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:

    • 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:

    • Params body:

      • isKuka – Is trash boolean
      • postaladaElemAzonositoLista – Mailbox item unique identifiers Array<number>
    • Returns: Promise<any>

NaploApiV3

  • getEvaluationMode – Retrieves evaluation mode

    naploApi.getEvaluationMode('');
  • getHomework – Retrieves homework

    naploApi.getHomework('');
  • postHomework – Posts homework

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

    • 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('');
  • postJustification – Posts justification

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

    • 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();
  • getNotes – Retrieves notes

    naploApi.getNotes();
  • 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('');
  • 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: '',
    });
  • deleteLogging – Deletes logging

    naploApi.deleteLogging('');
  • getStudentPresence – Retrieves student presence

    naploApi.getStudentPresence('');
  • getAnnouncedTests – Retrieves announced tests

    naploApi.getAnnouncedTests('', '');
  • getAnnouncedTest – Retrieves announced test

    naploApi.getAnnouncedTest('');
  • 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:

    • 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([]);
  • getSentenceBankItems – Retrieves sentence bank items

    naploApi.getSentenceBankItems('', '');
  • 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('');
  • getClassGroups – Retrieves class groups

    naploApi.getClassGroups();
  • 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:

    • 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();
  • getSettings – Retrieves settings

    naploApi.getSettings();
  • postSettings – Posts settings

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

    • Params body:

      • ElozoOranHianyzoAjanlasa – Previous lesson missing recommendation boolean
    • Returns: Promise<void>

  • getSubjectDivision – Retrieves subject division

    naploApi.getSubjectDivision();
  • 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!