Users

A user in Itslearning (also known as person) is one student / teacher / administrator / etc. A user has the following properties:

Property	Description	Requirements
SyncKey	Unique identifier for this User. (also known as Synchronization Key)	Required, max length is 255.
FirstName	First name.	Required, max length is 64.
LastName	Last name.	Required, max length is 64.
UserName	The unique login username.	Required.
Password	Password of the user.
NickName	Nick Name.	Required, max length is 32.
Profile	The profile, i.e. Pupil / Teacher/ etc.	Required.
Email	Email address.
Address	Address (see below for structure).
Birthdate	Birthdate
Cellphone	Mobile phone number
Phone	Phone number

Special Properties:
Children	A list with the children of this User.	Only use when the Parent portal is enabled!
Custom Strings	Custom strings (see below).
EmailServer	Email server options (see below).
MetaData	Meta Data (see below).

Creating a new User

When creating a new User, the SyncKey must always be given. The other properties can be set later on, or when defining the object:

User newUser = new User(“syncKey”)
    {
        FirstName = “FirstName”,
        LastName = “LastName”,
        etc.
     };

Used Objects

In the properties of an User object several new objects are used, to prevent a User to just have a long list of properties. Therefore several of the properties have been grouped together in these custom objects. These objects will now be explained below:

Address

An address of a user consists of four fields:

Address Line 1
Address Line 2
Postal Code
City

These fields correspond one-on-one to the fields in Itslearning.

Custom Strings

Custom strings can be used for different purposes. They can be turned on by the administrator in the Admin section of Itslearning, and there they can also be given custom names. There are 5 custom strings available, labeled “CustomString1” to “CustomString5”.

Email server

For some implementations the users have their own Email server information. With this property the email server information can be set and retrieved from Itslearning. This information consists of:

Email (address)
Server
Port
Type
UserId
Password

Meta Data

In a recent change Users now can also have Meta Data. This data first has to be set up manually in the database, but then for specific Users this data can be set through IMS-ES. For more information see the official Itslearning IMS-ES documentation.

Functions

In the IMS-ES Template the following functions are connected to a User:

CreateUser
CreateUsers
ReadUser
ReadUsers
ReadUsersFromGroup
ReadAllUsers
UpdateUser
UpdateUsers
ReplaceUser
ReplaceUsers
DeleteUser
DeleteUsers
ChangeUserKey
ChangeUserKeys