Create or update a learner 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
candidateFirstname string The learner's first name. No
candidateLanguages string The ordered list of chosen locales for the learner. No
candidateLogin string The learner's login. No, but at least one of the fields candidateLogin, candidateRefNumber and candidateEmail must be specified
candidateName string The learner's name (family name/surname). No
candidateRefNumber string The learner's reference number. No, but at least one of the fields candidateLogin, candidateRefNumber and candidateEmail must be specified
candidateTimeZone string(50) The candidate's timezone. No
candidateValidity candidateValidity The status of the learner's account (active/disabled). No
custom string(250) Value for one of the learner's custom fields. No
enabledFrom date If the learner's account is only active during a limited period of time, the first date for which it is active. No
enabledUntil date If the learner's account is only active during a limited period of time, the last date for which it is active. No
entityGuid string(40) GUID of the learner's entity. No
entityId int Database ID of the learner's entity. No
entityName string Name of the learner's entity. No
ignoredColumn Column present in the import file but to be ignored becuse it's not relevant for this import action No
managerLogin string The manager's login. No
managerRefNumber string The manager's reference number. No
presentation longtext `Presentation` field from the learner profile. No

Filters and parameters

Name Type Description Mandatory
defaultEntityId int The ID of the entity under which all the newly created objects will be placed (default = 1). No
defaultLangCode string(6) Default language code to be used if the column `language` is absent or empty. No
disableImportFlag yesNoElement If set to `yes`, the generic import will not tag learners in the database as 'updated by the generic import'. No
enableAllLearners yesNoElement If set to `yes`, this will automatically force activated all the learners account updated by this import. This default value can be overriden by using the `candidateValidity` column for each learner. 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
traineeSearchField traineeSearchField This option is used to specify the columns that will be used as filters to find the learner. No

Examples

<actions>
	<createOrUpdateLearnerAction>
		<options>
			<traineeSearchField>
				<candidateRefNumber/>
			</traineeSearchField>
			<defaultEntityId>1</defaultEntityId>
			<defaultLangCode>en-GB</defaultLangCode>
		</options>
		<fields>
			<candidateRefNumber/><!-- Use at least the candidate RefNumber, Login, Email -->
			<candidateLogin/>
			<candidateEmail/>
			<candidateName/>
			<candidateFirstname/>
			<candidateValidity/>
			<candidateTimeZone/>
			<enabledFrom/>
			<enabledUntil/>
			<entityGuid/>
			<entityId/>
			<entityName/>
			<candidateLanguages/>
			<presentation/>
			<managerLogin/><!-- Manager Login or Refnumber enables My Team -->
			<managerRefNumber/>
			<custom> <!--custom example format -->
				<guid>FF09BDE8-1CB4-4DDB-519C-9BC9AB6B65B2</guid>
				<mandatory>yes</mandatory>
			</custom>
			<custom>
				<guid>75ACD042-50C9-3F8E-C854-2988590BC501</guid>
				<mandatory>yes</mandatory>
			</custom>
		</fields>
	</createOrUpdateLearnerAction>
</actions>

Error Messages

Message Explanation
Field […] is empty. A mandatory field was not filled.
Training with guid […] is not found. A row from the import file has provided a training GUID that does not refer to any existing training course.
Training with path code […] is not found. A row from the import file has provided a training path code that does not refer to any existing training course.
Session with guid […] is not found for this training. A row from the import file has provided a session GUID that does not refer to any existing session for this training course.
Session with title […] is not found for this training. A row from the import file has provided a session title that does not refer to any existing session for this training course.
Date […] not valid. A row from the import file has provided an invalid intervention date, with respect to the ISO 8601 date format.
Teacher with login […] is not found. A row from the import file has provided a teacher login that does not refer to any existing teacher.
Status has invalid value […], […] or […] expected. A row from the import file has provided an intervention status that is different from those defined in the intervention status field.