EcoleDirecte Api - Documentation

{
  "evenements": [], // ?
  "postits": Array<{
    "id": number,
    "type": string, // "info", ?
    "contenu": string // HTML encodé en base64
    "dateCreation": "JJ/MM/AAAA",
    "dateDebut": "JJ/MM/AAAA",
    "dateFin": "JJ/MM/AAAA",
    "cible": [], // ?
    "ciblesEtab": [], // ?
    "auteur": {
      "civilite": string, // M.
      "prenom": string,
      "particule": string,
      "nom": string,
      "type": string, // "A", ?
      "id": string, // Identifiant de la personne
    },
  }>,
}

{
  "AAAA-MM-JJ": Array<{
    matiere: string, // Nom d'affichage ("FRANCAIS" / "ENSEIGN.SCIENTIFIQUE")
    codeMatiere: string, // Code ("FRANC" / "G-SCI")
    aFaire: true, // ?
    idDevoir: number,
    documentsAFaire: false, // ?
    donneLe: "AAAA-MM-JJ",
    effectue: bool, // Si marqué par l'élève comme tel ?
    interrogation: bool,
    rendreEnLigne: bool, // Si présence d'un formulaire pour rendre un fichier ?
  }>,
}

{
  date: "AAAA-MM-JJ", // Même date que celle passée dans l'URL
  matieres: Array<{
    entityCode: string, // Classe ("1A") / groupe
    entityLibelle: string, // Nom d'affichage de la classe ("PREMIERE A")
    entityType: "C" | "G" | string, // C = Classe, G = Groupe, ...
    matiere: string,
    codeMatiere: string, // Pareils que route précédente
    nomProf: string,
    id: number, // Même id que idDevoir dans la route précédente
    interrogation: bool,
    blogActif: false, // ?
    nbJourMaxRenduDevoir: number, // Date butoir du rendu ?
    aFaire: {
      idDevoir: number,
      contenu: string, // Détail du travail à faire
      rendreEnLigne: bool,
      donneLe: "AAAA-MM-JJ",
      effectue: bool,
      ressource: "", // ?, vide jusqu'ici
      ressourceDocuments: [], // ?, vide jusqu'ici
      documents: Array<{ // Pièces jointes
        id: number, // Pour la télécharger via la route de téléchargement
        libelle: string, // Nom
        date: "AAAA-MM-JJ",
        taille: number, // En octets
        type: "FICHIER_CDT", // Autres valeurs ?
        signatureDemandee: false, // ?
        signature: {}, // ?
      }>,
      commentaires: Array<{
        id: number, // identifiant du commentaire
        idAuteur: number, // identifiant de l'auteur
        profilAuteur: "E", // E = Elève, autres valeurs ?
        auteur: string, // Nom de l'auteur
        date: "AAAA-MM-JJ",
        message: string, // Encodé en base64
        supprime: false, // Si le commentaire a été supprimé ? (semble stupide)
      }>,
      elementsProg: [], // ?
      liensManuel: [], // URL des manuels associés à la matière ?
      documentsRendus: [], // Fichiers rendus lorsque le formulaire est présent ?
      contenuDeSeance: {
        contenu: string,
        documents: [],
        commentaires: [],
      },
    },
    contenuDeSeance: {
      idDevoir: number, // Systématiquement le même identifiant que id plus haut
      contenu: string,
      documents: [], // Pièces jointes ?
      commentaires: [], // Même structure que commentaires sur travail à faire ?
      elementsProg: [],
      liensManuel: [],
    },
  }>
}

{
  idDevoirsEffectues: number[],
  idDevoirsNonEffectues: number[],
}

{
  message: string, // encodé en base64
  idContenu: number, // identifiant du devoir / contenu de séance
}

{
  id: number, // Identifiant du commentaire posté
}

{
  factures: [], // ?
  notes: Array<Document>,
  viescolaire: [], // ?
  administratifs: Array<Document>,
  inscriptions?: [], // ?
  listesPiecesAVerser: {
    listePieces: [], // ?
    personnes: Array<{id: 1234, nom: "…", prenom: "…", type: "E"}>,
    pieces: [], // ?
    televersements: [] // ?
  }
}

type Document = {
  id: number,
  libelle: string,
  idEleve: number,
  date: "AAAA-MM-JJ",
  type: "Note" | "Doc" | "",
  signatureDemandee: bool, // ?
  signature: {}
}

{
  "anneeScolaire": "",
}

{
  foStat: string, // Une sorte d'identifiant bizarre
  periodes: Array<{
    idPeriode: "A001" | "A002" | "A003" | "A999Z",
    codePeriode: "A001" | "A002" | "A003" | "A999Z",
    periode: "1er Trimestre" | "2ème Trimestre" | "3ème Trimestre" | "Année",
    annuel: bool, // false pour A001..A003, true pour A999Z
    dateDebut: "AAAA-MM-JJ",
    dateFin: "AAAA-MM-JJ",
    examenBlanc: false,
    cloture: bool, // true si la période est terminée, sinon false (cloturée)
    dateConseil?: "AAAA-MM-JJ", // Présent pour les trimestres
    heureConseil?: "HH:MM",
    heureFinConseil?: "HH:MM",
    moyNbreJoursApresConseil: 0, // moyenne du nombre de jours après le conseil, mais quels jours ?
    ensembleMatieres: {
      dateCalcul: "AAAA-MM-JJ HH:MM",
      moyenneGenerale: "XX,YY", // C'est-à-dire une chaîne de caractère qui contient un nombre à virgule
      moyenneClasse: "XX,YY",
      moyenneMin: "XX,YY",
      moyenneMax: "XX,YY",
      nomPP: string, // Prof principal
      nomCE: "", // ?
      decisionDuConseil: "", // Probablement une fonctionnalité de bulletin en ligne
      disciplines: Array<{
        id: number,
        codeMatiere: string,
        codeSousMatiere: "",
        discipline: string, // = matière
        moyenne: "XX,YY",
        moyenneClasse: "XX,YY",
        moyenneMin: "XX,YY",
        moyenneMax: "XX,YY",
        coef: 1,
        effectif: number, // Nombre de notes dans la moyenne ?
        rang: number, // Rang de l'élève dans la classe ?
        groupeMatiere: false,
        idGroupeMatiere: 0,
        option: 0,
        sousMatiere: false,
        saisieAppreciationSSMAT: false,
        professeurs: Array<{ id: number, nom: string }>,
      }>,
      disciplinesSimulation: [],
    },
  }>,
  notes: Array<{
    id: number, // Identifiant de la note j'imagine
    devoir: string, // Nom du contrôle
    codePeriode: "A001" | "A002" | "A003",
    codeMatiere: string, // Nom abbrégé
    libelleMatiere: string, // Nom de la matière
    codeSousMatiere: "",
    typeDevoir: "CONTROLE" | "INTERROGATION ORALE" | "TRAVAUX PRATIQUES" | "DEVOIR SUR TABLE" | "INTERROGATION ECRITE" | "EXERCICE" | "ENSEIGNEMENTS PRATIQUES DISCIPLINAIRES" | "DEVOIR MAISON", // Probablement pas renseigné par le professeur donc liste probablement fixe
    enLettre: false,
    commentaire: string, // Probablement un truc écrit par le prof
    uncSujet: "", // UNC = chemin de fichier, probablement un lien vers le fichier sujet / corrigé
    uncCorrige: "",
    coef: "XX.YY",
    noteSur: "XX,YY",
    valeur: "XX,YY", // Note, enfin
    nonSignificatif: bool,
    date: "AAAA-MM-JJ", // Date du contrôle
    dateSaisie: "AAAA-MM-JJ", // Date de l'ajout de la note, souvent les deux sont égaux (mais pas trjs)
    valeurisee: false, // ?
    moyenneClasse: "XX.YY",
    minClasse: "XX.YY",
    maxClasse: "XX.YY",
    elementsProgramme: [], // Liste de compétences ou qqch du genre j'imagine
  }>,
  parametrage: { // Différents paramètres d'affichage, de ce qui s'affiche ou non
    couleurEval1: "#FF0000", // Couleurs des compétences
    couleurEval2: "#FFC000",
    couleurEval3: "#0070C0",
    couleurEval4: "#00B050",
    libelleEval1: "Tm9uIGF0dGVpbnRz", // Non atteints (base64)
    libelleEval2: "UGFydGllbGxlbWVudCBhdHRlaW50cw==", // Partiellement atteints
    libelleEval3: "QXR0ZWludHM=", // Atteints
    libelleEval4: "RMOpcGFzc8Opcw==", // Dépassés
    affichageMoyenne: true,
    affichageMoyenneDevoir: true,
    affichagePositionMatiere: false,
    affichageNote: true,
    affichageCompetence: false,
    affichageEvaluationsComposantes: false,
    affichageGraphiquesComposantes: true,
    modeCalculGraphiquesComposantes: "eval",
    affichageCompNum: false,
    libelleEvalCompNum1: "Tm9uIGF0dGVpbnQ=", // Non atteint
    libelleEvalCompNum2: "UGFydGllbGxlbWVudCBhdHRlaW50", // Partiellement atteint
    libelleEvalCompNum3: "QXR0ZWludA==", // Atteint
    affichageAppreciation: false,
    appreciationsProf: false,
    appreciationProfPrinc: false,
    affichageMention: false,
    affichageAppreciationCE: false,
    affichageAppreciationVS: false,
    affichageAppreciationCN: false,
    affichageAppreciationClasse: false,
    affichageAppreciationPeriodeCloturee: false,
    moyenneUniquementPeriodeCloture: false,
    moyennePeriodeReleve: true,
    moyennePeriodeAnnuelle: true,
    moyennePeriodeHorsP: true,
    moyenneEleveDansNotes: true,
    moyenneEleve: true,
    moyenneEleveDansMoyenne: true,
    moyenneGenerale: true,
    moyenneCoefMatiere: true,
    moyenneClasse: true,
    moyenneMin: true,
    moyenneMax: true,
    moyenneRang: false,
    moyenneSur: 20,
    moyenneGraphique: true,
    moyennesSimulation: false,
    coefficientNote: true,
    colonneCoefficientMatiere: true,
    noteGrasSousMoyenne: false,
    noteGrasAudessusMoyenne: false,
    libelleDevoir: true,
    dateDevoir: true,
    typeDevoir: true,
    noteUniquementPeriodeCloture: false,
    notePeriodeReleve: false,
    notePeriodeAnnuelle: false,
    notePeriodeHorsP: false,
    libellesAppreciations: Array<"Appréciation générale">,
    appreciationsParametrage: Array<{
      code: "APP1",
      id: 1,
      nbMaxCaractere: 400,
      libelle: "Appréciation générale",
    }>,
  },
}

Array<Workspace>

type Workspace = {
  id: number, // Identifiant de l'espace de travail
  titre: string,
  description: "", // Semble toujours vide, peut-être une version plus courte de "résumé"
  resume: string, // Encodé en base64
  cloud: true, // Probablement si le cloud, les discussions ou l'agenda sont activés ou non
  discussion: bool,
  agenda: bool,
  public: bool, // Si l'espace est visible par tous les élèves
  ouvert: bool, // Si les élèves peuvent rejoindre l'espace librement
  type: "LIBRE",
  estMembre: bool,
  estAdmin: false,
  salleDesProfs: false, // Probablement pour l'équivalent prof des espaces de travail qui peuvent aussi servir de salle des profs numérique
  creePar: string, // Nom du créateur (Prénom NOM ... NOMS)
  droitUtilisateur: 0 | 1 | 2, // ?
  nbMembres: 0,
  couleurEvenementAgenda: "#RRVVBB",
  creeLe?: "JJ/MM/AAAA à HH:MM",
}

Omit<Workspace, "type" | "creeLe"> & {
  cloudLibelle: string, // Semble être la même valeur que le `titre` de l'espace
  fullLoaded: false,
}

Array<{
  libelle: string,
  url: string,
  urlCouverture: string,
  urlTelechargement: "",
  editeur: string,
  idRessource: string, // Je sais pas à quoi ça peut bien servir (peut-être dans l'EDT ?)
  affecte: true, // ?
  ogec: string, // Code RNE de l'établissement scolaire
  eleves: [], // ?
  disciplines: Array<string>, // Codes des matières concernées. Vide ou 1 élément jusqu'ici
}>

type Semaine = {
  semaine: number, // numéro de la semaine
  doc: Array<{
    libelle: string, // nom du document (Exemple: Menu semaine n°40)
    id: number // numéro du document (voir téléchargement pour récupérer le document)
  }>
}

{
  historiqueCommandes: Array<{
    idCommande: number, //identifiant de commande
    numeroCommande: string, //exemple: 010203-15 (probablement 15ème commande faite pour le 1er février 2003)
    creneau: string, //exemple: "12:00 - 13:45"
    date: string,
    etat: string,
    estHorsDelai: boolean,
    idUser: number,
    typeUser: string, // ELEVE
    articles: Array<{
          code: string,
          libelle: string,
          description: string,
          estFormule: boolean,
          etat: number,
          img: string, // (URL)
          montant: number,
          quantite: number,
          quantiteMax: number,
          estObligatoire: boolean
          ordre: number,
          possibilites: Array<{
            code: string,
            libelle: string,
            quantite: number,
            etat: number,
            idCateg: number,
            libelleCateg: string,
            ordre: number,
            img: string,
            choix: Array<{
              libelle: string,
              id: number,
              ordre: number
            }>,
          }>,
        }>,
  }>, // permet de récupérer les commandes effectuées
  tabPointsDePassage: Array<{
      id: number, // identifiant du point de passage, va servir pour l'endpoint d'en dessous (idPDP)
      libelle: string, // nom du point de passage
      plafond: number, // ???
      nbHeureLimiteAvantCommande: number,
      decouvertActif: boolean, // ???
      panierMinimum: number, // normalement que 0
      categoriesArticles: Array<{
        id: number,
        libelle: string,
        ordre: number,
        articles: Array<{
          code: string,
          libelle: string,
          description: string,
          estFormule: boolean,
          etat: number,
          img: string, // (URL)
          montant: number,
          quantite: number,
          quantiteMax: number,
          estObligatoire: boolean
          ordre: number,
          possibilites: Array<{
            code: string,
            libelle: string,
            quantite: number,
            etat: number,
            idCateg: number,
            libelleCateg: string,
            ordre: number,
            img: string,
            choix: Array<{
              libelle: string,
              id: number,
              ordre: number
            }>,
          }>,
        }>,
      }>,
      creneaux: Array<{
        estComplet: boolean,
        libelle: string
    }>,
    }>,
    joursFeries: Array<{{string}}>, //exemple : ["2023-01-01", "2023-02-02", etc...]
}

{
  creneauMinRetrait: string, // ???
  soldePM: number, // portefeuille de l'élève
  libellePM: string, //
  montantDecouvert: number, //???
  montantSemaineAtteint: boolean,
  montantJournalierAtteint: boolean,
  nbPassageSemaineAtteint: boolean,
  montantSemaine: number,
  montantJournalier: number,
  montantActuelSemaineUser: number,
  nbPassageSemaine: number,
  articlesSansStock: Array<{{string}}>, // exemple : ["DONUTS", "GAUFFRES"]
  articlesAvecStock: Array<{
    id: number,
    code: string
    type: string,
    montant: number,
    idCateg: number
  }>
}

{
  articles: Array<{
          code: string,
          libelle: string,
          description: string,
          estFormule: boolean,
          etat: number,
          img: string, // (URL)
          montant: number,
          quantite: number,
          quantiteMax: number,
          estObligatoire: boolean
          ordre: number,
          possibilites: Array<{
            code: string,
            libelle: string,
            quantite: number,
            etat: number,
            idCateg: number,
            libelleCateg: string,
            ordre: number,
            img: string,
            choix: Array<{
              libelle: string,
              id: number,
              ordre: number
            }>,
          }>,
        }>,
  creneau: string, //exemple: "12:00"
  date: string, // AAAA-MM-JJ
  pointDePassage: number // (idPDP)
}