Course List

Use this API to list all courses.

 

HTTP REQUEST

GET /course/course-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: 100
filterData JSON Array Search record with following filter
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]
		"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": []
            }
        }
    }
}
Field Type Description
courseId int Course ID
title string Course Title
courseCode string Course Code
description string Course Description
duration string course duration
startDate date Course Start date
endDate date Course end date
eligibleForSale float Course Price in INR
status bool Course status
thumbnail string Course thumbnail URL
trainer string Course trainer name
avgRating float Average ratings given by users
currency array Multiple currencies set for course
totalRecords int Count of total records returned
Code Description
1003 ‘Invalid firstRecord’
1004 ‘Invalid count’
1005 ‘Missing filterData’
1006 ‘Invalid filterData’
1007 ‘Missing filterData – field’
1008 ‘Invalid filterData – field’
1009 ‘Missing filterData – generic’
1010 ‘Invalid filterData – generic’
1011 ‘Missing filterData – sortByfield’
1012 ‘Invalid filterData – sortByfield’
1013 ‘Missing filterData – sortType’
1014 ‘Invalid filterData – sortType’

For general error details, click here.