Librus Rest

by Mati365

GitHub Readme.md

librus-rest

Advanced node.js Librus REST server (http://synergia.librus.pl/). JS API: Librus API repo

Usage

You must add 'key' field to every URL of request(except POST /authorize).

Route /user

Calendar
  • GET /timetable?from=&to=
  • GET /announcements
  • GET /absence/:id?
Inbox
  • GET /receivers?group=
  • PUT /message Request body: user, title, content
  • GET /message/:folder/:message
  • GET /folder/:folder/:page?
  • DELETE /message/:messageId
Homework
  • GET /subjects
  • GET /homework/list/:subjectId?
  • GET /homework/:id
User Info
  • GET /grades/:id?
  • GET /notifications

Running locally

Terminal:

node lib/server.js

or

node ./

Deploying on Heroku

You can deploy your own copy of the app using the web-based flow:
Deploy

License

The MIT License (MIT)

Copyright (c) 2015/2016 Mateusz Bagiński Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.