This method will return bearer token for the authorization.
https://e-label.humanfocus.org.uk/CBT_API/Token
Client API Documentation
Token (POST)
Username = johndoe
Password = ***************
grant_type = password
GetOrganID (GET)
This method will return OrganID of the organisation.
OrganisationIdentifier will be sent as a parameter in the URL.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetOrganID/#OrganisationIdentifier#
Returns
{
“OrganID”: 12345
}
GetUserGroups (GET)
This method will return all user groups of the organisation.
OrganisationIdentifier will be sent as a parameter in the URL.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetUserGroups/#OrganisationIdentifier#
Returns
{
“UserGroups”: [
{
“UserGroupID”: 30,
“UserGroup”: “-”
},
{
“UserGroupID”: 31,
“UserGroup”: “Manual Work”
}]
}
AddUser (POST)
This method will create user.
SuperUser (1 = Normal, 3 = Contractor, 4 = Champion, 5 = Supervisor, 6 = Sub-Manager, 7 = Manager)
“Manager” is the account main admin.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/AddUser
Model
{
“OrganID”: 12345,
“PersonIdentifier”: “john123”,
“TraineeName”: “John Legend”,
“Email”: “john123@pvc.com”,
“PhoneNumber”: “+923231234567”,
“SuperUser”: 1,
“SiteLocation”: “-“,
“Department”: “-“,
“UserGroup”: [{“id” : 31, “itemName”: “Manual Work”}],
“DefaultPassword”: false,
“Password”: “12345678”
}
Returns
{
“Status”: true,
“Result”: ” john123″
}
GetUserID (GET)
This method will return UserID of the User.
OrganisationIdentifier and PersonIdentifier will be sent as the parameters in the URL.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetUserID/#OrganisationIdentifier#/#PersonIdentifier#
Returns
{
“UserID”: 110022
}
EditUser (POST)
This method will update the data for given user and return PersonIdentifier.
OrganID and UserID are the primary keys.
SuperUser (1 = Normal, 3 = Contractor, 4 = Champion, 5 = Supervisor, 6 = Sub-Manager, 7 = Manager)
“Manager” is the account main admin.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/EditUser
Model
{
“OrganID”: 12345,
“UserID”: 110023,
“PersonIdentifier” : “john”,
“TraineeName” : “John Legend”,
“Email” : “john123@hf.com”,
“PhoneNumber” : “+923231234567”,
“SuperUser” :”7″,
“SiteLocation” : “-“,
“Department” : “-“,
“UserGroup” : [{ “id” : 54321, “itemName”: “-“}]
}
Returns
{
“Status”: true,
“PersonIdentifier”: ” john ”
}
ArchiveUser (POST)
This method will archive the user.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/ArchiveUsersUM
Model
{
“OrganID”: “12345”,
“IsArchive”: “true”
}
Returns
{
“Status”: true,
“Result”: “User archived”
}
AssignUnAssignUserGroupsUM (POST)
This method will assign or unassign user groups for a specific user.
To assign user group IsAssign value should be true.
To unassign user group IsAssign value should be false.
CompetencyGroupIds should contain comma separated user group ids.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/AssignUnAssignUserGroupsUM
Model
{
“UserId”: 110023,
“CompetencyGroupIds”: “30,31,32”,
“IsAssign”: true,
}
Returns
{
“Status”: true,
“Result”: “User Group Assigned”
}
GetUserDetails (GET)
This method will get given user’s details.
OrganID and UserID and will be sent as a parameter in the URL.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetUserDetails/#OrganID#/#UserID#
Returns
{
“Status”: true,
“Result”: [
{
“OrganID”: 12345,
“CustIdent”: “TestOrgan”,
“UserID”: 110022,
“WorksIdent”: “john123”,
“TraineeAKA”: “John Legend”,
“Email”: “john123@hf.com”,
“PhoneNumber”: “+923231234567”,
“TraineeType”: “Normal”,
“SiteLocation”: “-“,
“Department”: “-“,
“UserGroups”: “-”
}
]
}
GetUsersList (GET)
This method will get all user’s list.
OrganID and SuperUser will be sent as a parameter in the URL.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetUsersList/#OrganID#/#SuperUser#
Returns
{
“Status”: true,
“Result”: [
{
“UserID”: “110022”,
“Worksident”: “john123”,
“TraineeAKA”: “John Legend”,
“EMail”: “john123@pvc.com”,
“Department”: “-“,
“SiteLocation”: “-“,
“TraineeType”: “Normal”
},
{
“UserID”: “110023”,
“Worksident”: “Mikel123”,
“TraineeAKA”: ” Mikel Broke”,
“EMail”: ” mikel123@pvc.com “,
“Department”: “-“,
“SiteLocation”: “-“,
“TraineeType”: “Normal”
}
]
}
GetAllCompletedTrainingDetails (POST)
This method will get all users completed training results (Passed/Failed).
OrganIDand UserStatus are mandatory fields and rest of all are optional for filtering the data.
FromDate and ToDate will fetch records of the courses that are completed between these dates.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetAllCompletedTrainingDetails
Model
{
“OrganID”: “12345”,
“UserName”: “”,
“TrainingID”: “”,
“SiteLocation”: “”,
“Department”: “”,
“UserGroup”: “”,
“UserStatus”: “Act”,
“FromDate”:”2020-02-04 01:00:00″,
“ToDate”:”2021-04-09 01:00:00″
}
Returns
{
“Status”: true,
“Result”: [
{
“Person_Identifier”: “john”,
“Person_Name”: “John Legend”,
“Site_Location”: “-“,
“Department”: “-“,
“User_Group”: “-“,
“Training_Provider”: “Human Focus”,
“Training_Title”: “This is a sample training title”,
“Status”: “Passed”,
“ExpiryDate”: “30-07-2023 02:48”,
“ResultDate”: “30-07-2020 02:48”,
“ContentID”: “1650”
}
]
}
GetUserTrainingResultDetail (GET)
This method will get one user’s training results.
UserID will be sent as a parameter in the URL.
Note: ResultSet2, ResultSet3 and ResultSet4 will always be empty. Please don’t use these result sets.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/GetUserTrainingResultDetail/#UserID#
Returns
{
“Status”: true,
“GetUserTrainingResultDetail”: {
“ResultSet1”: [
{
“UserID”: 110023,
“OrganID”: 12345,
“TrainingID”: “Training1”,
“TrainingTitle”: “This is a sample training title”,
“DisplayTitle”: ” Training1 – This is a sample training title “,
“LastActivityDate”: “13-09-2019 07:19”,
“ReportStatus”: “Passed”,
“Founder”: “Human Focus”,
“ValidDuration”: 12,
“ExpiryDate”: “13-09-2020 07:19”,
“ProgrammeResultDate”: “13-09-2019 07:19”,
“CertificateFileName”: “Certificate_file_path”,
“TrainingType”: “Normal”,
“TrainingStartTime”: “13-09-2019 07:16”
}
],
“ResultSet2”: [],
“ResultSet3”: [],
“ResultSet4”: []
}
}
CreateUserGroup: (POST)
This method will Add User Group.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/CreateUserGroup
Model:
{
“OrganID”:12345,
“GroupName”:”Test45″,
“GroupID”:0,
“UserID”:”844155″
}
Returns:
{
“UserGroupData”: {
“GroupID”: 5432,
“ResponseMessage”: “User Group Created Successfully.”
},
“Status”: true
}
UpdateUserGroup: (POST)
This method will Update User Group Name.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/UpdateUserGroup
Model:
{
“OrganID”: “12345”,
“GroupName”: “Some site name”
“GroupID”:1235
“USerID”:12345
}
Returns:
{
“UserGroupData”: {
“GroupID”: 5432,
“ResponseMessage”: “User Group Updated Successfully.”
},
“Status”: true
}
AssignUserToUserGroup: (POST)
This method will Assign User to User Group.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/AssignUsersToUserGroup
Model:
{
“UserIds”: “12343,12445”,
“CompetencyGroupIds”: 12346
}
Returns:
{
“UserGroupData”:”User(s) assigned to user group successfully”,
“Status”:true
}
CreateSiteLocationGroup: (POST)
This method will Add Site location.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/CreateSiteLocationGroup
Model:
{
“OrganID”:12345,
“GroupName”:”Test12345″,
“GroupID”:0,
“UserID”:”1234″
}
Returns:
{
“UserGroupData”: {
“GroupID”: 28,
“ResponseMessage”: “Site Location Created Successfully.”
},
“Status”: true
}
UpdateSiteLocationGroup: (POST)
This method will Update Site location Name.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/UpdateSiteLocationGroup
Model:
{
“OrganID”: 00,
“GroupName”: “aaa”,
“GroupID”: 00,
“UserID”: “0000”
}
Returns:
{
“UserGroupData”: {
“GroupID”: 28,
“ResponseMessage”: “Site Location Updated Successfully.”
},
“Status”: true
}
AssignUserToSiteLocationGroup : (POST)
This method will Assign User to Site location.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/AssignUsersToSiteLocationGroup
Model:
{
“UserIds”: “000,123”,
“OrganID”: 00,
“GroupId”: 000,
“GroupName”: “Way”
}
Returns:
{“UserGroupData”:”User(s) assigned to site location successfully”,
“Status”:true
}
CreateDepartmentGroup: (POST)
This method will Add Department.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/CreateDepartmentGroup
Model:
{
“OrganID”: 1234,
“GroupName”: “Test12345”,
“GroupID”: 00,
“UserID”: “12345”
}
Returns:
{
“UserGroupData”: {
“GroupID”: 40658,
“ResponseMessage”: “Department Created Successfully.”
},
“Status”: true
}
UpdateDepartmentGroup: (POST)
This method will Update Department Name.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/UpdateDepartmentGroup
Model:
{
“OrganID”: 00,
“GroupName”: “aaa”,
“GroupID”: 00,
“UserID”: “0000”
}
Returns:
{
“UserGroupData”: {
“GroupID”: 40658,
“ResponseMessage”: “Department Updated Successfully.”
},
“Status”: true
}
AssignUserToDepartmentGroup: (POST)
This method will Assign User to Department.
https://e-label.humanfocus.org.uk/CBT_API/api/cbt/AssignUsersToDepartmentGroup
Model:
{
“UserIds”: “12345,1234”,
“OrganID”: 000,
“GroupId”: 12345,
“GroupName”: “abc”
}
Returns:
{
“UserGroupData”:”User(s) assigned to department successfully”,
“Status”:true
}
AddUploadedTrainingUM: (POST)
This method used for upload External Training Records.
https://e-label.humanfocus.org.uk/CBT_API/api/AddUploadedTrainingUM
Model:
{
{
“ExpiryDate”: “3020-01-01”,
“UserID”: “004”,
“OrganID”: 0,
“ProviderID”: -1,
“ProviderName”: “not-in-list”,
“CompletionDate”: “2023-10-04T00:00:00.000Z”,
“CompletionDateMonth”: “10”,
“CompletionDateYear”: “2023”,
“CertImageURL”: “https://d31bsi8.cloront.net/CBTbyB_Cert/Ce02/O2U1? -Amz- Expires=172800&X-Amz-Algorithm”,
“TrainingID”: 0,
“TrainingTitle”: “abch”
}
Returns:
{“Status”:true,
“Result”:”Training Uploaded Successfully”
}