Api EOL Documentation

API EOL - End-of-Learning Survey

API for recording responses to post-training satisfaction surveys. Primarily used by Qualtrics for automated data collection into CONSOLIDATION_EOL.

Access to this API is restricted to authorized users. Access requires a specific authorization defined by the "api-eol" scope. If you haven't already done so, we suggest you follow the registration steps explained in the "Register your application" section.

For developers and other engineering teams, an Open API documentation generated by Swagger is available at this URL:
https://eol.api.cegos.fr/swagger/

EOL Data Flow

How EOL data flows from CONSOLIDATION_EOL to Qualtrics surveys

CONSOLIDATION_EOL Azure Hybrid Connection Api EOL Qualtrics
GET /v1/EOL endpoints

Survey

POST /v1/Survey

Purpose:
POST /v1/Survey
Submit End-of-Learning survey responses from training participants to Cegos system
Content-Type: application/json

Purpose:
Database Implementation
Database
CONSOLIDATION_EOL
Stored Procedure
Direct INSERT via Dapper ORM (no stored procedures)
Tables Used
Survey responses table (exact name to be validated with repository)
Business Logic: End-of-Learning satisfaction survey responses recording. Conditional validation: either RegistrationNumber or CaseNumber must be provided (RequiredIfRelatedIsNull). Each response is saved individually with automatic timestamp. API primarily used by Qualtrics (Cegos low-code provider).

Purpose: Survey request containing participant information and training evaluation responses with conditional validation rules based on SurveyRequest DTO.
Request Fields
Required Fields
Field Type Description Validation Example
partner string Partner identifier (training provider) [Required] "PARTNER_ABC"
businessModel string Business model type for the training [Required]. Possible values: Inter, Ipack, Ls "Inter"
responses array[ResponseRequest] Collection of survey question responses [Required]. Must contain at least one response [{"questionId": "Q1", "value": "Excellent"}]
responses[].questionId string Unique identifier for survey question [Required] within each Response object "Q1"
Optional Fields
Field Type Description Database Mapping Example
registrationNumber string Training registration number that links survey to specific training session RegistrationNumber → Survey responses table.RegistrationNumber "REG123456"
caseNumber string Cegos case number (required if registrationNumber is null) CaseNumber → Survey responses table.CaseNumber "CASE78910"
userId string Cegos user identifier UserId → Survey responses table.UserId "USER_123"
userMail string Participant email address UserMail → Survey responses table.UserMail "participant@company.com"
userLastName string Participant last name UserLastName → Survey responses table.UserLastName "Dupont"
userFirstName string Participant first name UserFirstName → Survey responses table.UserFirstName "Jean"
eventRef string Session/event reference identifier EventRef → Survey responses table.EventRef "EVENT_2024_001"
partnerUserId string User identifier in partner system PartnerUserId → Survey responses table.PartnerUserId "PARTNER_USER_456"
partnerSessionId string Session identifier in partner system PartnerSessionId → Survey responses table.PartnerSessionId "PARTNER_SESSION_789"
surveyPdf string URL to survey PDF version Not mapped to database "https://partner.com/survey.pdf"
surveyId string Survey template identifier Not mapped to database "SURVEY_TEMPLATE_001"
responses[].value string Participant's answer to the question Value → Survey responses table.Value "Excellent"

Purpose: End-of-Learning submission endpoint returns only HTTP 200 OK status without response content to confirm successful data recording in CONSOLIDATION_EOL.
End-of-Learning Survey Flow
Automated collection of post-training satisfaction survey responses via Qualtrics to CONSOLIDATION_EOL database
Qualtrics (Low-Code Platform) API EOL (Azure) Azure Hybrid Connection CONSOLIDATION_EOL Business Intelligence
Response Fields
Field Type Description Database Source
HTTP Status Integer Always returns 200 OK on successful survey submission N/A
Data Source:
Usage:
Example Response