Merge pull request #1245 from betagouv/add-api-scolarite-men

[API-1179] Nouvelle API : scolarité MEN

_data/api/api-scolarite-ministere-education-nationale.md

@@ -0,0 +1,118 @@
+---
+title: API scolarité de l'élève
+tagline: Statut scolarisé et statut boursier d'un élève du primaire, collège ou lycée. 
+producer: menj
+contact_link: [email protected]
+is_open: -1
+datapass_link: https://datapass.api.gouv.fr/api-scolarite
+is_france_connected: -1
+access_page:
+  - who:
+      - Un particulier
+      - Un étudiant
+      - Une entreprise
+    is_eligible: -1
+    description: |
+      Vous ne pouvez pas accèder à ces informations qui sont des données protégées.
+
+      <Button href="/rechercher-api">Rechercher une autre API</Button>
+  - who:
+      - Une administration
+    is_eligible: 1
+    description: |
+      En tant que collectivité territoriale ou administration, vous êtes éligible à utiliser cette API selon votre cadre juridique. Vous pouvez déposer une demande d'habilitation :
+      <Button href="https://datapass.api.gouv.fr/api-scolarite">Demander un accès</Button>
+# rate_limiting_resume: 10 appels / minute / IP # 📍 Volumétrie maximale de votre API.
+# rate_limiting_description: | L'API est disponible à hauteur de 10 appels par minute.
+# Phrase descriptive de la volumétrie
+themes:
+  - Particulier
+  - Education
+  - Administration
+keywords:
+  - eleve
+  - scolarite
+  - scolaire
+  - bourse
+  - boursier
+  - etablissement
+  - ecole
+  - primaire
+  - college
+  - lycee
+  - enseignement
+doc_tech_link: TODO
+visits_2019: 4000
+last_update: 15/12/2023
+---
+
+Cette API, délivrée par le Ministère de l'éducation nationale, permet de vérifier si un particulier est scolarisé au primaire, au collège ou au lycée, et savoir s'il est boursier.
+Votre service utilisera d'autres API ? Retrouvez les données de cette API dans le bouquet d'API distribué par la DINUM [API Particulier](les-api/api-particulier).
+
+### Périmètre
+
+#### Particuliers concernés :
+
+Cette API concerne les ✅ élèves du primaire, du collège et du lycée.
+Une large majorité d’établissements sont concernés :
+- ✅ établissements publics ;
+- ✅ établissements privés sous contrat ;
+- ✅ lycées militaires et lycées maritimes ;
+- ✅ une partie des formations à distance du CNED.
+
+Concernant le statut boursier des élèves : seules les bourses sur critères sociaux à l’échelle nationale sont couvertes par l’API. Par ailleurs, les bourses ne concernent que les collégiens et lycéens.
+
+Les établissements suivants ne sont pas couverts par l’API :
+- ❌ établissements privés hors contrat ;
+- ❌ lycées agricoles ;
+- ❌ instruction dans la famille.
+
+####  Périmètre géographique :
+- ✅ France métropolitaine
+- ✅ DROM-COM
+
+#### Actualisation de la donnée 
+
+Cette API délivre les informations de l’année scolaire en cours et bientôt de l’année scolaire à venir (N+1).
+Les données du premier degré (primaire) sont mises à jour en temps réel. Les données du second degré (collèges et lycées) sont mises à jour quotidiennement toutes les nuits.
+Les informations, même si elles évoluent principalement lors de la rentrée scolaire en septembre, peuvent changer en cours d’année (déménagements, etc.).
+
+⚠️ Attention, si un élève est indiqué “non-boursier” avant mi-octobre, il ne faut pas prendre en compte cette information. Le statut non-boursier est véritablement fiable à partir de mi-octobre.
+
+
+### Modalités d'appel
+Cette API propose une modalité d’appel avec les données d’identité, tous les paramètres sont obligatoires : 
+- Nom, prénom,
+- sexe et date de naissance de l’élève,
+- code UAI de l’établissement
+- année scolaire souhaitée.
+
+### Données
+
+Cette API indique si l’élève est scolarisé et sous quel statut pour l’année scolaire en cours et bientôt N+1. Le statut boursier ainsi que l’échelon de bourse est également précisé le cas échéant.
+
+Informations renvoyées en JSON : 
+
+| Nom         | Description                                                                                                              |
+| ----------- | ------------------------------------------------------------------------------------------------------------------------ |
+| Information sur l'élève     | Le nom, prénom, sexe, date de naissance de l'élève. <br/>La recherche s'effectue avec les données entrées en paramètre. Si les nom ou prénom sont incomplets en entrée, ils sont retournés complets en retour. |
+| Code UAI de l'établissement | Code d'unité administrative immatriculée (code UAI) de l'établissement où est scolarisé l'élève. <br/>Ce code unique inscrit au répertoire national des établissements est composé de 7 chiffres et d'une lettre ; les trois premiers chiffres correspondent au numéro de département de l'établissement. Pour retrouver facilement le code UAI d'un établissement à partir d' informations plus facilement connues des usagers (commune, code postal, etc.), vous pouvez utiliser l'[API "Annuaire de l'éducation nationale"](/les-api/api-annuaire-education).<br/>NB : L'établissement 0861288H (CNED Direction générale) n'existe pas dans l'API annuaire de l'éducation nationale, il faudra donc compléter la liste des établissements avec une ligne CNED à laquelle sera associée le code UAI qui sera en passé en entrée. |
+| Année scolaire      | Année scolaire de l'élève au format AAAA-AAAA ou AAAA (AAAA= 2023 pour l'année scolaire 2023-2024)   |
+| Est scolarisé        | True / False : indique si l'élève est scolarisé dans l'établissement. |
+| Est boursier        | True / False : indique si l'élève est boursier dans l'établissement. <br/>Les bourses concernent uniquement les élèves des collèges et lycées. NB : Si le statut boursier est à "false" avant mi-octobre, cela ne signifie pas forcément que l'élève n'est pas boursier. Il peut s'agir d'un faux négatif lié à une absence de l'information en base. <br/>Pour en savoir plus consulter <External href="https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_1_api_particulier_endpoint_education_nationale_statut_eleve_scolarise">la fiche métier</External>.|
+| Niveau de bourse        | exemple : 1 : indique l'échelon de la bourse de l'élève. <br/>Est à "null" quand "est_boursier" est "false". Les bourses concernent uniquement les élèves des collèges et lycées. Il existe trois échelons de bourses pour les collégiens (1 à 3) et six échelons pour les lycéens (1 à 6), correspondant aux montants reçus par l'élève pour l'année scolaire. Pour en savoir plus, consulter <External href="https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_2_api_particulier_endpoint_education_nationale_statut_eleve_scolarise">la fiche métier</External>.  |
+| Code statut de l'élève  | Indique le statut sous lequel l'élève est scolarisé dans l'établissement. <br/>Les valeurs sont susceptibles d'évoluer : ST : Scolaire, il s'agit du statut de base renvoyé pour près de 95% des élèves / AP : Apprenti / CQ : Contrat de qualification / FC : Formation continue / ED : Enseignement à distance / IN : Candidat individuel / FQ : Stagiaire de la formation Professionnelle / SC : Scolaire ou formation initiale / CP : Contrat de professionnalisation. / NC : Non connu ou non communiqué. |
+| Libellé statut de l'élève        | Exemple : SCOLAIRE : Libellé du statut sous lequel l'élève est scolarisé dans l'établissement.|
+
+
+### Modalités d'utilisation des scopes
+
+Lors de votre demande d'habilitation, vous aurez à sélectionner un ou plusieurs scopes selon votre cas d'usage.
+Cette API comprend trois périmètres d'accès : 
+
+| Nom du scope        | Données accessibles  |                                                                                           
+| ----------- | --------------------------------------- |
+| Scolarité     | état_scolarité + statut_scolaire |
+| état_boursier | boursier oui/non |
+| niveau_bourse| échelon de la bourse|
+

_data/producteurs/menj.md

@@ -1,6 +1,18 @@
 ---
-name: Ministère de l'Éducation Nationale et de la Jeunesse
+name: Ministère de l'Éducation nationale et de la Jeunesse
 acronym: MENJ
 type: Ministère
 logo: logo_menj.jpg
+site: https://www.education.gouv.fr/ 
+#short: Description courte répondant à la question "Qu'est ce que le «fournisseur de données» ?"
+# description: | Description longue répondant à la question "Quelle est sa mission de service public ?"
+#data: |
+#  | Donnée             | Description                    |
+#  | ------------------ | ------------------------------ |
+#  | Hydrométrie | mesure du débit des cours d'eau |
+# Tableau listant les données détenues par le fournisseur
+# contact: https://contact.service.gouv.fr/ # URL de la page de contact du fournisseur.
+annuaire: https://lannuaire.service-public.fr/gouvernement/3ed2f725-e077-4973-a531-498e13fc7861 #URL vers l'annuaire du service public
+siteOpenData: https://www.data.gouv.fr/fr/organizations/ministere-de-leducation-nationale-et-de-la-jeunesse/ # URL du site dédié à l'OpenData du fournisseur de données, peut renvoyer vers le site data.gouv
+# siteAPI: URL du site officiel dédié aux API du fournisseur
 ---

model/tests/roadmap.test.js

@@ -37,6 +37,7 @@ const oldAPIs = [
   'API Indemnités Journalières de la CNAM',
   'API Infotravail',
   "API de droits à l'Assurance Maladie",
+  "API scolarité de l'élève",
   "Annuaire des établissements publics de l'administration",
   "Hub'Eau - Hydrométrie",
   "Hub'Eau - Indicateurs Eau potable et Assainissement",