Skip to content
moxon home

Hyperplanning

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

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

Deprecated in 6.0.0

This endpoint is deprecated. It still answers here and on v6, but v6 no longer lists it among its available endpoints, and it will be removed for good in 7.0.0. Plan your migration now — see the 6.0.0 changelog.

Try itpost/v5/hyperplanning
curl -X POST \  "https://api.moxon.dev/v5/hyperplanning" \  -H "Content-Type: application/json" \  -d '{}'

Send the request to see the response here.

Parameters

  • urlstringrequired

    The URL of the ICS file to use and display. Must be URL-encoded before being sent

  • detail"full" | "list"optional

    Level of detail for events (full or list)

Detail Options

OptionDescription
fullDisplays a complete summary with subject, teacher, classes, date, etc.
listDisplays all data in a list

Code Examples

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 GitHubReport an issue

Last updated on September 13, 2026