Topics: Batch

Batch List

Batch List

Batch List


List all batches for 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/batch-list 

Example Request:

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

Example Response:

200 OK
{
 "success": true,
    "data": {
        "batch_list": [
            {
               "id": "integer",
               "name": "string",
               "description": "string"
            }, 
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer"
        
    }
}

Courses in Batch

Courses in Batch

Courses in Batch


List all courses in a batch

Query Arguments

batchID integer The batch 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/courses-in-batch 

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/courses-in-batch \
  -H 'authorization: Bearer {Authorization Token}' \
  -F batchID={batchID}

Example Response:

200 OK
{
    "success": true,
    "data": {
        "course_batch": [
            {
               "title": "string",
               "startDate": "date",
               "endDate": "date"
            }
        ],
        "totalCount": "integer",
        "pageSize": "integer",
        "page": "integer",
    }
}

Trainees in Batch

Trainees in Batch

Trainees in Batch


List all trainees in a batch

Query Arguments

batchID integer The batch 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/trainees-in-batch

Example Request:

 curl -X POST \
  https://app.alphalearn.com/webapi/v1/trainees-in-batch \
  -H 'authorization: Bearer {Authorization Token}' \
  -F batchID={batchID}

Example Response:

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

Add Trainee to Batch

Add Trainee to Batch

Add Trainee to Batch


Add a single trainee to batch

QueryArguments

userID string The user id
batchID string Batch description
Definition:

 POST https://app.alphalearn.com/webapi/v1/add-trainee-to-batch

Example Request:

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

Example Response:

200 OK
{
    "success": true,
    "data": {
        "success": "User added to batch"
    }
}