Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initie la fiche métier carif-oref #1265

Merged
merged 27 commits into from
Dec 27, 2023
Merged
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
d1f0bb0
Initie la fiche métier carif-oref
DorineLam Oct 17, 2023
690980b
Changement du titre
Charlottecho Oct 17, 2023
095e447
Update _data/api/api_quiforme.md
Charlottecho Oct 17, 2023
00c1238
TODO
Charlottecho Oct 17, 2023
e5014e2
Ajoute section API Entreprise
DorineLam Oct 17, 2023
47bc876
revert commit
DorineLam Oct 17, 2023
3daf49a
Ajoute référence à API entreprise
DorineLam Oct 17, 2023
fef14b9
Contenu Fiche
Charlottecho Oct 18, 2023
8ae4305
Change le fournisseur de données
DorineLam Oct 18, 2023
d270bc9
Restructuration du tableau des données
DorineLam Oct 18, 2023
28e1ac1
Ajout url Swagger
Charlottecho Oct 20, 2023
494fe64
Ajoute champs manquants fiche API
DorineLam Oct 20, 2023
b8dd509
Complète fiche fournisseur
DorineLam Oct 20, 2023
e17756d
Ajoute les champs "page statistiques d'usage"
DorineLam Oct 24, 2023
d879b0b
Arbre éligibilité - chemin pour les éditeurs de logiciel
DorineLam Oct 24, 2023
6e63de4
Update _data/api/api_quiforme.md
DorineLam Oct 24, 2023
4ca8ab1
Update _data/api/api_quiforme.md
DorineLam Oct 24, 2023
36af945
Update _data/api/api_quiforme.md
DorineLam Oct 24, 2023
1804674
Update _data/api/api_quiforme.md
DorineLam Oct 24, 2023
4391adc
Update api_quiforme.md
Charlottecho Dec 4, 2023
910926d
Update api_quiforme.md
Charlottecho Dec 8, 2023
e8962ae
Apply suggestions from code review
Charlottecho Dec 19, 2023
85993de
Update carif-oref.md
Charlottecho Dec 19, 2023
6583492
FIX build
skelz0r Dec 19, 2023
331d8bd
Try to add to roadmap
skelz0r Dec 19, 2023
854dd9c
feat: add path to API
XavierJp Dec 19, 2023
914222b
API QuiForme has been released in january 2023
skelz0r Dec 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
111 changes: 51 additions & 60 deletions _data/api/api_quiforme.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam : 2 questions stp pour que je puisse terminer cette fiche :
1- Sur le site api.gouv , on référence l'API directement distribuée par Cariforef et non pas celle sur API entreprise : on maintient Base sirene et BAN normalement selon moi ( selon leur doc métier )
2- Les 📍"to-do" que tu as inscrites : je m'en charge ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1- Oui exactement
2- Oui je veux bien

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam , voici les retours et questions que j'aies pour toi avant d' envoyer email au FD pour demandes infos supplémentaires :

  • 📍 Volumétrie maximale de votre API. => Peux tu vérifier stp si cela est dans le swagger ? selon moi , non

  • doc_tech_link: https://api-quiforme.intercariforef.org/docs#/ => OK

  • doc_tech_external: https://TODO # 📍 URL vers la documentation technique de l'API => c’est quoi ?

  • monitoring_link: https://TODO # 📍URL de la page de statut de l'API => Pas dispo de leur côté

  • themes: # 📍 Ajouter un ou plusieurs thèmes, qui permettront aux usagers de trouver votre API en filtrant le catalogue par thématique. Pour ajouter un thème ci-dessous, supprimer simplement le # (sans retirer des blancs.) => Est-ce que l’on peut rajouter des « nouveaux thèmes » ?

    • Administration
  • - Administration & législation

  • - Agriculture

  • - Culture

  • - Droit & Justice

  • - Education

  • - Emploi

  • - Energie

    • Entreprise
  • - Environnement

  • - Géographie

  • - Particulier

  • - Professionnels

  • - Santé

  • - Sécurité

  • - Transport

  • last_update: 10/10/2023 /TODO => Kesako ?

  • Sources de données

    • Le reférentiel UAI/SIRET de l'Onisep (MAJ DORINE : API référencée sur api.gouv est celle de cariforef en direct donc j'inclus la BAN ? )=> j’ai rajouté la base sirene + BAN
    • Base SIRENE
    • Base Adresse nationale
    • Certificats Qualiopi ( DGEFP , Liste OF )
    • Habilitations France compétences ( France Compétences, RNCP, RS )
      -Les modifications demandées par Sabrina ont été MAJ => peux tu vérif stp ?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DorineLam , voici les retours et questions que j'aies pour toi avant d' envoyer email au FD pour demandes infos supplémentaires :

📍 Volumétrie maximale de votre API. => Peux tu vérifier stp si cela est dans le swagger ? selon moi , non

doc_tech_link: https://api-quiforme.intercariforef.org/docs#/ => OK

doc_tech_external: https://todo/ # 📍 URL vers la documentation technique de l'API => c’est quoi ?

monitoring_link: https://todo/ # 📍URL de la page de statut de l'API => Pas dispo de leur côté

themes: # 📍 Ajouter un ou plusieurs thèmes, qui permettront aux usagers de trouver votre API en filtrant le catalogue par thématique. Pour ajouter un thème ci-dessous, supprimer simplement le # (sans retirer des blancs.) => Est-ce que l’on peut rajouter des « nouveaux thèmes » ?

Administration

  • Administration & législation
  • Agriculture
  • Culture
  • Droit & Justice
  • Education
  • Emploi
  • Energie
    Entreprise
  • Environnement
  • Géographie
  • Particulier
  • Professionnels
  • Santé
  • Sécurité
  • Transport
    last_update: 10/10/2023 /TODO => Kesako ?

Sources de données
Le reférentiel UAI/SIRET de l'Onisep (MAJ DORINE : API référencée sur api.gouv est celle de cariforef en direct donc j'inclus la BAN ? )=> j’ai rajouté la base sirene + BAN
Base SIRENE
Base Adresse nationale
Certificats Qualiopi ( DGEFP , Liste OF )
Habilitations France compétences ( France Compétences, RNCP, RS )
-Les modifications demandées par Sabrina ont été MAJ => peux tu vérif stp ?

Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
---
title: API Quiforme
tagline: Statut scolarisé et statut boursier d'un élève du primaire, collège ou lycée.
tagline: Certifications Qualiopi et habilitations France compétences
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pour uniformiser avec les autres API :

Suggested change
tagline: Certifications Qualiopi et habilitations France compétences
tagline: Vérifiez si un établissement est habilité à former en récupérant ses certifications Qualiopi et habilitations France compétences.

datapass_link: https://datapass.api.gouv.fr/TODO
access_page:
- who:
- Un particulier
- Un étudiant
- Une entreprise
is_eligible: -1
description: |
Expand All @@ -14,6 +13,7 @@ access_page:
<Button href="/rechercher-api">Rechercher une autre API</Button>
- who:
DorineLam marked this conversation as resolved.
Show resolved Hide resolved
- Une administration
- Un acteur privé habilité par une administration
DorineLam marked this conversation as resolved.
Show resolved Hide resolved
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 :
Expand All @@ -22,43 +22,50 @@ is_open: -1
is_france_connected: -1
producer: men
keywords:
- eleve
- scolarite
- scolaire
- bourse
- boursier
- etablissement
- ecole
- primaire
- college
- lycee
- enseignement
- Qualiopi
- France compétences
- Habilitations
- Certifications
- Organismes de formation
themes:
- Particulier
- Education
- Entreprises
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Entreprises
- Entreprise

- Formation
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tu peux choisir uniquement dans les thèmes suivants :

  • Administration
  • Administration & législation
  • Agriculture
  • Culture
  • Droit & Justice
  • Education
  • Emploi
  • Energie
  • Entreprise
  • Environnement
  • Géographie
  • Particulier
  • Professionnels
  • Santé
  • Sécurité
  • Transport

(à ce sujet, je suis en train de faire une PR pour proposer des templates/guides => https://github.com/betagouv/api.gouv.fr/pull/1270/files)

J'aurai donc mis en plus de entreprise et administration :

Suggested change
- Formation
- Education
- Administration & législation
- Professionnels

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merci pour la PR des templates/guides ❤️

- Administration
contact_link: [email protected]
contact_link: [email protected]/TODO
doc_tech_link: URL TODO
last_update: 10/10/2023
last_update: 10/10/2023 /TODO
---

Cette API, délivrée directement 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).
Cette API, délivrée directement par le réseau des Cariforef, permet de vérifier si un établissement est habilité à délivrer un formation certifiante Qualiopi et/ou France compétences.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Cette API, délivrée directement par le réseau des Cariforef, permet de vérifier si un établissement est habilité à délivrer un formation certifiante Qualiopi et/ou France compétences.
Cette API, délivrée directement par le réseau des Carif-Oref, permet de vérifier si un établissement est habilité à délivrer une formation certifiante, en accédant au certificat Qualiopi et aux habilitations France compétences.

**La valeur ajoutée** de cette API opérée par le réseau des CARIF OREF est :

- De connaître les certificats Qualiopi des établissements et pas uniquement des unités légales ;
de véritablement dire si un établissement est habilité à former ou à organiser des épreuves car elle indique également les habilitations France Compétences de l’établissement ;
DorineLam marked this conversation as resolved.
Show resolved Hide resolved
- D’avoir une donnée plus fiable car le réseau des Carif Oref effectue une double vérification en croisant ses bases et les bases du Ministère de l’intérieur.
DorineLam marked this conversation as resolved.
Show resolved Hide resolved
- En cas de détection d’anomalie, les Carif Oref peuvent, grâce à leurs réseaux locaux, prendre contact avec l’établissement concerné et vérifier la situation.
DorineLam marked this conversation as resolved.
Show resolved Hide resolved

Votre service utilisera d'autres API "données entreprises-associations" ? Retrouvez les données de cette API dans le bouquet d'API distribué par la DINUM [API entreprise](https://entreprise.api.gouv.fr/).
DorineLam marked this conversation as resolved.
Show resolved Hide resolved

### Sources de données

- API sirene ( incluant les données non diffusibles )
- Base Adresse nationale
- Certificats Qualiopi ( DGEFP , Liste OF )
- Habilitations France compétences ( France Compétences, RNCP, RS )



### Périmètre

#### Particuliers concernés :
#### Entreprises ou associations concernées :

Cette API concerne les ✅ élèves du primaire, du collège et du lycée.
Cette API concerne ✅ tous les établissements quelque soit leur statut, publics, à but lucratif, associatifs, etc...
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.
- ✅ établissements privés ;
- ✅ associations ;

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 :
Les établissements suivants ne sont pas couverts par l’API /TODO
- ❌ établissements privés hors contrat ;
- ❌ lycées agricoles ;
- ❌ instruction dans la famille.
Expand All @@ -68,49 +75,33 @@ Les établissements suivants ne sont pas couverts par l’API :
- ✅ 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.

Les données sont mises à jour en majorité toutes les 24h mais ce délai peut parfois passer à 72h ou plus pour des cas spécifiques.

### 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.
Cette API propose une modalité d’appel dont le paramètre suivant est obligatoire :
- SIRET

### 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.
Cette API indique si un établissement est habilité à former. Elle délivre :.

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"](https://api.gouv.fr/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 la fiche métier : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_1_api_particulier_endpoint_education_nationale_statut_eleve_scolarise|
| 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 la FAQ : https://particulier.api.gouv.fr/catalogue/education_nationale/statut_eleve_scolarise#faq_entry_answer_2_api_particulier_endpoint_education_nationale_statut_eleve_scolarise |
| 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|
| Siret de létablissement | ex: 12000101100010 |
| Code UAI de l'établissement | ex : 0123456A . Code d'unité administrative immatriculée (code UAI) de l'établissement habilité ou agrée. <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"](https://api.gouv.fr/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. |
| Unités légales avec plusieurs NDA | Dans de rares cas, l'unité légale d'un établissement peut avoir plusieurs numéros de déclaration d'activité (NDA). Tous ces numéros d'activités (qui ne sont pas fournis par cette API délivrant uniquement les NDA d'un établissement) ne sont pas forcément propagés sur les établissements. |
| Declarations activites etablissement | Informations relatives au numéro de déclaration d'activité de l'établissement (NDA). Cette clé renvoie un tableau car, dans de rares cas, un établissement peut avoir plusieurs NDA (environ 30 établissements sur 120 000) |
| Numéro de déclaration d'activité | ex: 11910843391 |
| Indique que le NDA est actif | ex: true .Ce champ indique le numéro de déclaration d'activité (NDA) de l'établissement est actif. Pour conserver un NDA valide, l'établissement doit remplir chaque année un bilan pédagogique et financier prévu à l'article L6352-11 du Code du travail. Sans cette démarche le numéro NDA devient inactif, l'établissement est retiré de la liste publique des organismes de formation. |
| Date de dernière déclaration | Cette date indique le jour où l'établissement a transmi son bilan pédagogique et financier (BPF), indispensable pour maintenir actif le numéro de déclaration d'activité (NDA). Cette date est transmise au format AAAA-MM-DD. |
| Date de début d'exercice fiscal | ex: 2021-01-30. Cette date correspond à la fin du dernier exercice fiscal analysé pour le bilan pédagogique et financier. Cette date est transmise au format AAAA-MM-DD.|
| Certification qualiopi | **Certication Action Formation** : Indique si l'établissement est certifié Action Formation / **Certification Bilan Compétences** : Indique si l'établissement est certifié Bilan Compétences / **Certification Bilan Compétences** : indique si l'établissement est certifié Bilan Compétences / **Certification VAE** : indique si l'établissement est certifié VAE (Validation des Acquis de l'Experience) / **Certification Apprentissage** : indique si l'établissement est certifié Action de Formation par Apprentissage / indique si le certificat Qualiopi est propagé depuis le SIREN de l'unité légale ex: true |
| Specialites | Informations relatives aux spécialités relevant du numéro de déclaration d'activité et figurant dans le bilan pédagogique et financier. Un établissement peut ne pas avoir de spécialités, et l'API en transmet jusqu'à trois, leur ordre n'a pas d'importance. Les spécialités possibles sont détaillées dans la documentation métier de l'API : https://entreprise.api.gouv.fr/catalogue/carif_oref/certifications_qualiopi_france_competences#faq_entry_answer_1_api_entreprise_endpoint_carif_oref_certifications_qualiopi_france_competences. Exemple : **Specialite 1** : Informations relatives à la première spécialité / **Code spécialité 1** ex: 313 Code de la première spécialité de l'établissement agrée / **Libellé spécialité 1**: Libellé de la première spécialité de l'établissement agrée ex: Finances, banque, assurances |
| Habilitations france competence | Informations relatives aux habilitations France Compétences obtenues par l'établissement. La liste des habilitations France Compétences n'est pas figée et est mise à jour régulièrement par les organismes certificateurs. Exemples : Code de l'habilitation ex: RNCP10013 / **Code de l'habilitation France Compétences** : indique si l'habilitation est active ex: true / ** Date à laquelle l'habilitation est passée en état active** ex: 2030-01-30 / **Date de fin d'enregistrement** ex: 2030-01-30 / **Date de fin d'enregistrement de l'habilitation de l'établissement agrée** : Cette date est transmise au format AAAA-MM-DD / **Date de décision** ex: 2020-01-30 / **Date de décision de l'habilitation de l'établissement agrée** : Cette date est transmise au format AAAA-MM-DD / **Habilitation à former** ex: true / Indique que cette habilitation autorise à former/préparer les candidats à une certification inscrite au répertoire national des compétences professionnelles (RNCP) ou au répertoire spécifique (RS). Cette habilitation vise à s'assurer que les organismes de formation proposant des offres de formation certifiantes, sont bien habilités à préparer des élèves à cette certification / Habilitation à organiser l'évaluation ex: true / Indique que cette habilitation autorise à mettre en place des épreuves pour évaluer les compétences des candidats visant une certification inscrite au répertoire national des compétences professionnelles (RNCP) ou au répertoire spécifique (RS) / Liste des SIRETs des organismes certificateurs ayant délivré à l'établissement les habilitations à former et/ou organiser l'évaluation de leur certification.|




## Vous avez besoin d'autres données sur les entreprises ou les associations ?
Expand Down
Loading