Create Or Update Learner Action

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
`candidatePassword`	string	The learner's password (a random password will be generated if a new account is created and no password is provided).	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). This parameter takes priority over `enabledFrom` and `enabledUntil`, but can be overriden by `enableAllLearners`	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, and takes priority over `candidateValidity`.	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	Error level	Explanation
`Field […] is empty.`	ERROR	A mandatory field was not filled.
`The "validity" field value […] is not allowed.`	ERROR	A row from the import file has provided an invalid “candidateValidity” value.
`The login: […] already exists. The user name will be: […]`	WARNING	A row from the import file tries to update a learner and assign them a login already taken.
`Date format is not valid`	ERROR	Custom date format option “dateFormat” is invalid or could not be parsed.
`enabledUntil is inferior to enabledFrom or vice versa`	ERROR	Attempting to assign a row where the field “enabled from” is set after the field “enabled to”.
`Entity with name [...] not found.`	ERROR	Attempting to assign a row where the field “entityName” does not match any existing entity.
`Entity with name [...] is duplicated.`	ERROR	Attempting to assign a row where the field “entityName” is not unique and matches more than one existing entity.