Skip to content
This repository has been archived by the owner on Jan 4, 2018. It is now read-only.

API Reference

Jump to bottom
Roy Meissner edited this page Oct 15, 2015 · 23 revisions

Information

  • get some default information about data sources --> not complete

curl -XGET http://localhost:8080/app/info

Academical Calendar

  • get information for the given semester{ss|ws}

curl -XGET http://localhost:8080/app/info/academical/{semester}

Staff

  • get information for ALL the staff/professors

curl -XGET http://localhost:8080/app/info/staff

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

curl -XGET http://localhost:8080/app/info/staff/{cuid}

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

curl -XGET http://localhost:8080/app/info/staff/{cuid}/pic

Buildings

  • get information for ALL buildings

curl -XGET http://localhost:8080/app/info/buildings

  • get information for a special building

curl -XGET http://localhost:8080/app/info/buildings/{id}

Sports

  • get information for ALL sport courses

curl -XGET http://localhost:8080/app/info/sport

  • get detailed information for a special sport course

curl -XGET http://localhost:8080/app/info/sport/{id}

  • get pic information for a special sport course

curl -XGET http://localhost:8080/app/info/sport/{id}/pic

News

  • get default rss feed collection (with feddIds)

curl -XGET http://localhost:8080/app/news

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

curl -XGET http://localhost:8080/app/news/get?feed={feedIds}<&offset={offset}&limit={limit}>

Mensa

  • get list of all canteens

curl -XGET http://localhost:8080/app/mensa

  • get menu for the current day

curl -XGET http://localhost:8080/app/mensa/{location}

  • get menu for the given day (yyyyMMdd)

curl -XGET http://localhost:8080/app/mensa/{location}/{date}

Timetable

  • get the calendar of the current semester

curl -XGET http://localhost:8080/app/timetable/cal

  • get all courses of the current semester (ws/ss)

curl -XGET http://localhost:8080/app/timetable/{semester}

  • get all courses for the requested faculty of the current semester (ws/ss)

curl -XGET http://localhost:8080/app/timetable/{semester}/{fac}

  • get the timetable for the requested SemGroup

curl -XGET http://localhost:8080/app/timetable/{semester}/{fac}/timetable?semgroup={semGroup}

  • get a list of all Subjects for the requested SemGroup

curl -XGET http://localhost:8080/app/timetable/{semester}/{fac}/courses?semgroup={semGroup}

  • get description for the requested Subject

curl -XGET http://localhost:8080/app/timetable/{semester}/{fac}/courses/{id}?semgroup={semGroup}

  • get the timetable for the requested SemGroup and calendar week

curl -XGET http://localhost:8080/app/timetable/{semester}/{fac}/week/{kw}?semgroup={semGroup}

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

curl -XGET http://localhost:8080/app/timetable/{semester}/{fac}/week/{kw}/{day}?semgroup={semGroup}

Authentication

  • get credentials and salt for MailBox and QIS

curl -XPOST http://localhost:8080/app/auth?username={username}&password={password}

  • get username & password from encryptedCredentials (for debugging only)

curl -XGET http://localhost:8080/app/auth?credentials={encryptedCredentials}<&salt={salt}>

QIS

  • get current marks and information from QIS

curl -XGET http://localhost:8080/app/qis/get?credentials={credentials}&salt={salt}

Mail

  • get the given range of mail {limit(default 10), offset(default=0)} mails

curl -XGET http://localhost:8080/app/mailbox/get?credentials={credentials}&salt={salt}&offset={offset}&limit={limit}

  • get the attachment of an email

curl -XGET http://localhost:8080/app/mailbox/get/{mailId}?attachmentName={attachmentName}&credentials={credentials}&salt={salt}

  • get a single email

curl -XGET http://localhost:8080/app/mailbox/get/{mailId}?credentials={credentials}&salt={salt}

  • get all new mails

curl -XGET http://localhost:8080/app/mailbox/get/new?credentials={credentials}&salt={salt}

  • set status read to the given mail

curl -XPOST http://localhost:8080/app/mailbox/status/{mailId}?credentials={credentials}&salt={salt}

  • send a new mail (cc optional)

curl -XPOST http://localhost:8080/app/mailbox/send?credentials={credentials}&salt={salt}&to={to[]}<&cc={cc[]}>&subject={subject}&message={message}&from={forename surname}

Rooms

  • get the distance between given location (lat,lng or address) and all listed buildings

curl -XGET http://localhost:8080/app/room/location?location={latlng|address}

the following requests are only possible, if the server has an IP inside the campus

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

curl -XGET http://localhost:8080/app/room/{semester}/{week}

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

curl -XGET http://localhost:8080/app/room/{semester}/{week}/{weekday}

Clone this wiki locally