Open eLMS API
Support > Open eLMS API > Edit User Accounts
Edit user accounts
URL
https://openelms.e-learningwmb.co.uk/{SITE_ID}/backend/users/{USER_ID}
Method
PUT
Description
Updates new user account
Note: groups_id can be a comma separated string of group ids to assign multiple groups, if groups_id is set to an empty string then it will remove that user from all groups. If the user is assigned to a group which has learning assigned to it, then the new user will automatically have that learning assigned to their account.
Form Data
We have separated the form data into different categories for ease of use:
Required fields
fname - User's first name
lname - User's last name
username - User's username
email - User's email
password - User's password
Optional fields
department - User's department (created if not found in the database)
department_address - Department address
department_postcode - Department post code
city - User's city (created if not found in the database)
company - User's company (created if not found in the database)
country - User's country (created if not found in the database)
job - Job title (created if not found in the database)
groups - groups can be a comma separated string of groups to assign multiple groups.
phone - User's phone
week_hours - Working Week hours
manager_name - Manager's name
manager_job_title - Manager's job title
manager_email - Manager's email
ILR main fields
AddLine1
AddLine2
AddLine3
AddLine4
Postcode
Sex (M or F)
Ethnicity - ethnicity (a numeric id, * check to see how to retrieve the id value)
LLDDHealthProb - disability status (a numeric id, * check to see how to retrieve the id value)
DateOfBirth
NINumber - National Insurance number
ILR Employment Status fields
EmployerX_EmpStat - Employment status
EmployerX_DateEmpStatApp - Date employment status applies (date, will try to parse any format)
EmployerX_EmpId - Employer identifier
EmployerX_AgreeId - Agreement identifier
ILR Employment Status Monitoring fields
EmployerX_SEI - Is the learner self employed? (set to 1 if yes)
EmployerX_PEI - Was the learner in full time education or training prior to enrolment? (set to 1 if yes)
EmployerX_SEM - Small Employer (set to 1 if yes)
EmployerX_LOU - Length of unemployment (a numeric id, * check to see how to retrieve the id value)
EmployerX_BSI - Benefit status indicator (a numeric id, * check to see how to retrieve the id value)
EmployerX_EII - Employment intensity indicator (a numeric id, * check to see how to retrieve the id value)
EmployerX_LOE - Length of employment (a numeric id, * check to see how to retrieve the id value)
Note: X can be any number between 1 and 5. In other words you can up to five employment status records by using Employer1_{field_name}, Employer2_{field_name}, etc.
* Retrieving valid values for numeric ids
Possible values of numeric ids can be retrieved through the following service:
GET backend/user/fields
It results in a JSON which contains all the possible values for each user field, as well as their labels
Return value
User id
An example of our diverse client list ...