Skip to content
This repository was archived by the owner on May 22, 2018. It is now read-only.

Server API

Jump to bottom
Roy Meissner edited this page May 12, 2015 · 2 revisions

Server-Base-Adress

base: https://htwk-app.imn.htwk-leipzig.de

Academical Calendar

  • get a calendar for the given semester

curl -XGET *base*/info/academical/{ss|ws}

Staff

  • get all staff/professors

curl -XGET *base*/info/staff

  • get detailed information for a special staff-member/professor

curl -XGET *base*/info/staff/{cuid}

  • get picture information for a special staff-member/professor

curl -XGET *base*/info/staff/{cuid}/pic

Buildings - from Scala Buildings Microservice

  • get all buildings

curl -XGET *base*/info/building

  • get information for a special building

curl -XGET *base*/info/building/{id}

Sports

  • get all sport courses

curl -XGET *base*/info/sport

  • get detailed information for a special sport course

curl -XGET *base*/info/sport/{id}

  • get the picture for a special sport course

curl -XGET *base*/info/sport/{id}/pic

News

  • get default rss feed collection (with feddIds)

curl -XGET *base*/news

  • get default rss feed by feedId (optional parameter: offset (Int), limit (Int))

curl -XGET *base*/news/get?feed={feedId}<&offset={offset}&limit={limit}>

Mensa

  • get list of all canteens

curl -XGET *base*/mensa

  • get menu for today

curl -XGET *base*/mensa/{mensaID}

  • get menu for the given day (yyyyMMdd)

curl -XGET *base*/mensa/{mensaID}/{date}

Timetable

  • get the calendar of the current semester

curl -XGET *base*/timetable/cal

  • get all courses of the current semester

curl -XGET *base*/timetable/{ws|ss}

  • get all courses for the requested faculty of the current semester

curl -XGET *base*/timetable/{ws|ss}/{fac}

  • get the timetable for the requested SemGroup

curl -XGET *base*/timetable/{ws|ss}/{fac}/timetable?semgroup={semGroup}

  • get a list of all Subjects for the requested SemGroup

curl -XGET *base*/timetable/{ws|ss}/{fac}/courses?semgroup={semGroup}

  • get description for the requested Subject

curl -XGET *base*/timetable/{ws|ss}/{fac}/courses/{id}?semgroup={semGroup}

  • get the timetable for the requested SemGroup and calendar week

curl -XGET *base*/timetable/{ws|ss}/{fac}/week/{kw}?semgroup={semGroup}

  • get the timetable for the requested SemGroup, calendar week and day (0 = Mo, 6=Su)

curl -XGET *base*/timetable/{ws|ss}/{fac}/week/{kw}/{day}?semgroup={semGroup}

Authentication

  • get credentials and salt (required by MailBox and QIS)

curl -XPOST *base*/auth?username={username}&password={password}

QIS

  • get current grades and some informations from QIS

curl -XGET *base*/qis/get?credentials={credentials}&salt={salt}

Mail

  • get the given range of mail {limit (Int) (defaults to 10), offset (Int) (defaults to 0)} mails

curl -XGET *base*/mailbox/get?credentials={credentials}&salt={salt}&offset={offset}&limit={limit}

  • get the attachment of an email

curl -XGET *base*/mailbox/get/{mailId}?attachmentName={attachmentName}&credentials={credentials}&salt={salt}

  • get a single email

curl -XGET *base*/mailbox/get/{mailId}?credentials={credentials}&salt={salt}

  • get all new mails

curl -XGET *base*/mailbox/get/new?credentials={credentials}&salt={salt}

  • set status read to the given mail

curl -XPOST *base*/mailbox/status/{mailId}?credentials={credentials}&salt={salt}

  • send an email (cc optional)

curl -XPOST *base*/mailbox/send?credentials={credentials}&salt={salt}&to={to[]}<&cc={cc[]}>&subject={subject}&message={message}&from={forename surname}

Rooms

  • get the distance between the given location (latlng (XX.xx,YY.yy) or address) and all listed buildings

curl -XGET *base*/room/location?location={latlng|address}

  • get all empty rooms for the given semester and week (todays weekday)

curl -XGET *base*/room/{semester}/{week}

  • get all empty rooms for the given semester, week and weekday (Mo=1 to Sun=7)

curl -XGET *base*/room/{semester}/{week}/{weekday}

Weather

  • get the forecast for the given location (latlng (XX.xx,YY.yy) or address) and (if configured) customIcons (default=false)

curl -XGET *base*/weather?location={latlng|address}<&customIcons=true>

Clone this wiki locally