npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@philippdormann/elternportal-api

v2.9.0

Published

unofficial art soft and more Elternportal-API

Downloads

28

Readme

ElternPortal API Client 📚

This library provides an easy-to-use interface for interacting with the ElternPortal system, a platform for school-parent communication in Germany.

Features 🌟

  • Authentication: Securely log in to the ElternPortal system
  • Kid Management: Set and retrieve information about children linked to the account
  • School Information: Fetch various details about the school
  • Announcements: Get updates from the school's bulletin board (Schwarzes Brett)
  • Calendar: Retrieve school events and schedules
  • Parent Letters: Access and download parent letters (Elternbriefe)
  • Lost and Found: View items in the lost and found section

Installation 💻

pnpm i @philippdormann/elternportal-api

Usage 🚀

Initializing the Client

import { getElternportalClient } from "@philippdormann/elternportal-api";

const client = await getElternportalClient({
  short: "schoolcode",
  username: "your_username",
  password: "your_password",
  kidId: 0, // Optional
});

Available Methods

Get Kids 👨‍👩‍👧‍👦

const kids = await client.getKids();

Get School Information 🏫

const schoolInfo = await client.getSchoolInfos();

Get Bulletin Board (Schwarzes Brett) 📌

const posts = await client.getSchwarzesBrett(includeArchived);

Get School Calendar (Termine) 📅

const events = await client.getTermine(fromDate, toDate);

Get Timetable 🕒

const timetable = await client.getStundenplan();

Get Lost and Found Items 🧦

const lostItems = await client.getFundsachen();

Get Parent Letters 📬

const letters = await client.getElternbriefe();

Download Files 📁

const bulletinFile = await client.getSchwarzesBrettFile(fileId);
const letterFile = await client.getElternbrief(letterId);

Types 📝

The library includes TypeScript definitions for various data structures:

  • SchoolInfo
  • Termin (Calendar Event)
  • Elternbrief (Parent Letter)
  • SchwarzesBrettBox (Bulletin Board Item)
  • ElternportalFile