API Reference
IPR

/ipr

Base API URL

The base URL for the API endpoint to retrieve the In-Progress Report (IPR) information is:

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

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 IPR information.

Example API Request

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

GET https://homeaccesscenterapi.vercel.app/api/ipr?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 IPR information:

{
    "headers": [
        "Course",
        "Description",
        "Period",
        "Teacher",
        "Room",
        "PRG",
        "COM1",
        "COM2",
        "COM3",
        "COM4",
        "COM5"
    ],
    "data": [
        [
        "2013A - 1",
        "COMP SCI IND KAP A",
        "1",
        "Nutt, Ryan",
        "2253",
        "100",
        "",
        "",
        "",
        "",
        ""
        ],
    ]
}

The response includes the following details:

  • headers: An array containing the column headers for the IPR data.
  • data: An array containing the IPR data for each course, with each element representing a row of information.

By following these guidelines, you can make API requests to retrieve the In-Progress Report (IPR) 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.

TranscriptReportCard