Skip to main content

Course

Course List​

Use this API to get the list of all courses.

 GET /course/course-list

Query string parameters​

FieldTypeDescription
firstRecord
required
integerFirst record to return. Default: 1
count
required
integerNumber of records to be returned starting from the first record. Default: 20, Max count limit: 100
filterDataJSON ArraySearch record with following filters:
  1. courseId
  2. courseCode
  3. eligibleForSale (0 – no,1 – yes)
  4. Status
  5. courseType (0- single subject, 1 – multi subject)
  6. Generic
  7. sortByfield (newest/popular/duration/rating)
  8. sortType (asc/desc)
{
    "field": {
        "courseId": [],
        "categoryId": [32, 33],
        "title": "string",
        "courseCode": "string",
        "eligibleForSale": 0,
        "status": 1,
        "courseType": 1
    },
    "generic": "string",
    "sortByfield": "string",
    "sortType": "string"
}
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "courseList": [
                    {
                        "courseId": 12,
                        "title": "Wonderchef Product Training",
                        "courseType": "Multiple Subject",
                        "durationInDays": 30,
                        "courseCode": "WT001",
                        "description": "Test",
                        "trainer": "Mr. Rajesh",
                        "thumbnail": null,
                        "eligibleForSale": true,
                        "status": true,
                        "availableFrom": "01-01-2018",
                        "availableTill": "31-12-2022",
                        "avgRating": 0,
                        "currency": []
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}

Course Details​

Use this API to get the list of all courses.

 GET /course/{courseId}/detail

Path parameter​

FieldTypeDescription
courseId
required
integerA single course ID
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "courseDetail": {
                    "courseId": 3,
                    "title": "Human Resource Management",
                    "courseCode": "101",
                    "description": "Human Resource Management (HRM, or simply HR).",
                    "durationInDays": "180",
                    "startDate": "2017-09-20",
                    "endDate": "2022-12-31",
                    "thumbnail": null,
                    "department": [
                        {
                            "departmentId": 38,
                            "name": "Information Technology",
                            "status": true
                        }
                    ],
                    "designation": [
                        {
                            "designationId": 6,
                            "name": "Senior Manager",
                            "status": true
                        }
                    ],
                    "faq": "",
                    "demovideo": "",
                    "features": "",
                    "trainerName": "Vicky Upadhyay",
                    "tags": "test,123",
                    "seoTitle": "anlndanlsd",
                    "seoDescription": "asndfasd",
                    "keywords": "abm,sdn,adsf",
                    "proficiency": [
                        {
                            "proficiencyId": 1,
                            "name": "Level 1",
                            "status": true
                        }
                    ],
                    "competency": [
                        {
                            "competencyId": 1,
                            "name": "Communication",
                            "status": true
                        }
                    ],
                    "subject": [
                        {
                           "subjectId": 1,
                           "name": "Test"
                        }
                     ],
                    "currency": [
                        {
                           "currencyCode": "INR",
                           "price": "500",
                           "isDefault": 1
                        }
                    ]
                }
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}