Create or update a session with respect to the data row from the import file.
Available columns
Name |
Type |
Description |
Mandatory |
ignoredColumn |
|
Column present in the import file but to be ignored becuse it's not relevant for this import action |
No
|
sessionAction |
enum(M, A) |
Flag to define wether the current data row should update the related session ('M') or delete it ('A'). When unset, the default behaviour is to updated it. |
No
|
sessionEndDate |
date |
The end date of the session. |
No
|
sessionGuid |
string(40) |
The GUID of the session. |
No, but at least one of the following fields must be specified: `sessionGuid` or `sessionTitle` or `sessionId`
|
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`
|
teacherLogin |
string |
Login of the teacher (back-office user) to assign as a teacher to the current intervention. |
yes
|
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)
|
trainingTitle |
string |
The title of the training course. |
No
|
Filters and parameters
Name |
Type |
Description |
Mandatory |
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
|
sessionSearchField |
sessionSearchField |
This option is used to specify the columns that will be used as filters to find the training session. |
No
|
Examples
<actions>
<createOrUpdateSessionAction>
<options>
<sessionSearchField>
<sessionTitle/><!-- Use Title, Id, or Guid as Search Field-->
<sessionId/>
<sessionGuid/>
</sessionSearchField>
<fullAccess>yes</fullAccess>
</options>
<fields>
<sessionAction/>
<trainingPathCode/><!-- Use Training Title, ID, and/or PathCode -->
<trainingId/>
<trainingTitle/>
<sessionTitle/><!-- Use Session Title, Guid, and/or ID -->
<sessionGuid/>
<sessionID/>
<sessionStatus/>
<sessionStartDate/>
<sessionEndDate/>
<teacherLogin/>
</fields>
</createOrUpdateSessionAction>
</actions>
Error Messages
Message |
Explanation |
Field [...] is empty. |
A mandatory field was not filled. |
Training with training 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. |
Field trainingPathCode is empty. |
A row from the import file has provided an empty trainingPathCode. |
Group with name [...] is duplicated. |
A row from the import file has provided a group name that does not refer to a duplicated group. Please consider using the GUID to identify the group. |
Invalid sessionAction value: [...] |
A row from the import file has provided a value that is different from the allowed values in the sessionAction field. |