search

monashcoding / TheBetterHandbookAPI

The definitive Monash handbook API.
MIT License
4 stars 0 forks source link

readme

TheBetterHandbookAPI

The definitive Monash handbook API.

Using the handbook API

To request the Monash handbook from the URL https://handbook.monash.edu/api/es/search (POST) send the following JSON:

{
            "query": {
                "bool": {
                    "must": [
                        {"query_string": {"query": f"monash2_psubject.code: {content}"}},
                        {"term": {"live": True}},
                    ]
                }
            },
            "aggs": {
                "implementationYear": {
                    "terms": {
                        "field": "monash2_psubject.implementationYear_dotraw",
                        "size": 100
                    }
                },
                "availableInYears": {
                    "terms": {"field": "monash2_psubject.availableInYears_dotraw", "size": 100}
                },
            },
            "size": 100,
            "_source": {
                "includes": ["versionNumber", "availableInYears", "implementationYear"]
            },
}

Note that replacing monash2 with unsw will let you request UNSW units. Additionally, content should be a unit code. This API for querying hasn't been documented properly, and there are likely many filters etc. There is also a request that can return all 5282 or so Monash units below:

{
    "query": {
        "bool": {
            "must": [
                {"term": {"live": True}},
                [
                    {
                        "bool": {
                            "minimum_should_match": "100%",
                            "should": [
                                {
                                    "query_string": {
                                        "fields": [
                                            "monash2_psubject.implementationYear"
                                        ],
                                        "query": f"*{year}*",
                                    }
                                }
                            ],
                        }
                    }
                ],
            ],
            "filter": [{"terms": {"contenttype": ["monash2_psubject"]}}],
        }
    },
    "sort": [{"monash2_psubject.code_dotraw": {"order": "asc"}}],
    "from": start,
    "size": size,
    "track_scores": True,
    "_source": {
        "includes": [
            "*.code",
            "*.name",
            "*.award_titles",
            "*.keywords",
            "urlmap",
            "contenttype",
        ],
        "excludes": ["", None],
    },
}

Using the MonPlan API

MonPlan POSTs a request to https://mscv.apps.monash.edu with a course plan in JSON format. You can send up to 125 units in one request before it will fail:

{
"startYear": 2022,
"advancedStanding": [

],
"internationalStudent": False,
"courseInfo": {

},
"teachingPeriods": [
    {
        "year": 2022,
        "code": "S1-01",
        "units": [
                {
                    "unitCode": unit_code,
                    "placeholder": False
                } for unit_code in units
        ],
        "intermission": False,
        "studyAbroad": False
    }
]
}

Here units is a list of unit codes.

Collating all data

To collate all data into a .json file run the following:

python -m src.data_processing.collate_handbook_data

This process will take 2-3 minutes.

TODO