OwlBook Server

The unoffical API for the University of Western OWL service written in Node.js.

How to Setup

The required modules are listed below.

• async
• cookie-parser
• express
• osmosis

Once the modules are all set up, simply run the server.js and the rest will be taken care of.

node server.js

How to Use

GET /api/student/validate

Used to validate a student account.

Parameters

{header} eid // Student ID.
{header} pw // Student password.

Returns a student JSON Object if the account exists.

    {
      "id": ""
      "pass": "",
      "cookies": {
          "JSESSIONID": "",
          "NSC_pxm.vxp.db--443": ""
      },
      "course_url": ""
    }

Returns an error if the account does not exist: INVALID CREDENTIALS

---

GET /api/courses?url=

Used to fetch an array of course objects based on the query url.

Parameters

{query} url // course_url.
{cookie} JESSIONID // Western OWL Session ID.
{cookie} NSC_pxm.vxp.db--443 // Western OWL Encryption Key.

Returns a JSON array of course objects if successful.

[
    {
        "title": "",
        "teacher": "",
        "section": "",
        "home_url": "",
        "grades_url": ""
    }
]

---

GET /api/courses/assignments?url=

Used to getch an array of assignment objects based on the query url.

Parameters

{query} url // grades_url.
{cookie} JESSIONID // Western OWL Session ID.
{cookie} NSC_pxm.vxp.db--443 // Western OWL Encryption Key.

Returns a JSON array of assignment objects if successful.

[
    {
        "title": "",
        "due_date": "",
        "grade": "",
        "comments": ""
    }
]

---

GET /api/student/full

Returns a full student object (student information, courses, and assignments).

Parameters

{header} eid // Student ID.
{header} pw // Student password.

Returns a full JSON student object if successful.

{
    "id": "",
    "password": "",
    "cookies": {
        "JSESSIONID": "",
        "NSC_pxm.vxp.db--443": ""
    },
    "courses_url": "",
    "courses": [
        {
            "title": "",
            "teacher": "",
            "section": "",
            "home_url": "",
            "grades_url": "",
            "assignments": [
                {
                    "title": "",
                    "due_date": "",
                    "grade": "",
                    "comments": ""
                }
            ]
        }
    ]
}