Inscrire un apprenant à une session par API
POST/enrollments/students
Inscrire immédiatement un apprenant. Inscription immédiate, sans étape de validation manuelle : crée/réutilise l’apprenant puis l’inscription dans la session course_id. price, type et payment_source sont obligatoires. La classification de la session est héritée automatiquement. Une inscription compatible est réutilisée ; un contrat/payeurs/prix incompatible provoque une erreur 409.
Permission : enrollments:students:create. Les deux jetons restent obligatoires.
Champs de la requête
| Champ | Obligatoire | Null autorisé | Type, limites, valeurs et défaut |
|---|---|---|---|
course_id |
Oui | Non | string / id ; 19 caractères max. |
student |
Oui | Non | object |
student.name |
Oui | Non | string ; 255 caractères max. ; 1020 octets max. |
student.email |
Oui | Non | string / email ; 255 caractères max. ; 1020 octets max. |
student.phone |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.address |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.birth |
Non | Oui | string / date ; 10 caractères max. |
student.city_of_birth |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.country_of_birth |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.department_of_birth |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.gender |
Non | Oui | string ; 255 caractères max. ; Male, Female, Other |
student.description |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.status |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. ; Employé, Non salarié, Indépendant, Particulier |
student.company_id |
Non | Oui | string / id ; 19 caractères max. |
student.function |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.profession |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.raison_sociale |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.vat_number |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.siret |
Non | Oui | string / siret ; 255 caractères max. ; 1020 octets max. |
student.social_security |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.socio_prof |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.contract_nature |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.salary |
Non | Oui | string / decimal ; 11 caractères max. |
student.handicap |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. ; Oui, Non |
student.profession_single |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
student.external_id |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.city |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.code_postal |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.street |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.country_code |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.nom_naissance |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.numero_rpps |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.numero_ordinal |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
enrollment |
Oui | Non | object |
enrollment.price |
Oui | Non | string / decimal ; 11 caractères max. |
enrollment.type |
Oui | Non | string ; 16000 caractères max. ; 64000 octets max. ; Salariés d’employeurs privés hors apprentis, Apprentis, Personnes en recherche d'emploi formées par votre organisme de formation, Particuliers à leurs propres frais formés par votre organisme de formation, Autres stagiaires |
enrollment.subrogation |
Non | Non | string ; 16000 caractères max. ; 64000 octets max. ; yes, no ; défaut "no" |
enrollment.sous_traitance |
Non | Non | string ; 16000 caractères max. ; 64000 octets max. ; yes, no ; défaut "no" |
enrollment.sous_traite |
Non | Non | string ; 16000 caractères max. ; 64000 octets max. ; yes, no ; défaut "no" |
enrollment.payment_source |
Oui | Non | string ; 16000 caractères max. ; 64000 octets max. ; des entreprises pour la formation de leurs salariés, des contrats d'apprentissage, des contrats de professionnalisation, de la promotion ou de la reconversion par alternance, des congés individuels de formation et des projets de transition professionnelle, du compte personnel de formation, des dispositifs spécifiques pour les personnes en recherche d'emploi, des dispositifs spécifiques pour les travailleurs non-salariés, du plan de développement des compétences ou d'autres dispositifs, des pouvoirs publics pour la formation de leurs agents (Etat, collectivités territoriales, établissements publics à caractère administratif), Instances européennes, Etat, Conseils régionaux, Pôle emploi, Autres ressources publiques, de contrats conclus avec des personnes à titre individuel et à leurs frais, de contrats conclus avec d'autres organismes de formation (y compris CFA), Autres produits au titre de la formation professionnelle |
enrollment.code_cpf |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
enrollment.validity |
Non | Oui | string / date ; 10 caractères max. |
enrollment.diploma_number |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
enrollment.custom_duration_hours |
Non | Oui | string / decimal ; 11 caractères max. |
enrollment.custom_duration_days |
Non | Oui | string / decimal ; 11 caractères max. |
Exemple de requête JSON
{
"course_id": "1",
"student": {
"name": "Élodie Exemple",
"email": "elodie@example.com",
"numero_rpps": "00012345",
"numero_ordinal": "001"
},
"enrollment": {
"price": "0",
"type": "Particuliers à leurs propres frais formés par votre organisme de formation",
"payment_source": "de contrats conclus avec des personnes à titre individuel et à leurs frais"
}
}
Exemple de réponse
{
"success": true,
"request_id": "req_0123456789abcdef0123456789abcdef",
"data": {
"student_id": "201",
"course_id": "1",
"student_junction_id": "401",
"student_status": "existing",
"enrollment_status": "created"
}
}