Warning
(Mise à jour du 28/03/2024).
À la date où cette documentation a été modifié, Aplim (la société créatrice d'EcoleDirecte) a ajouté une nouvelle fonctionnalité de QCM afin de pouvoir sécuriser les comptes EcoleDirecte de tentative de piratage.
L'implémentation de ce système est décrite ici.
Bienvenue sur la documentation non officielle de l'api d'ecoledirecte.
Si jamais cette documentation vient a être défaillante, merci de faire une issue avec les problèmes rencontrés
Note
(Si jamais vous avez des idées de formatage, hésitez pas à me le faire savoir kekaaafm sur Discord)
Juste un rapide sommaire pour naviguer plus facilement dans la documentation.
La base de l'api élève est https://api.ecoledirecte.com/. Toutes les URLs relatives sont relatives à cette base.
Les requêtes prennent généralement des paramètres soit en query string dans l'URL soit en JSON dans le corps de la requête. Ces paramètres sont encodés au format application/x-www-form-urlencoded, bien que cet encodage soit totalement optionnel pour le corps de la requête.
Note
On peut utiliser la fonction encodeURIComponent() en JavaScript et urllib.parse.quote() en Python pour encoder ces paramètres.
Exemple : Votre mot de passe est JaimeLesK++kies&Ynotes il faudra envoyer JaimeLesK%2B%2Bies%26
Warning
Toutes les requêtes sont faites en POST. Elles prennent aussi un paramètre verbe utilisé pour spécifier le verbe HTTP. Ici ce paramètre est omis et la méthode HTTP indiquée est en réalité la valeur du paramètre verbe (l'exemple est plus clair).
Les réponses suivent généralement le format suivant, et tout schéma de réponse donné correspond en réalité à celui de la valeur de data :
{
"host": "HTTP<n° serveur>",
"code": 200, // Ou autre en cas d'erreur
"token": "<token>",
"message": "", // Rarement présent hors erreur, sinon en cas d'erreur
"data": {...},
}GET /v3/eleves/{eleve.id}/messages/{message.id}.awp
Avec les paramètres de recherche mode=destinataire et les paramètres en JSON { "anneeMessages": "2021-2022" }
Correspond à la requête
POST https://api.ecoledirecte.com/v3/eleves/{élève.id}/messages/{message.id}.awp?verbe=get&mode=destinataire avec le corps data={ "anneeMessages": "2021-2022" } ou bien sous forme encodée data=%7B%20%22anneeMessages%22%3A%20%222021-2022%22%20%7D
Note
Avant tout, merci d'ajouter un user-agent dans vos headers pour "faire croire" à ED que vous utilisez un "vrai" navigateur pour faire vos requetes ! Il faut savoir que si vous utilisez un useragent pour obtenir un token, il faudra utiliser le même useragent avec ce token. Si jamais un autre UA est utilisé, le token sera invlidé. Si vous n'avez pas d'idée en voici un :
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36
Cela concerne toutes les routes à l'exception de /login. Il faut passer un Header à la requête avec le token (voir login):
X-Token: <token>
Liste de differents codes erreur trouvés au fil du temps avec leur description et des solutions pour fixer le pb
Note : Les requêtes renveront (sauf grosse erreur côté serveur avec une 5xx) toujours dans leur header un code 200, même en cas d'erreur
Code: 250
Problème : Il faut vérifier la connexion du compte (nouvel appareil ajouté).
Solution : Il faut remplir un QCM (voir "⚠ Concernant la connexion (QCM)").
Code: 505
Problème: Les identifiants donnés à l'api sont erronés
Solution: Il faut vérifier le nom d'utilisateur et/ou le mot de passe (cf Login)
Code: 520
Problème: Le token est invalide
Solution: Il faut regénérer un token (cf Login)
Code: 525
Problème: Le token est expiré
Solution: Il faut regénérer un token (cf Login)
Code : 535
Problème : L'établissement n'est pas disponible sur EcoleDirecte
Solution : Si la tentative de connexion est effectuée pendant des vacances scolaires, attendre la reprise des cours
Code: 40129
Problème: Format JSON invalide
Solution: Vérifier que le body de la requete a bien été envoyé en raw (ou plain text) et qu'il respecte le formatage donné dans la documentation
EcoleDirecte n'utilise pas qu'un seul serveur, il est possible d'obtenir des informations sur les serveurs du site en une seule requete. La raison pour laquelle cette partie est dans la partie référence c'est car cela n'a pas trop d'utilitée a vraiment parler...
Note
Il semblerait que le fichier soit statique :c (les pings sont les mêmes depuis que j'ai commencé la doc)*
Voici le lien du fichier : https://www.ecoledirecte.com/EDCluster/servers.json
Échantillon du fichier :
{
"servers": [ //On va recevoir une liste d'objets comme celui ci dessous
{
"profile": "API", //string | Alterne entre API / APIP et ALL
"lastCheck": "Mon Mar 16 2020 20:55:47 GMT+0100 (CET)", // la dernière fois où le serveur a été vérifié
"name": "api.ecoledirecte.com", //string | url du serveur
"ip": "213.32.36.118", //string | ip du serveur
"status": 1,//int | si le serveur est bien en ligne
"responseTime": 338.23671800643206, //float | ping
"weigth": 3, //int | ???
"timeout": false, //bool | Si le serveur a timeout
"version": "Maj du 16/03/2020 à 16h27", //string, version logicielle du serveur
"bdTested": "95", //string | ???
"elapsedTime": 338, //int | ???
"timingPhases": { //Object representatant la latence avec des détails
"wait": 78.6058100014925,
"dns": 3.143696002662182,
"tcp": 7.182815000414848,
"firstByte": 249.2012169957161,
"download": 0.10318000614643097,
"total": 338.23671800643206
},
"timings": {
"socket": 78.6058100014925,
"lookup": 81.74950600415468,
"connect": 88.93232100456953,
"response": 338.1335380002856,
"end": 338.23671800643206
},
"httptested": "HTTP76",
"nbConnexions": 1,//int | Nombre d'utilisateur connectés ??
"errorCode": "ESOCKETTIMEDOUT"
},
],
}Ici se trouve toute la documentation, assurez-vous d'avoir lu la référence avant de commencer
POST /v3/login.awp
Data en body :
{
"identifiant": "Username",
"motdepasse": "Password",
"isRelogin": false,
"uuid": ""
}Différents exemples de réponses complètes. Elles suivent le modèle de réponse donné dans la référence.
Succès
{
"code": 200,
"token": "Super secret token here", //Token de connexion (+3100 long)
"message": "", //Utilisé pour afficher des messages d'erreur
"data": {
"accounts": [
// Liste d'utilisateur liés au compte, voir la référence pour plus
]
}
}Erreur (Mot de passe invalide)
{
"code": 505,
"token": "", //Toujours vide en cas d'erreur
"message": "Mot de passe invalide !",
"data": {
"accounts": []
}
}Erreur (Utilisateur introuvable)
{
"code": 505,
"token": "", //Toujours vide en cas d'erreur
"message": "Identifiant et/ou mot de passe invalide !",
"data": {
"accounts": []
}
}Warning
⚠ Concernant la connexion (QCM)
Si vous obtenez un code 250 concernant la connexion, vous devez implémenter la méthode suivante :
Note
Gardez bien le token mis dans la réponse lors de votre tentative de connexion !
GET /v3/connexion/doubleauth.awp
Permet de récupérer le QCM (question et réponses) afin de pouvoir se connecter.
Note
Data : {} (objet vide). Obligatoire sinon erreur parametres incorrect
Réponse (toutes les questions/réponses sont encodées en Base64) :
(Cette réponse est à titre d'exemple)
{
"code": 200,
"data": {
"question": "UXVlbCBlc3QgbGUgc2VucyBkZSBsYSB2aWUgPw==", // Quel est le sens de la vie ?
"propositions": [
"NDI==", // 42
"TGUgZnJvbWFnZQ==", // Le fromage
"MiAxNDcgNDgzIDY0Nw==", // 2 147 483 647
//et ainsi de suite selon les réponses...
]
},
"message": null, // ???
"host": "HTTP<n° serveur>"
}Une fois que vous avez récupéré les questions ainsi que les réponses :
POST /v3/connexion/doubleauth.awp
Permet de répondre au QCM afin de pouvoir se connecter.
Data :
{
"choix": "NDI==" // Votre réponse au QCM encodée en Base64
}Si tout se passe bien, vous devriez avoir une réponse comme celle-ci :
(Cette réponse est à titre d'exemple)
{
"code": 200,
"data": {
"cn": "<string spécifique encodée en Base64>",
"cv": "<string spécifique encodée en Base64>"
},
"message": null, // ???
"host": "HTTP<n°serveur>"
}Après tout cela, vous devez refaire une requête login, en y incluant cette fois les objets "cn" et "cv":
{
"identifiant": "<identifiant>",
"motdepasse": "<mot de passe>",
"isReLogin": false,
"uuid": "",
"fa": [
{
"cn": "<cn>",
"cv": "<cv>"
}
]
}Et voilà, vous avez enfin votre token valide, prêt à être utilisé !
Note
Note : Les objets "cn" et "cv" ne sont pas à usage unique et peuvent être stockés pour être réutilisés plus tard
Voici la structure détaillée d'un utilisateur (et commentée) qui est contenu sous la clé data de la réponse.
{
"idLogin": 1324, //int | Paramètre de cookie pour savoir si l'utilisateur est connecté via login/password
"id": 1234, //int | Numéro de compte
"uid": "00000000000000000000000000000000", //string | Il ne sert à rien lui aussi
"identifiant": "Username", //string | Username du compte
"typeCompte": "E", //string | Voir Type de compte dans la référence
"codeOgec": "000000000", //string | Code RNE de l'établissement scolaire du compte
"main": true, //bool | Indique si ce compte est le compte principal de la famille(il peut en avoir plusieur comme avec un parent)
"lastConnexion": "2021-10-05 18:28", //string | Date de dernière connexion à l'api via l'endpoint login (multiples connexions possibles)
"civilite": "",
"prenom": "John",
"particule": "",
"nom": "DOE",
"email": "email@example.com",
"anneeScolaireCourante": "2050-2051",
"nomEtablissement": "Github",
"logoEtablissement": "",
"couleurAgendaEtablissement": "#1796b0",
"dicoEnLigneLeRobert": false,
"socketToken": "secret token", //string | Websocket, à priori il n'est pas prit en compte concernant l'authentification (si on le change on ne sera pas déconnecté)
"modules": [
// Liste des modules
],
"parametresIndividuels": {
"lsuPoilDansLaMainBorne1": "", // int | Paramètre parcoursup
"lsuPoilDansLaMainBorne2": "", // int | Paramètre parcoursup
"lsuPoilDansLaMainBorne3": "", // int | Paramètre parcoursup
"modeCalculLSU": "", // ??? | Paramètre de recommandation parcoursup
"isQrcode": false, // ???
"accessibilitéVisuelle": false, // bool | Pour les personnes malvoyantes, une police spéciale est mise en place
"typeSaisieNotesDefaut": "",
"nbJoursMaxRenduDevoirCDT": "",
"typeViewCDTDefaut": ""
},
"profile": {
"sexe": "M",
"infoEDT": "",
"nomEtablissement": "Github",
"idEtablissement": "0",
"rneEtablissement": "0000000",
"telPortable": "",
"idReelEtab": "0",
"photo": "//doc1.ecoledirecte.com/PhotoEleves/x/y.jpg",
"classe": {
"id": 44,
"code": "TB",
"libelle": "Terminale B",
"estNote": 1
}
}
}Ces modules là sont ceux disponibles dans l'object account, ils ressemblent à ça :
{
"code": "CANTINE_BARCODE", //string | Nom du module
"enable": false, //bool | Si le module est actif pour l'account en question
"ordre": 1, //int | Position dans la sidebar
"badge": 0, //int | ???
"params": {} //object | Parametres du modules
}Voici la liste des modules qui ont été documentés jusqu'a présent
{
"code": "CANTINE_BARCODE",
"enable": false,
"ordre": 1,
"badge": 0,
"params": {}
},
{
"code": "VIE_SCOLAIRE",
"enable": true,
"ordre": 10,
"badge": 0,
"params": {}
},
{
"code": "VIE_DE_LA_CLASSE",
"enable": true,
"ordre": 20,
"badge": 0,
"params": {}
},
{
"code": "NOTES",
"enable": true,
"ordre": 30,
"badge": 0,
"params": {}
},
{
"code": "CLOUD",
"enable": false,
"ordre": 90,
"badge": 0,
"params": {}
},
{
"code": "MESSAGERIE",
"enable": true,
"ordre": 40,
"badge": 0,
"params": {
"isActif": "1",
"canParentsLireMessagesEnfants": "1",
"destAdmin": "0",
"destEleve": "0",
"destFamille": "0",
"destProf": "1",
"destEspTravail": "0",
"disabledNotification": "0",
"notificationEmailEtablissement": "1",
"choixMailNotification": "0",
"autreMailNotification": "",
"mailPro": "",
"mailPerso": "",
"messagerieApiVersion": "v3",
"blackListProfActive": "0",
"estEnBlackList": "0",
"afficherToutesLesClasses": "0"
}
},
{
"code": "EDT",
"enable": true,
"ordre": 50,
"badge": 0,
"params": {}
},
{
"code": "DOCUMENTS_ELEVE",
"enable": true,
"ordre": 71,
"badge": 0,
"params": {
"DocumentsNotesActif": "1",
"DocumentsVSActif": "1",
"DocumentsAdministratifActif": "1"
}
},
{
"code": "CAHIER_DE_TEXTES",
"enable": true,
"ordre": 60,
"badge": 0,
"params": {
"compteRenduSeance": "1",
"compteRenduSeancePrevisionnel": "0",
"isCDTPrimaire": "0"
}
},
{
"code": "MANUELS_SCOLAIRES",
"enable": false,
"ordre": 62,
"badge": 0,
"params": {}
},
{
"code": "QCM",
"enable": true,
"ordre": 65,
"badge": 0,
"params": {}
},
{
"code": "RESERVATIONS",
"enable": false,
"ordre": 80,
"badge": 0,
"params": {
"regime": "Externe",
"repasmidi_1": "0",
"repassoir_1": "0",
"repasmidi_2": "0",
"repassoir_2": "0",
"repasmidi_3": "0",
"repassoir_3": "0",
"repasmidi_4": "0",
"repassoir_4": "0",
"repasmidi_5": "0",
"repassoir_5": "0",
"repasmidi_6": "0",
"repassoir_6": "0",
"repasmidi_7": "0",
"repassoir_7": "0"
}
},
{
"code": "COMMANDE_PASSAGE",
"enable": false,
"ordre": 81,
"badge": 0,
"params": {}
},
{
"code": "CARNET_CORRESPONDANCE",
"enable": false,
"ordre": 70,
"badge": 0,
"params": {}
},
{
"code": "ESIDOC",
"enable": false,
"ordre": 110,
"badge": 0,
"params": {}
},
{
"code": "EDUNAO",
"enable": false,
"ordre": 100,
"badge": 0,
"params": {}
},
{
"code": "CATER",
"enable": false,
"ordre": 90,
"badge": 0,
"params": {}
},
{
"code": "ARD",
"enable": false,
"ordre": 120,
"badge": 0,
"params": {}
},
{
"code": "PEARLTREES",
"enable": false,
"ordre": 170,
"badge": 0,
"params": {}
},
{
"code": "EDUMALIN",
"enable": false,
"ordre": 171,
"badge": 0,
"params": {}
},
{
"code": "SUIVI_STAGE",
"enable": false,
"ordre": 43,
"badge": 0,
"params": {}
},
{
"code": "CLICKNPLAY",
"enable": false,
"ordre": 171,
"badge": 0,
"params": {}
},
{
"code": "VOLTAIRE",
"enable": false,
"ordre": 175,
"badge": 0,
"params": {}
},
{
"code": "ONISEPSERVICES",
"enable": false,
"ordre": 172,
"badge": 0,
"params": {}
},
{
"code": "AVENRIA",
"enable": false,
"ordre": 173,
"badge": 0,
"params": {}
},
{
"code": "SACOCHE",
"enable": false,
"ordre": 174,
"badge": 0,
"params": {}
},
{
"code": "ETUDIANT",
"enable": false,
"ordre": 176,
"badge": 0,
"params": {}
},
{
"code": "IJBOX",
"enable": false,
"ordre": 177,
"badge": 0,
"params": {}
},
{
"code": "FUTURNESS",
"enable": false,
"ordre": 178,
"badge": 0,
"params": {}
},
{
"code": "IMPALA",
"enable": false,
"ordre": 179,
"badge": 0,
"params": {}
},
{
"code": "SITUATION_FINANCIERE",
"enable": false,
"ordre": 92,
"badge": 0,
"params": {}
}Je sais pas qui aurait besoin de la timeline mais bon (:
GET /v3/eleves/{id}/timeline.awp
Data dans la réponse :
[ //Liste des évènements relatif au compte (quelques exemples d'évènement peuvent être trouvés)
{
"date": "2021-12-05", //String | Date de l'evènement
"typeElement": "Note", //String | Type de l'event (Note / Abscence / Document / Messagerie / VieScolaire / ...)
"idElement": 0, // identifiant du message / evt de vie scolaire / document associé
"titre": "Nouvelle évaluation", //String | Titre de l'evenement
"soustitre": "ED.PHYSIQUE & SPORT.",
"contenu": "natation du 15/11/2021" //String | Contenu de l'evenement
},
{
"date": "2021-09-20",
"typeElement": "VieScolaire",
"idElement": 527,
"titre": "Absence",
"soustitre": "2 demi-journées",
"contenu": "Justifiée"
},
{
"date": "2021-09-17",
"typeElement": "Document",
"idElement": 2538,
"titre": "Nouveau document à télécharger",
"soustitre": "",
"contenu": "Invitation 50 ans"
},
{
"date": "2021-09-09",
"typeElement": "Document",
"idElement": 1144,
"titre": "Nouveau document à télécharger",
"soustitre": "",
"contenu": "Certificat de scolarité"
}
]GET /v3/E/{id}/timelineAccueilCommun.awp
C'est la timeline de l'établissement que tous les élèves voient. Elle inclue les post-its.
Data dans la réponse :
{
"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
},
}>,
}GET /v3/rdt/sondages.awp
J'ai eu une réponse avec une liste vide dans data donc réponse inconnue.
GET /v3/edforms.awp
Endpoint pour récupérer les données sur les formulaires
Data en body :
{
"anneeForms": "2023-2024",
"typeEntity": "E",
"idEntity": 1234
}Remplacer 1234 par l'ID d'élève
Data dans la réponse :
[
{
"questions": [
{
"id": 515, // ID de la question
"question": string, // encodé en base64
"enonce": string, // encodé en base64
"typeQ": "radio", // type de sélection de choix ("radio", "textarea", "checkbox")
"ordre": 16384, // ?
"required": true, // question obligatoire ?
"minChecks": 0, // nombre de choix minimal ?
"maxChecks": 0, // nombre de choix maximal ?
"propositions": [
{
"id": 2568, // ID de la réponse ?
"enonce": string, // encodé en base64
"choisie": 0 // Réponse choisie ?
}
]
}
],
"reponses": [], // Vide même après avoir répondu au formulaire ?
"formulaire": {
"id": 171, // ?
"typeF": "f", // ?
"titre": string, // texte normal
"introduction": string, // encodé en base64
"conclusion": string, //encodé en base64
"signature": false, // ?
"created": "2024-01-07 17:23:59" // Date de création du formulaire
},
"participant": {
"id": 15347, // ?
"fini": "2024-01-08 21:48:43" // Date où le formulaire a été complété
}
}
]GET /v3/E/{id}/visios.awp
Pas de visios ici non plus donc réponse inconnue.
Le titre est plutot clair non ?
Note
Si jamais le temps est incorrect alors data sera juste un array vide*
GET /v3/E/{id}/emploidutemps.awp
Data en body :
{
"dateDebut": "2021-12-15",
"dateFin": "2021-12-15",
"avecTrous": false
}Data dans la réponse :
[
{
"id": 46234, //int | Semble être un identifiant unique du cours
"text": "NUMERIQUE SC.INFORM.", //string | Nom du cours (peut diférer de la matière)
"matiere": "NUMERIQUE SC.INFORM.",
"codeMatiere": "NSINF", //string | Code matière interne au service ED
"typeCours": "COURS", //string | Semble varier (COURS / PERMANENCE)
"start_date": "2021-12-15 08:00",
"end_date": "2021-12-15 08:55",
"color": "#91b2bc", //string | Couleur hex du cours sur l'edt
"dispensable": false, //string | Si l'élève doit se rendre en cours
"dispense": 0, //int | Rhalala, le sport (:
"prof": "MaitreRouge",
"salle": "SALLE 11 INFO",
"classe": "", //string | vide si est dispensé dans plusieures classes
"classeId": 0, //int | ID de la classe dans laquelle le cours est dispensé (0 si est dispensé dans plusieures classes)
"classeCode": "", //int | Code de la classe (je pense qu'on a compris avec le temps que c'était vide si la cours était dispensé dans plusieures classes)
"groupe": "T_NSINF-1", //string | Nom du groupe (si dispensé dans plusieures classes)
"groupeCode": "T_NSINF-1",//string | Code du groupe
"isFlexible": false, //bool | ???
"groupeId": 2004, //int | ID du groupe
"icone": "", //string | Depuis quand on peut avoir des icones ?
"isModifie": false, //bool | ???
"contenuDeSeance": false, //bool | false même si du contenu est posté
"devoirAFaire": false, //bool | false même si un devoir est posté
"isAnnule": false //bool | Si le cours est annulé (franglais dégeu)
},
{
"id": 78905,
"text": "ANGLAIS LV1",
"matiere": "ANGLAIS LV1",
"codeMatiere": "AGL1",
"typeCours": "COURS",
"start_date": "2021-12-15 10:00",
"end_date": "2021-12-15 10:55",
"color": "#ff66cc",
"dispensable": false,
"dispense": 0,
"prof": "Florian L",
"salle": "SALLE 44",
"classe": "Terminale B",
"classeId": 44,
"classeCode": "TB",
"groupe": "",
"groupeCode": "",
"isFlexible": false,
"groupeId": 0,
"icone": "",
"isModifie": false,
"contenuDeSeance": false,
"devoirAFaire": false,
"isAnnule": false
}
]GET /v3/Eleves/{id}/cahierdetexte.awp
Donne les devoirs à faire à partir d'aujourd'hui (onglet à faire).
Data dans la réponse :
{
"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 ?
}>,
}GET /v3/Eleves/{id}/cahierdetexte/{AAAA-MM-JJ}.awp
Permet d'obtenir le travail à faire en détail et le contenu de séance pour un jour spécifique.
Note
Il y a deux champs contenu de séance, un directement dans la matière et un dans à faire. Je suspecte que celui dans à faire soit prévu avant la séance alors que celui directement dans la matière soit renseigné après les faits.
Je vérifierai la différence quand EcoleDirecte sera à nouveau fonctionnel et que j'aurai un exemple des deux.
- Les données à l'intérieur des clés
contenusont encodées en base64. Une fois décodées, on obtient le contenu en HTML dans une balise<p>.
Data dans la réponse :
{
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: [],
},
}>
}PUT /v3/Eleves/{id}/cahierdetexte.awp
Marque des devoirs comme faits ou non faits.
Data en body :
{
idDevoirsEffectues: number[],
idDevoirsNonEffectues: number[],
}POST /v3/eleves/{id}/afaire/commentaires.awp
Poste un commentaire sous un travail à faire ou un contenu de séance
Data en body :
{
message: string, // encodé en base64
idContenu: number, // identifiant du devoir / contenu de séance
}Data dans la réponse :
{
id: number, // Identifiant du commentaire posté
}Endpoint qui sert a afficher les données sur la page vie de classe
GET /v3/eleves/{id}/viescolaire.awp
Data dans la réponse :
{
"absencesRetards":[
{
"id":2936, //int | Identifiant interne de l'abscence / retard
"idEleve":0, //int | Normalement égal à l'id de l'eleve mais 0 dans mon cas
"nomEleve":"", //string | Normalement rempli mais vide dans mon cas
"typeElement":"Absence", //string | Sert pour savoir si c'est une "Abscence" ou un "Retard"
"date":"2021-11-19",
"displayDate":"le vendredi 19 novembre 2021 de 08:30 à 16:30",
"libelle":"2 demi-journées",
"motif":"",
"justifie":true, //bool | Si jamais justufié ou non (note : si jamais elle est en attente de justification, elle sera a true)
"par":"",
"commentaire":"Merci de bien vouloir excuser l'absence de X pour la journée, il est souffrant.\nBien cordialement,",
"typeJustification":" en attente de prise en compte par la vie scolaire",
"justifieEd":true, // Si on peut justifier en ligne ?
"aFaire":"",
"dateDeroulement":""
}
],
"sanctionsEncouragements":[
{
"id":48,
"idEleve":0,
"nomEleve":"",
"typeElement":"Punition",
"date":"2021-11-26",
"displayDate":"",
"libelle":"RETENUE",
"motif":"Trop de mots dans le carnet",
"justifie":false,
"par":"",
"commentaire":"",
"typeJustification":"",
"justifieEd":false,
"aFaire":"1 heure",
"dateDeroulement":"S'est déroulé le mer. 08 décembre<BR>de 13:00 à 14:00"
}
],
"parametrage": {
"justificationEnLigne":true,
"absenceCommentaire":true,
"retardCommentaire":true,
"sanctionsVisible":true,
"sanctionParQui":false,
"sanctionCommentaire":true,
"encouragementsVisible":false,
"encouragementParQui":false,
"encouragementCommentaire":false
}
}Permet d'obtenir une liste des correspondances.
GET /v3/eleves/{id}/eleveCarnetCorrespondance.awp
Data dans la réponse :
{
"correspondances": [
// ?
],
"suivis": [
// ?
]
}Permet d'obtenir la liste des documents administratifs associées à une année scolaire, ou à l'année actuelle.
GET /v3/elevesDocuments.awp
Paramètres de recherche :
archive=pour l'année actuellearchive=AAAA-AAAApour spécifier une année précise
Data dans la réponse :
{
factures: [], // ?
notes: Array<Document>,
viescolaire: [], // ?
administratifs: Array<Document>,
inscriptions?: [], // ?
listesPiecesAVerser: {
listePieces: [], // ?
personnes: Array<{id: 1234, nom: "…", prenom: "…", type: "E"}>,
pieces: [], // ?
televersements: [] // ?
}
}Type des objets document :
type Document = {
id: number,
libelle: string,
idEleve: number,
date: "AAAA-MM-JJ",
type: "Note" | "Doc" | "",
signatureDemandee: bool, // ?
signature: {}
}Les documents peuvent être téléchargés via la route de téléchargement grâce à leur id.
GET /v3/eleves/{id}/notes.awp
Les données dans la réponse sont un peu un bordel. Il y a les moyennes par période (trimestres et année), puis les notes individuelles, puis les paramètres d'affichage des notes. Ce qui veut dire que même si l'établissement désactive l'affichage de jsp quoi c'est quand même transmis, je pense (donc on peut quand même y accéder).
Data en body :
{
"anneeScolaire": "",
}Data dans la réponse :
{
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",
}>,
},
?LSUN: {
// période: data
A001: Array<{
cdt: false, // ?
codeMatiere: "MATHS", // Code abrégé de la matière
libelleMatiere: "MATHEMATIQUES",
isFirstOfMatiere: false, // AH
nbElemProgMatiere: 2, // ?
codeSousMatiere: "", // Si sous-matière
libelleSousMatiere: "", // Si sous-matière
isFirstOfSousMatiere: false, // AH
nbElemProgSousMatiere: 0, // ?
libelleElementProgramme: "Utiliser les nombres pour comparer, calculer et résoudre des problèmes ", // La compétence
idElemProg: 1054, // ID de l'élement du program
valeur: 3, // Sur 4 ?
afc: 1, // ?
professeurs: [ // Plusieurs profs ?
{
"id": 0, // ID du prof
"nom": "M. DUPUIT P."
}
]
}>
}
}Note
Il semble que certaine écoles aient les LSU mais pas d'autres 🤷♂️
GET /v3/E/{id}/espacestravail.awp
Liste les espaces de travail relatifs à l'élève. Voir route suivante pour le type workspace
Data dans la réponse :
Array<Workspace>GET /v3/E/{id}/espacestravail/{espace.id}.awp
Data dans la réponse :
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",
}POST /v3/E/{id}/espacestravail/{espace.id}/acces.awp
Permet de joindre un espace de travail.
Si la notation typescript ne vous est pas familière, ça veut dire qu'il faut renseigner les mêmes champs que ceux de Workspace à l'exception de type et creeLe, et aussi renseigner cloudLibelle et fullLoaded.
Note
TODO: Vérifier si le corps de requête est nécessaire pour joindre l'espace de travail
Data en body :
Omit<Workspace, "type" | "creeLe"> & {
cloudLibelle: string, // Semble être la même valeur que le `titre` de l'espace
fullLoaded: false,
}DELETE /v3/E/{id}/espacestravail/{espace.id}/acces.awp
Permet de quitter un espace de travail.
Pas besoin d'envoyer quoi que ce soit en body; pas de réponse non plus.
GET /v3/Eleves/{id}/manuelsNumeriques.awp
Liste les manuels numériques disponibles pour l'élève.
Data dans la réponse :
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
}>GET /v3/eleves/{id}/qcms/0/associations.awp
Aucune idée de ce que ça fait. Si vous avez des données, n'hésitez pas.
Il s'agit d'un système de commande (click-and-collect).
GET /v3/menusRestaurationScolaire.awp
Permet de récupérer l'identifiant du menu (document). Data dans la réponse (pour chaque semaine disponible) :
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)
}>
}GET /v3/E/{id}/commandesPassage.awp
Permet de récupérer les points de passage possibles ainsi que des articles disponibles.
Data dans la réponse :
{
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...]
}GET /v3/E/{id}/commandesPassage/pointsDePassage/{idPDP}/{date}.awp
Permet de vérifier si le point de passage est possible le jour indiqué dans la requête.
Le format de la date est AAAAMMJJ.
Data dans la réponse :
{
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
}>
}POST /v3/E/{id}/commandesPassage.awp
Permet de passer une commande. Body:
{
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)
}En réponse, si la commande contient les bonnes informations :
{
idCommande: number,
numeroCommande: string,
creneau: string,
date: string, // AAAA-MM-JJ
dateCreneau: string,
etat: string,
estHorsDelai: boolean,
idUser: number,
typeUser: string,
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
}>,
}>,
}>,
pointDePassage: {
id: number,
libelle: string
}
}Sinon, elle renvoie un code 512.
DELETE v3/E/{id}/commandesPassage/{idCommande}.awp
Permet de supprimer une commande, selon l'idCommande.
Il ne renvoie rien si l'idCommande est bon. Sinon, il renvoie simplement un code erreur 210.
Il existe deux routes différentes, mais je n'ai eu que des objets vides comme réponse.
GET /v3/Classes/{classe.id}/viedelaclasse.awp
GET /v3/R/{classe.id}/viedelaclasse.awp
Les fichiers dans le cloud sont identifiés par leur chemin. C'est des chemins windows, parfois appelés unc dans l'API.
On trouve différents types de chemins, avec RNE le code RNE de l'établissement :
- Les chemins des clouds élèves, du type
\{RNE}\E\{id}\... - Les chemins des clouds des espaces de travail, du type
\{RNE}\W\{ent.id}\... - Les chemins des ressources temporaires, du type
\\STOCK-TMP\tmp\{RNE}_{role}_{id}_{hash}\...
Parfois les chemins sont préfixés par un autre cloud, du type \\CLOUD08\cloud\.... Même si c'est pas pour tous les fichiers. TODO: Élucider la question.
GET /v3/cloud/E/{id}.awp
Permet d'obtenir des informations sur un fichier ou un dossier (nœud) dans le cloud de l'élève.
Lorsque des informations sur un dossier sont demandées, ses nœuds fils sont aussi transmis, y compris les sous-dossiers et leurs nœuds fils à eux aussi, jusqu'à une certaine profondeur. Après, la propriété isLoaded des sous-dossiers est mise sur false et il faut refaire une requête pour obtenir le contenu de ces sous-dossiers.
Paramètres de recherche :
idfolder=chemin de dossier, pour spécifier un dossier dont on veut obtenir le contenu. Ne pas indiquer pour obtenir la racine.
Data dans la réponse :
Array<Nœud>type Nœud = {
type: "folder" | "file",
libelle: string, // Nom du dossier ou fichier, "/" pour la racine
date: "AAAA-MM-JJ HH:MM:SS",
taille: number,
quota?: number,
id: string, // Chemin UNC
isLoaded?: bool, // Présent pour les dossiers, voir plus haut
children?: Array<Nœud>, // Présent pour les dossiers
readonly: bool,
url?: string, // Pour les liens, leur URL
description?: string, // Pour les liens, leur description encodée en base64
proprietaire?: { // Présent pour les fichiers
id: number,
type: "E",
nom: string,
prenom: string,
particule: "",
}
}POST /v3/cloud/E/{id}.awp
Permet de créer un nouveau fichier ou dossier dans le cloud. Pour ajouter des fichiers existants, utiliser la route de téléversement.
La route prend en body une propriété parentNode qui peut être un objet Nœud complet mais la propriété id est la seule nécessaire, le reste est facultatif.
Data en body :
{
parentNode: Pick<Nœud, "id">,
libelle: string, // Nom du nouveau nœud
typeRessource: "file" | "folder",
}Data dans la réponse :
Nœud // Nœud crééPUT /v3/cloud/E/{id}.awp
Permet de renommer un nœud et de changer le lien ou la description d'un lien.
Data en body :
{
node: Nœud,
newLibelle: string,
newUrl?: string,
newDescription?: string,
}Data dans la réponse :
{
newId: string,
newLibelle: string,
newUrl?: string, // Présents pour les liens
newDescription?: string,
}COPY /v3/cloud/E/{id}.awp
Permet de copier des nœuds dans un autre dossier.
Data en body :
{
parentNode: Nœud, // Dossier de destination. TODO: Vérifier spécificité (id)
clipboard: Array<Nœud>, // Nœuds à copier
}Data dans la réponse :
Nœud // Dossier de destination, avec les nouveaux nœuds copiésDELETE /v3/cloud/E/{id}.awp
Permet de supprimer un nœud.
Data en body :
{
tabNodes: Array<Nœud>, // TODO: Vérifier si plus d'un nœud peut être spécifié
// TODO: Vérifier spécificité (id)
}Il existe une autre route pour les espaces de travail, /v3/cloud/W/{workspace.id}.awp.
Il est très probable que cette route fonctionne exactement comme celle élève.
POST /v3/televersement.awp
Permet de téléverser un ficher dans le cloud ou dans le stockage temporaire pour utilisation comme pièce jointe.
Le corps de la requête contient les fichiers téléversés au format multipart/form-data, ou alors des données en JSON lorsqu'on téléverse un lien dans le cloud (oui c'est possible). Notez que le serveur semble totalement ignorer le header Content-Type donc pas de soucis à se faire.
Si vous tentez de téléverser un fichier dans le cloud mais qu'un fichier du même nom existe déjà, la réponse (complète) aura le code d'erreur 573 et un message descriptif
- Pour téléverser un fichier dans le stockage temporaire, il suffit d'envoyer le fichier en corps de requête comme cité précédemment.
Dans ce cas, data dans la réponse :
{
unc: string, // Chemin du fichier temporaire
libelle: string, // Nom du fichier
}On peut noter que le chemin est aussi présent dans la clef message de la réponse complète (pas limitée à data).
-
Pour téléverser un fichier dans le cloud, il faut en plus d'envoyer le fichier en corps, spécifier en paramètre de recherche
mode=CLOUDetdest={chemin}, chemin étant le chemin du dossier dans lequel on téléverse. -
Pour téléverser un lien dans le cloud, il suffit d'envoyer une requête avec un corps en JSON standard, qui contient :
{
file: "{nom}.url;{url}", // nom étant le nom du lien et url son url
description: string, // sa description encodée en base64
}Dans ces deux cas, data dans la réponses :
NœudGET /v3/telechargement.awp
Permet de télécharger les fichiers dans le cloud, en pièce jointe, dans le cahier de texte et les documents administratifs.
Data en body :
{
forceDownload: 0, // ?
}- Pour télécharger un fichier dans le cloud, il suffit d'indiquer les paramètre de recherche
leTypeDeFichier=CLOUDetfichierId={chemin}, chemin étant le chemin du fichier - Pour télécharger une pièce jointe dans le cahier de texte, il suffit d'indiquer les paramètres de recherche
leTypeDeFichier=FICHIER_CDTetfichierId={id}, id étant l'identifiant de la pièce jointe - Pour télécharger une pièce jointe à un message, il suffit d'indiquer les paramètres de recherche
leTypeDeFichier=PIECE_JOINTE,fichierId={id}, id étant l'identifiant de la pièce jointe et éventuellementanneeMessages=AAAA-AAAApour télécharger des pièces jointes d'anciens messages - Pour télécharger un document administratif, il suffit d'indiquer le paramètre de recherche
fichierId={id}, id étant l'identifiant du document, et éventuellementarchive=trueetanneeArchive=AAAA-AAAApour accéder à d'anciens documents - Pour télécharger un menu de commande click-and-collect (ici), il faut ajouter
leTypeDeFichier=FICHIER_MENU_RESTAURATION, ainsi quefichierId={id}, id étant le numéro du document.
La réponse est évidemment le contenu du document directement.