Udom Ratiba API

Overview

Udom Ratiba API is a custom-made Flask application hosted on Vercel. It functions as a robust API, facilitating the extraction of schedule information from the University of Dodoma (Udom) Ratiba portal through web scraping. Developers are encouraged to leverage this API to seamlessly integrate Udom's schedule data into their applications and programs.

API Base URL
API Endpoints
How to Use
Error Handling
Server Settings
Author
Collaborate
License

API Base URL

https://udom-ratiba-api.vercel.app/

API Endpoints

1. Get Categories

Endpoint: /get/category
Method: GET ( https://udom-ratiba-api.vercel.app/get/category )
Description: You can check the types of the timetable available. When you fetch the data,most of the time you will only see Teaching, this is because there are two categories Teaching and Examination, that is because the examination season is not yet nearer and the api is fetching real time data.
The sample output of the request

{
  "code": 200,
  "data": {
    "1": "Teaching"
  },
  "status": "success"
}

2. Get Options

Endpoint: /get/option
Method: GET ( https://udom-ratiba-api.vercel.app/get/option )
Description: Here you can see all the available options for the later fetching of the API. Your timetable can be categorized by either coarse,programme,venue and so on.. ,
Sample output

{
  "code": 200,
  "data": {
    "course": "By Course ",
    "instructor": "By Instructor",
    "programme": "By Programme ",
    "room": "By Venue "
  },
  "status": "success"
}

3. Get Programs

Endpoint: /get/programme
Method: GET ( https://udom-ratiba-api.vercel.app/get/programme )
Description: This is very important, here you can see all the programmes with the appropiate code of each programme, It is crutual to know the code of the programme you want to fetch, because with that code you can fetch the timetable in the following steps..
sample output

{
  "code": 200,
  "data": {
    "9763": "BAENGLISH3 - CHSS",
    "9764": "BATI3 - CHSS",
    "9765": "BAARCA1 - CHSS",
    "9766": "BACHT1 - CHSS",
    ...
    ...
    ....
    "10096": "N4 - SNPH & SMD",
    "10097": "MSCAC&FIN(EV)2 - CoBE",
    "10098": "HIS2 - SNPH & SMD",
    "10325": "MDPS1 - CHSS"
  },
  "status": "success"
}

4. Get Schedule Table

Endpoint: /api
Method: POST/GET
Form Data:
- option: Option value
- programme: Program value
Description: Retrieve a schedule table based on the selected option and program. Remember that currently we're
sample request

import requests
url = 'https://udom-ratiba-api.vercel.app/api'
data = {
            'option': 'programme',
            'programme': '9986' # This is the code of the programme ( basically CSDFE2 )
}
response = requests.post(url, data=data)

print(response.text)

sample output

{
  "code": 200,
  "data": {
    "monday": [
      {
        "coarse": "IA 212  - Lecture",
        "end_time": "09:30",
        "staff": "Dr. Daniel Ngondya",
        "start_time": "07:30",
        "students": "CSDFE2",
        "venue": "LRB 004D"
      },
      {
        "coarse": "CP 211 D - Lecture",
        "end_time": "11:30",
        "staff": "Mr. Justin Woiso",
        "start_time": "09:30",
        "students": "CSDFE2",
        "venue": "LRA 019"
      },
      {
        "coarse": "CP 212 H - Tutorial",
        "end_time": "12:30",
        "staff": "Dr. Mustapha Mohsin",
        "start_time": "11:30",
        "students": "CSDFE2, BIS2",
        "venue": "LRB 002A"
      },
      {
        "coarse": "CP 215 E - Lecture",
        "end_time": "17:30",
        "staff": "Mr. Everyjustus Barongo",
        "start_time": "15:30",
        "students": "CSDFE2",
        "venue": "LRB 101"
      },
      {
        "coarse": "CP 215 E - Tutorial",
        "end_time": "18:30",
        "staff": "Mr. Everyjustus Barongo",
        "start_time": "17:30",
        "students": "CSDFE2",
        "venue": "LRA 018"
      }
    ],

    ...
    ...
    ...

    "friday": [
      {
        "coarse": "CP 212 H - Lecture",
        "end_time": "11:30",
        "staff": "Dr. Mustapha Mohsin",
        "start_time": "09:30",
        "students": "CSDFE2, BIS2",
        "venue": "LRB 103"
      },
      {
        "coarse": "IA 212  - Tutorial",
        "end_time": "13:30",
        "staff": "Dr. Daniel Ngondya",
        "start_time": "12:30",
        "students": "CSDFE2",
        "venue": "FL1 (CIVE)"
      }
    ],

  },
  "status": "success",
  "title": "CSDFE2 - TEACHING Timetable"
}

How to Use

Developers can integrate this API into their applications to access Udom Ratiba schedule data for various purposes, including but not limited to:

Building schedule management applications
Creating academic tools and resources
Developing customized schedule widgets for websites

Error Handling

The application employs a robust error-handling mechanism, providing a structured JSON response with status and code for any encountered errors during API interactions.

For intensive error handling,see the official documentation udom-api.

Server Settings

The application is effortlessly hosted on Vercel, eliminating the need for a separate server setup. Developers can seamlessly access and utilize the API without the hassle of intricate server configurations.

The API endpoint is handled with indifinite care..

Author

This project is currently developed and maintained by masterplan.

Collaborate

You are warmly welcome to contribute!. If you added a feature to this API why you keep it with yourself, just share it.(◕‿◕)

License

This project is licensed under the MIT License. Feel free to explore and adapt the codebase to meet your specific requirements.

isaka-james / UDOM-RATIBA-API