API Reference
ReportCard

/reportcard

Base API URL

The base URL for the API endpoint to retrieve the report card information is:

https://homeaccesscenterapi.vercel.app/api/reportcard

Headers

To make a successful API request, you need to include the following headers in your request:

{
    "link": "Link to HAC",
    "user": "HAC username",
    "pass": "HAC password",
}
  • link : The link to the Home Access Center (HAC) website.
  • user (required): Your HAC username.
  • pass (required): Your HAC password.

Note: The user and pass headers are required for authentication and accessing the report card information.

Example API Request

To retrieve the report card information, send a GET request to the API endpoint with the required headers as query parameters:

GET https://homeaccesscenterapi.vercel.app/api/reportcard?link=https://homeaccess.katyisd.org/&user=D1234567&pass=Doe1234

Replace the values in the query parameters (link, user, and pass) with the actual URL to the HAC website, your HAC username, and your HAC password respectively.

Example API Response

A successful API response will be in JSON format and will include the following report card information:

{
    "headers": [
        "Course",
        "Description",
        "Period",
        "Teacher",
        "Room",
        "1st",
        "2nd",
        "3rd",
        "Exam1",
        "Sem1",
        "4th",
        "5th",
        "6th",
        "Exam2",
        "Sem2",
        "CND1",
        "CND2",
        "CND3",
        "CND4",
        "CND5",
        "CND6"
    ],
    "data": [
        [
        "2013A - 1",
        "COMP SCI IND KAP A",
        "1",
        "Nutt, Ryan",
        "2253",
        "100",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "",
        "S",
        "",
        "",
        "",
        "",
        ""
        ],
    ]
}

The response includes the following details:

  • headers: An array of column headers that describe the information in each column of the report card.
  • data: An array containing the report card data, with each element representing a row of data.\

By following these guidelines, you can make API requests to retrieve the report card information from the HomeaccessCenterAPI. Make sure to include the required headers with valid values for authentication, and replace the placeholders with actual values in your requests and responses.

IPRAssignments