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/v3/hyperplanning

Paramètres

  • urlstringrequis

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

  • detailstringoptionnel

    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

Exemple de requête

Requête
curl -X POST -d "url=https%3A%2F%2Fexample.com%2Ffile.ics&detail=full" "https://api.moxon.dev/v3/hyperplanning"

Réponse

Réponse
[
    {
        "summary": ["Mathematics", "DOE", "Class", "1", "Class", "2"],
        "subject": "Mathematics",
        "teacher": "DOE",
        "classes": ["Class 1", "Class 2"],
        "start": "2000-03-01T12:00:00.000",
        "end": "2000-03-01T14:00:00.000"
    }
]

Champs de réponse

ChampDescription
summaryTableau des éléments du résumé
subjectNom de la matière
teacherNom de l'enseignant
classesTableau des noms de classes
startHeure de début de l'événement (ISO 8601)
endHeure de fin de l'événement (ISO 8601)

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