API Public

Vous trouverez ici les routes permettant de récupérer des infos pour un apprenant.

Synchroniser un calendrier de groupe au format ICS

POST {{URL}}/api/sync/v1/calendar-group-ics

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
groupId	string	code du groupe transmis précédemment
calendarUrl	string	lien calendrier ics

Response

200: OK

Récupérer les notes et les validations de compétences d'un apprenant

GET {{URL}}/api/v1/grades

Query Parameters

Un des deux est obligatoire

Name	Type	Description
studentId*	String	L'id de l'utilisateur dans votre SI
email	String	L'email de l'utilisateur

200: OK

// La réponse sera de type et vous permet d'accéder à la moyenne globale et aussi à la moyenne par bloc

{
    "studentName": "Prénom nom de l'apprenant",
    "userId": "id dans le SI Campus skills",
    "sessions": [
        "sessionId": "id de la session dans le SI Campus skills",
	"sessionName": "nom de la session",
	"autoValidationMean": "Moyenne autoévaludation",
	"validationMean": "Moyenne évaluation",
	"companyValidationMean": "Moyenne validation tuteur entreprise",
        "blocks": [
		"blockId": "id dans le SI Campus skills",
		"blockName": "CONSEIL EN INGÉNERIE IMMOBILIER",
		"autoValidationMean": "Moyenne autoévaludation",
	        "validationMean": "Moyenne évaluation",
	        "companyValidationMean": "Moyenne validation tuteur entreprise",
		"skills": [
		{
							"skillName": "Nom de la compétence",
							"autoValidationScore": "Score d'autoevaluation",
							"autoValidationGrade": "Note d'autoevaluation de la compétence sur 1",
							"autoValidationLegend": "Signification sur l'échelle du score",
							"validationGrade": "Note d'evaluation par le centre sur 1",
							"validationLegend": "Signification sur l'échelle du score",
							"validationScore": "Score d'evaluation",
							"companyValidationScore": "Score d'evaluation par l'entreprise",
							"companyValidationGrade": "Note d'evaluation par l'entreprise sur 1",
							"companyValidationLegend": "Signification sur l'échelle du score",
	       },
        ],
        
    ],

}

Récupérer l'avancement des livrets pour une session

GET {{URL}}/api/v1/get-training-progress-by-students

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Example Request

{
  "codeSchool": "identifiant de l'ecole précédemment transmis",
}

// La réponse sera un tableau des contrats des apprenants

[
    {
        "_id": "j5LxLDrPPtu4GtHFj",
        "studentName": "Agathe BATEAU",
        "tutorName": "Eric VOITURE",
        "tutorSchoolName": "Julie AVION",
        "companyName": " APPLE",
        "reports": [
            {
                "name": "Intégration en entreprise",
                "reportDone": true,
                "isLate": true,
                "dateOfReport": "2023-09-27T00:00:00.000Z"
            },
         {
                "name": "Attestation d'expérience au milieu professionnel",
                "reportDone": false,
                "isLate": false,
                "dateOfReport": "2025-05-07T07:17:00.000Z"
            },
            ...

Synchroniser les absences d'un apprenant

POST {{URL}}/api/sync/v1/absences-for-student

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
email	string*	email de l'apprenant
data	array*	Liste d'absence
data.$.dateDebut	string*	Date de début au format DD/MM/YYYY-HH:mm
data.$.dateFin	string*	Date de fin - Date de début au format DD/MM/YYYY-HH:mm
data.$.type	string*	type ( absenceou retard)
data.$.isJusitifie	boolean*
data.$.motif	string

Response

200: OK