https://github.com/davish/dalton-schedules

API wrapper for retrieving student and teacher schedules at the Dalton School.
https://github.com/davish/dalton-schedules

Last synced: 24 days ago
JSON representation

API wrapper for retrieving student and teacher schedules at the Dalton School.

• Host: GitHub
• URL: https://github.com/davish/dalton-schedules
• Owner: davish
• Created: 2015-11-26T22:11:33.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-12-09T03:01:54.000Z (about 9 years ago)
• Last Synced: 2024-10-15T07:45:54.812Z (2 months ago)
• Language: Python
• Size: 16.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dalton-schedules

API wrapper for retrieving student and teacher schedules at the Dalton School.

For many of the tests in `schedules.py`, a user and password from the Dalton system is necessary. Create a `credentials.py` file and declare two variables, `username` and `password`, whose values are your username and password. This is in the gitignore, and should not leave one's computer.

Install dependencies with `pip install -r requirements.txt`

## API

All `POST` method API endpoints require a JSON object as the request body. This object should contain `username` and `password` fields, unless otherwise specified. Malformed requests respond with a 400.

- `POST` `/info/`

  - Get information about a user. Returns their grade, full name, and whether they're a student or a teacher.

- `POST` `/schedule/my`

    - Get this week's schedule for the user whose credentials are passed in. Returns data in a JSON array of "event" objects of this general format:

    ```

{

    "date": "2015-11-24",

    "start": "2015-11-24 13:40:00", 

    "end": "2015-11-24 14:25:00", 

    "location": "612", 

    "course": {

        "course_name": "Math Class", 

        "instructor": {

          "id": "XXXX", 

          "name": "Mr. Schneebly"

        }, 

    "section_id": "1010-01"

    }

}

    ```

- `POST` `/faculty`

    - Returns an array of all faculty members. Example element:

    ```

    {

      "firstname": "Jim", 

      "fullname": "Jim Zulakis", 

      "id": "ZULJ", 

      "lastname": "Zulakis"

    }

    ```

- `POST` `/schedule/faculty/<_id>`

    - Retrieve the week's schedule for the faculty member whose ID is in the URL. Same format as a student's ID.

- `POST` `/schedule/compare//`

    - Returns the free times that these two people share this week.

    - The two parameters are faculty IDs. If either of the parameters is `me` instead of an ID, then the current student's ID will be used.

- `POST` `/verify`

  - Takes `username` and `password` as *FORM-ENCODED PARAMETERS*. Returns 401 for bad credentials, and 200 for good ones.