Onboarding Users Onboarding Users

Onboarding Users

Mounika Vukkadam Mounika Vukkadam

Onboarding Users

Onboarding users are new starters at their place of employment. They require restricted access to the LMS so that they can complete content that is specifically tailored for them.

 

Create onboarding user:

Description
Creates an onboarding user. Users will receive an email and SMS containing instructions on how to access the LMS.
Request Method POST
Request URL {{base_url}}/local/acorn_onboarding/index.php/api/1/tenancies/{{tenancy_id}}/onboardingusers
Authorisation Header Bearer {api_key}

 

Request Body:

Parameter Data Type Details
firstName string required, max length 100 chars
lastName string required, max length 100 chars
email string required, max length 100 chars
mobileNumber string required, all mobile formats accepted
commencementDate date (YYYY-MM-DDTHH:MM:SSZ) required, ISO 8601 date & time format
managerFirstName string max length 100 chars
managerLastName string max length 100 chars
managerEmail string max length 100 chars
branch string max length 100 chars
location string max length 100 chars
status string max length 100 chars

 

Example Response:

{
"status": "Complete",
"data": {
"success": true
}
}

Example Error Response:

{ 
"status": "Failed",
"errors": {
"firstName": "You must provide a first name.",
"lastName": "You must provide a last name.",
"email": "Invalid email address.",
"mobileNumber": "Please provide a valid mobile number.",
"commencementDate": "Please provide a valid commencement date in ISO 8601 date and time format."
}
}

Add comment

Please sign in to leave a comment.