Topics: Trainees

Register Trainee

Register Trainee

Register Trainee


Register as a new trainee

QueryArguments

fname string Fisrtname of the user
lname string Lastname of the user
mobile integer Mobile number of the user
email string Email of the user
Definition:

 POST https://app.alphalearn.com/webapi/v1/signup

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/signup\
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK
{
    "success": true,
    "data": {
        "user": {
            "id": "integer",
            "title": "string",
            "fname": "string",
            "lname": "string",
            "mobile": "9664131394",
            "email": "string",
            "password": "string",
            "auth_key": "string",
            "password_reset_token": "string",
            "password_reset_date": "date",
            "rollno": "string",
            "department": "string",
            "designation": "string",
            "grade": "string",
            "state": "integer",
            "companyname": "string",
            "subcompanyID": "integer",
            "companyManagerID": "integer",
            "workphone": "string",
            "address": "string",
            "city": "string",
            "zip": "string",
            "country": "string",
            "companyID": "integer",
            "roleID": "integer",
            "createdBy": "integer",
            "createdDate": "date",
            "updatedDate": "date",
            "status": "integer",
            "gstno": "string",
            "sessionID": "string"
        },
    }
}

Enroll Trainee

Enroll Trainee

Enroll Trainee


Enroll a single trainee to a course.

QueryArguments

userID integer The user id
courseID integer The course id
Definition:

 POST https://app.alphalearn.com/webapi/v1/enroll-trainee

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/enroll-trainee\
  -H 'authorization: Bearer {Authorization Token}' \
  -F {
       userID={userID},
       courseID={courseID}
     }

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee enrolled"
    }
}

Trainee List

Trainee List

Trainee List


List trainees in a company

QueryArguments

totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

 POST https://app.alphalearn.com/webapi/v1/trainee-list 

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/trainee-list \
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK
{
    "success": true,
    "data": {
        "user_list": [
            {
                "id": "integer",
                "rollno": "integer",
                "title": "string",
                "fname": "string",
                "lname": "string",
                "email": "string"
            },
      ],
        "totalCount": "integer",
        "page": "integer",
        "pageSize": "integer"
  }
}

Trainee Profile

Trainee Profile

Trainee Profile


Retrieve a single trainee basic details

QueryArguments

userID integer The user id
totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

 POST https://app.alphalearn.com/webapi/v1/trainee-profile

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/trainee-profile\
  -H 'authorization: Bearer {Authorization Token}' \
  -F userID={userID}

Example Response:

200 OK
{
   "success": true,
    "data": [
        {
        "id": "integer",
        "fname": "string",
        "lname": "string",
        "email": "string",
        "rollno": "intger",
        "grade": "string",
        "companyname": "string",
        "workphone": "intger",
        "address": "string",
        "timezone": "string",
        "department": "string",
        "city": "string",
        "states": "string",
        "country": "string",
        "zip": "string",
        "zone": "string"
        },   
    ]
}

Trainee Details

Trainee Details

Trainee Details


Course list for a particular user who is logged in

QueryArguments

totalCount Total number of records
pageSize Number of returned records in current api call
page Current page number of returned records
Definition:

 POST https://app.alphalearn.com/webapi/v1/trainee-details 

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/trainee-details \
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK
{
    "success": true,
    "data": {
        "ongoing": [
            {
                "title": "string",
                "courseCode": "string",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "expired": [
            {
                "title": "string",
                "courseCode": "string",
                "completedPercent": "integer",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "complted": [
            {
                "title": "string",
                "courseCode": "string",
                "completedPercent": "string",
                "startDate": "date",
                "endDate": "date",
                "isachived": "integer",
                "achivedDate": "datetime"
            }
        ],
        "learningpaths": {
            "learningpath_name": [
                {
                    "id": "integer",
                    "name": "string",
                    "code": "string",
                    "title": "string",
                    "courseCode": "string",
                    "completedPercent": "integer",
                    "startDate": "date",
                    "endDate": "date",
                    "isachived": "integer",
                    "achivedDate": "datetime"
                }
            ]
        },
        "exam": [
            {
                "examTitle": "string",
                "duration": "integer",
                "total_questions": "integer",
                "total_marks": "integer",
                "passingMarks": "integer",
                "startDate": "date",
                "endDate": "date",
                "attemptDate": "datetime",
                "submitDate": "datetime",
                "scheduledon": "datetime",
                "status": "integer"
            }
        ]
    }
}

Update Trainee Profile

Update Trainee Profile

Update Trainee Profile


Update a single trainee basic details

QueryArguments

userID integer The user id
fname string Firstname of the user
lname string Lastname of the user
mobile number Contact number of the user
city integer City of the user
Country integer Country of the user
state integer State of the user
status integer Status of the user
Definition:

 POST https://app.alphalearn.com/webapi/v1/user-update?userid=

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/user-update?userid= \
  -H 'authorization: Bearer {Authorization Token}' \

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "User details Updated."
    }
}

Delete Trainee

Delete Trainee

Delete Trainee


Delete a trainee user

QueryArguments

userID integer The user id
Definition:

 POST https://app.alphalearn.com/webapi/v1/delete-trainee

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/delete-trainee \
  -H 'authorization: Bearer {Authorization Token}' \
  -F userID={userID}

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee deleted."
    }
}

Disable Trainee

Disable Trainee

Disable Trainee


Disable a trainee.

QueryArguments

userID integer The user id
Definition:

 POSThttps://app.alphalearn.com/webapi/v1/disable-trainee

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/disable-trainee\
  -H 'authorization: Bearer {Authorization Token}' \
  -F userID={userID}

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "Trainee disabled."
    }
}

Unenroll Trainee

Unenroll Trainee

Unenroll Trainee


Un enroll a trainee from a

QueryArguments

userenrollIDinteger The user enrollment id
Definition:

 POST https://app.alphalearn.com/webapi/v1/unenroll-trainee

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/unenroll-trainee \
  -H 'authorization: Bearer {Authorization Token}' \
  -F userID={userID}

Example Response:

200 OK
{
"success": true,
"data": {
"success": "Trainee unenrolled."
}
}/pre>