JNTUH Results - SERVICE API Documentation

About

This project aims to provide students of JNTUH University with an efficient way of accessing their own semester results as well as those of their classmates. With just a single click, students will be able to view their academic performance throughout the semesters.

Authentication

The API currently does not require any form of authentication. Make a request with a hall ticket, it will provide the response.

API Endpoints

1. Get Student Results

Endpoint: /api/academicresult

Method: GET

Description: Retrieves the semester results for a specific student.

Parameters:

Example Request:

GET /api/academicresult?htno=18E51A0479
            

2. Get Student All Individual Exam Results

Endpoint: /api/academicallresult

Method: GET

Description: Retrieves the semester results for a specific student.

Parameters:

Example Request:

GET /api/academicallresult?htno=18E51A0479
            

3. Get Classmates Results

Endpoint: /api/classresult

Method: GET

Description: Retrieves the semester results for all the classmates of a specific student.

Parameters:

Example Request:

GET /api/classresult?semester=1-1&htnos=18E51A0479,18E51A0...
            

4. Notifications

Endpoint: /api/notifications

Method: GET

Description: Retrieves all the latest notifications of JNTUH.

Example Request:

                GET /api/notifications
            

Error Handling

The API follows standard HTTP error status codes. In case of an error, an appropriate error code will be returned along with a response containing an error message.

Example Error Response:

HTTP/1.1 500
Content-Type: application/json

{
  "error": "500 - Internal Server Error"
}