Aller au contenu
Accueil moxon

Hyperplanning

L'endpoint /hyperplanning permet d'afficher les informations d'un emploi du temps Hyperplanning au format JSON à partir d'un fichier ICS (calendrier).

posthttps://api.moxon.dev/v4/hyperplanning
Essayerpost/v4/hyperplanning

Paramètres

  • urlstringrequis

    L'URL du fichier ICS à utiliser et afficher. Doit être encodée en URL avant l'envoi

  • detail"full" | "list"optionnel

    Niveau de détail pour les événements (full ou list)

Options de détail

OptionDescription
fullAffiche un résumé complet avec matière, enseignant, classes, date, etc.
listAffiche toutes les données sous forme de liste

Exemples de code

Champs de réponse

Les champs retournés dépendent de l'option detail choisie.

Mode full

  • summarystring[]

    Tableau des éléments du résumé

  • subjectstring

    Nom de la matière

  • teacherstring

    Nom de l'enseignant

  • classesstring[]

    Tableau des noms de classes

  • startstring

    Heure de début de l'événement (ISO 8601)

  • endstring

    Heure de fin de l'événement (ISO 8601)

Mode list

Retourne un tableau de toutes les données brutes de chaque événement.

Mode par défaut (sans detail)

Retourne un tableau d'objets résumé avec les champs summary, start et end.

Gestion des erreurs

Si les paramètres sont manquants ou invalides, l'API retournera une erreur :

  • 400Please provide a valid ICS file URL (?url={URL})Le paramètre url est manquant ou invalide