User

Timezone List

Use this API to get the list of all timezones.

 GET /user/timezone-list

Query string parameters

No Parameters

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "America/Adak": "(GMT-10:00) America/Adak (Hawaii-Aleutian Standard Time)",
                "America/Atka": "(GMT-10:00) America/Atka (Hawaii-Aleutian Standard Time)",
                "America/Anchorage": "(GMT-9:00) America/Anchorage (Alaska Standard Time)",
                           },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
data	JSON Array	Timezone object

Error Codes

For general error details, click here.

Language List

Use this API to list all languages.

 GET /user/language-list

Query string parameters

No Parameters

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": [
                {
                    "langId": "el-GR",
                    "name": "Ελληνικά"
                },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
data	JSON Array	Language object

Error Codes

For general error details, click here.

User List

Use this API to list all Trainees.

 GET /user/user-list

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned starting from the first record. Default: 20, Max count limit: 50
q	string	Filter data by user name, email.

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userList": [
                    {
                        "userId": 2,
                        "firstName": "Rajesh",
                        "lastName": "Kumar",
                        "email": "admin@horizzon.com",
                        "countryCode": "+91",
                        "mobile": "+919876543210",
                        "uniqueId": "100001",
                        "role": "Admin"
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	integer	user ID
firstName	string	First Name
lastName	string	Last Name
email	string	Email Address
countryCode	string	geographical codes
mobile	string	contact number
uniqueId	string	roll number
role	integer	the role
totalRecords	integer	record count

Error Codes

Code	Description
1003	"Missing password"
1004	"Invalid password"
1005	"Missing domain"
1006	"Invalid domain"

For general error details, click here.

User Details

Use this API to get details of an individual user.

 GET /user/{userId}/detail

Query string parameters

Field	Type	Description
firstRecord required	integer	First record to return. Default: 1
count required	integer	Number of records to be returned starting from the first record. Default: 20, Max count limit: 50
q	string	Filter data by user name, email.

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userList": [
                    {
                        "userId": 2,
                        "firstName": "Rajesh",
                        "lastName": "Kumar",
                        "email": "admin@horizzon.com",
                        "countryCode": "+91",
                        "mobile": "+919876543210",
                        "uniqueId": "100001",
                        "role": "Admin"
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	integer	user ID
firstName	string	First Name
lastName	string	Last Name
email	string	Email Address
countryCode	string	geographical codes
mobile	string	contact number
uniqueId	string	roll number
role	integer	the role
totalRecords	integer	record count

Error Codes

Code	Description
1003	"Missing password"
1004	"Invalid password"
1005	"Missing domain"
1006	"Invalid domain"

For general error details, click here.

User Create

Use this API to create a user in the LMS.

 POST /user/create

Request body parameters

Field	Type	Description
title	string	Title. It should be Mr, Mrs, Ms, Dr, Prof
firstName required	string	First Name
lastName required	string	Last Name
email	string	Email Address
countryCode	string	Country code
mobile	string	Mobile Number
userCanChoosePassword required	integer	0-no, 1-Yes
password	string	If userCanChoosePassword = 1 than set password.
uniqueId	string	EmployeeID OR Roll no
roleId required	integer	Role ID i.e Trainee = 3
reportingTo	integer	ID of the reporting person
companyName	string	Company Name
department	integer	Department ID
designation	integer	Designation ID
zipcode	string	Pincode
city	integer	City ID
state	integer	State ID
country	integer	Country ID
timezone	string	Timezone
language	string	Language e.g en-Us
sendEmailNotification	integer	1 – Yes, 0 – No

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userId": "126"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	integer	user ID

Error Codes

Code	Description
1007	"Missing firstName"
1008	"Invalid firstName"
1009	"Missing lastName"
1010	"Invalid lastName"
1015	"Invalid mobile"
1016	"Missing city/state/country"
1017	"Invalid city/state/country"
1018	"Missing password"
1019	"Password does not meet the requirements! It must be alphanumeric and atleast 8 characters long"
1020	"Missing email"
1021	"Invalid email"
1022	"Missing mobile"
1023	"Email address provided already exist. Please provide another email address"
1024	"Invalid title. It should be Mr, Mrs, Ms, Dr, Prof"
1028	"Missing sendEmailNotification"
1029	"Invalid sendEmailNotification"
1036	"Missing countryCode"
1037	"Invalid countryCode"
1038	"Missing timezone"
1039	"Invalid timezone"
1040	"Missing language"
1041	"Invalid language"
1044	"Missing userCanChoosePassword"
1045	"Invalid userCanChoosePassword"
1046	"Missing uniqueId"
1047	"Invalid uniqueId"
1048	"Missing roleId"
1049	"Invalid roleId"
1052	"Missing reportingTo"
1053	"Invalid reportingTo"
1054	"Missing companyName"
1055	"Invalid companyName"
1055	"Missing zipCode"
1056	"Invalid zipCode"

For general error details, click here.

User Update

Use this API to update details of a user.

 PUT /user/{userId}/update

Path parameters

Field	Type	Description
userId required	string	A single user ID

Query string parameters

Field	Type	Description
firstName	string	First Name
lastName	string	Last Name
companyName	string	CompanyName
department	integer	Department ID
designation	integer	Designation ID
mobile	string	Contact Number
city	integer	City ID
state	integer	State ID
country	integer	Country ID
timezone	string	Timezone
language	string	Language eg: en-US
status	integer	1 – Enable, 0 – Disable, 2 – Delete

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": null,
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	string	Token

Error Codes

Code	Description
1001	"Missing userId"
1002	"Invalid userId"
1008	"Invalid firstName"
1010	"Invalid lastName"
1012	"Invalid department"
1014	"Invalid designation"
1015	"Invalid mobile"
1016	"Missing city/state/country"
1017	"Invalid city/state/country"
1022	"Missing mobile"
1038	"Missing timezone"
1039	"Invalid timezone"
1040	"Missing language"
1041	"Invalid language"
1042	"Missing status"
1043	"Invalid status"

For general error details, click here.

Frontend Signup

Use this API to register a new Trainee from a frontend website.

 POST /user/signup

Request body parameters

Field	Type	Description
title	string	Title. It should be Mr, Mrs, Ms, Dr, Prof
firstName required	string	First Name
lastName required	string	Last Name
email required	string	Email Address
countryCode required	string	Country code
mobile required	string	Mobile Number
ipAddress required	string	IP Address
sendEmailNotification required	integer	1 – Yes, 0 – No
receiveVerificationEmailOn required	integer	1 – Yes, 0 – No
password	string	If userCanChoosePassword = 1 than set password.
city	integer	City ID
state	integer	State ID
country	integer	Country ID
reCaptchaToken	string	Token

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userId": "126"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	string	Token

Error Codes

Code	Description
1007	"Missing firstName"
1008	"Invalid firstName"
1009	"Missing lastName"
1010	"Invalid lastName"
1015	"Invalid mobile"
1016	"Missing city/state/country"
1017	"Invalid city/state/country"
1020	"Missing email"
1021	"Invalid email"
1022	"Missing mobile"
1023	"Email address provided already exist. Please provide another email address"
1024	"Invalid title. It should be Mr, Mrs, Ms, Dr, Prof"
1025	"Missing ipAddress"
1026	"Invalid ipAddress"
1028	"Missing sendEmailNotification"
1029	"Invalid sendEmailNotification"
1030	"Signup email template was not found"
1034	"Missing receiveVerificationEmailOn"
1035	"Invalid receiveVerificationEmailOn"
1036	"Missing countryCode"
1037	"Invalid countryCode"

For general error details, click here.

Signup Verification

Use this API to verify Trainee registeration done from frontend website.

 POST /user/signup-verify

Request body parameters

Field	Type	Description
token required	string	Token
password required	string	Password

Response

{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userId": "126"
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Schema

Field	Type	Description
userId	string	user ID

Error Codes

Code	Description
1018	"Missing password"
1019	"Password does not meet the requirements! It must be alphanumeric and atleast 8 characters long"
1030	"Signup email template was not found"
1031	"Missing token"
1032	"Invalid token"
1033	"Token expired. Please singup again and use the new token"

For general error details, click here.