Register a learner to a session with respect to the data row from the import file.

Available columns

Name Type Description Mandatory
candidateEmail string The learner's e-mail address. No, but at least one of the fields `candidateLogin`, `candidateRefNumber` and `candidateEmail` must be specified
candidateLogin string The learner's login. No, but at least one of the fields candidateLogin, candidateRefNumber and candidateEmail must be specified
candidateRefNumber string The learner's reference number. No, but at least one of the fields candidateLogin, candidateRefNumber and candidateEmail must be specified
ignoredColumn Column present in the import file but to be ignored becuse it's not relevant for this import action No
registerFlag registerFlag Optional flag to allow to unregister a learner from a session. By default the behaviour for this field is to register the learner. Please see the dedicated page for more details. No
registrationDate datetime The date of the registration. No
registrationGuid string(40) The GUID of the registration. No
sessionEndDate date The end date of the session. No
sessionId int The database ID used to identify the session. No, but at least one of the following fields must be specified: `sessionGuid` or `sessionTitle` or `sessionId`
sessionStartDate date The start date of the session. No
sessionTitle string The title of the session. No, but at least one of the following fields must be specified: `sessionGuid` or `sessionTitle` or `sessionId`
trainingId int The database ID used to identify the training course. No, but at least one of the following fields must be specified: `trainingId` or `trainingGuid` or `trainingPathCode` (not all these fields might be available in each provider)
trainingPathCode string The reference number of the training course. No, but at least one of the following fields must be specified: `trainingId` or `trainingGuid` or `trainingPathCode` (not all these fields might be available in each provider)

Filters and parameters

Name Type Description Mandatory
dontUpdateExistingSessions yesNoElement Define if the import task is allowed to update the sessions already in the database (option equivalent to fullAccess). No
fullAccess yesNoElement If set to `no`, the import will only update the data which have been previously created or updated by the generic import itself. No
reactivateRegisteredLearners yesNoElement By default (value unspecified or set to 'yes'), the action RegisterLearner will automatically reactivate the accounts of all the learners affected by the import. This option needs to be set to 'no' to keep the learners activation status untouched. No
sessionSearchField sessionSearchField This option is used to specify the columns that will be used as filters to find the training session. No
traineeSearchField traineeSearchField This option is used to specify the columns that will be used as filters to find the learner. No
trainingSearchField trainingSearchField This option is used to specify the columns that will be used as filters to find the training course. No

Examples

<actions>
	<registerLearnerAction>
		<options>
			<traineeSearchField>
				<candidateRefNumber/>
			</traineeSearchField>
			<trainingSearchField hasResults="yes">
				<trainingPathCode/>
			</trainingSearchField>
			<sessionSearchField>
				<sessionTitle/>
				<sessionStartDate/>
			</sessionSearchField>
		</options>
		<fields>
			<candidateRefNumber/><!-- Must have Candidate Ref Number, Email or Login -->
			<candidateEmail/>
			<candidateLogin/>
			<trainingPathCode/><!-- Must have Training PathCode or Id --> 
			<trainingId/>
                	<sessionTitle/><!-- Must have Session Title or Id --> 
			<seesionId/>
			<sessionStartDate/>
			<sessionEndDate/>
			<registerFlag><!-- Must have registration Flag -->
				<keepSession>Y</keepSession>
			</registerFlag>
			<registrationGuid/>
                        </registrationDate>
		</fields>
	</registerLearnerAction>
</actions>

Error Messages

Message Explanation
Field [...] is empty. A mandatory field was not filled.
The training could not be found and it is mandatory. The filters provided by a row from the import file failed to refer to any existing training course.
Start date [...] not valid. A row from the import file has provided an invalid sessionStartDate, with respect to the dateFormat defined above.
End date [...] not valid. A row from the import file has provided an invalid sessionEndDate, with respect to the dateFormat defined above.
Register flag has invalid value [...], [...] or [...] expected. A row from the import file has provided a flag that is different from those defined in the registerFlag field.
The session can not be found and it's mandatory. The filters provided by a row from the import file failed to refer to any existing session.
No search field was provided to find the candidate. All the columns containing information about the learner were empty on a specific row;or the traineeSearchField was empty.
The candidate was not found. A row from the import file has provided learner information that does not refer to any existing learner.
The candidate was not detected as a input data, object of type [...] provided.  
Cannot create a session without valid training course. The filters provided by a row from the import file failed to refer to any existing training course.
The session could not be created or retrieved from the database. An unexpected error occured during the retrieval or the creation of the session.
The learner is already registered to this training session. The learner is already registered to the given training course session.
The candidate is not registered to this training. A row from the import file is attempting to unenroll a learner from a training course session, but they were not enrolled there in the first place.