Préinscrire un particulier à une formation par API
POST/preinscriptions/individuals
Préinscrire un particulier. Crée uniquement une demande en attente de validation manuelle. Aucun compte apprenant, inscription, facture ou paiement n’est créé par cet appel. name, email, phone, address et profession sont obligatoires. Selon le paramétrage de votre organisme, postal_code, city, dob et city_of_birth deviennent aussi obligatoires. Le programme doit être public, les sessions publiques activées, la session non terminée et associée à ce programme. Une session déjà commencée mais non terminée reste admissible.
Permission : preinscriptions:individuals: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. |
library_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 |
Oui | Non | string ; 255 caractères max. ; 1020 octets max. |
student.address |
Oui | Non | string ; 255 caractères max. ; 1020 octets max. |
student.profession |
Oui | Non | string ; 255 caractères max. ; 1020 octets max. |
student.postal_code |
Selon paramétrage organisme | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.city |
Selon paramétrage organisme | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.dob |
Selon paramétrage organisme | Oui | string / date ; 10 caractères max. |
student.nom_naissance |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.social_security |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.financeur |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.handicap |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. ; Oui, Non |
student.gender |
Non | Oui | string ; 255 caractères max. ; Male, Female, Other |
student.department_of_birth |
Non | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.city_of_birth |
Selon paramétrage organisme | Oui | string ; 255 caractères max. ; 1020 octets max. |
student.message |
Non | Oui | string ; 16000 caractères max. ; 64000 octets max. |
Exemple de requête JSON
{
"course_id": "1",
"library_id": "1",
"student": {
"name": "Pending Exemple",
"email": "pending@example.com",
"phone": "0123456789",
"address": "12 rue Exemple",
"profession": "Technicien"
}
}
Exemple de réponse
{
"success": true,
"request_id": "req_0123456789abcdef0123456789abcdef",
"data": {
"pre_inscription_id": "601",
"state": "pending_validation"
}
}