Hyperplanning

Deprecated

The /hyperplanning endpoint allows you to display a Hyperplanning schedule information in JSON format from an ICS (calendar) file.

posthttps://api.moxon.dev/v6/hyperplanning

Deprecated

This endpoint is deprecated. It still answers on every version, but v6 no longer lists it among its available endpoints, and it will be removed for good in 7.0.0. Do not build anything new on it.

Parameters

urlstringrequired
The URL of the ICS file to use and display. Must be URL-encoded before being sent
detailstringoptional
Level of detail for events (full or list)

Detail Options

Option	Description
`full`	Displays a complete summary with subject, teacher, classes, date, etc.
`list`	Displays all data in a list

Code Examples

curl -X POST \  "https://api.moxon.dev/v6/hyperplanning" \  -H "Content-Type: application/json" \  -d '{    "url": "https%3A%2F%2Fexample.com%2Ffile.ics",    "detail": "full"  }'

Response Fields

The response format depends on the detail parameter:

`detail=full`

summarystring[]
Array of summary elements
subjectstring
Subject name
teacherstring
Teacher name
classesstring[]
Array of class names
typestring
Event type
startstring
Event start time (ISO 8601)
endstring
Event end time (ISO 8601)

`detail=list`

summarystring[]
Array of summary elements
startstring
Event start time (ISO 8601)
endstring
Event end time (ISO 8601)

Default (no `detail` parameter)

summarystring
Event summary
startstring
Event start time (ISO 8601)
endstring
Event end time (ISO 8601)

Error Handling

If parameters are missing or invalid, the API will return an error:

400Please provide a valid ICS file URL (?url={URL})The url parameter is missing or invalid

Edit this page on GitHub Report an issue

Last updated on September 13, 2026