Learner APIs
Get Academy Learners API
Description: To fetch the list of learners enrolled in an academy. Request URL: <domain>/api/v4/<orgId>/portalMembers.json?type=5 (How do I get my OrgID?) Method: GET OAuth scope: TrainerCentral.presenterapi.READ Parameters: type - <Integer> <Value ...
Revoke learner's access to a course API
Description: To revoke a learner's access to a course. Request URL: <domain>/api/v4/<orgId>/updateCourseAttendee/<courseMemberId>.json Method: PUT OAuth Scope: TrainerCentral.courseapi.UPDATE Parameters: NA Request Body: { ...
Get learner info API
Description: To fetch learner info from signup forms. Request URL: <domain>/api/v4/<orgId>/fetchuserdetails.json Method: GET OAuth Scope: TrainerCentral.userapi.READ Parameters: email string Email address of the learner for whom the details are to ...
Invite learner to academy API
Description: To invite a learner to your academy. Request URL: /api/v4/<orgId>/addCourseAttendee.json (How to get my <orgId>?) Method: POST OAuth Scope: TrainerCentral.userapi.CREATE Request Parameters: { "courseAttendee": { "email": <Learner's ...
Invite learner to course API
Description: To invite a learner to your course. Request URL: /api/v4/<orgId>/addCourseAttendee.json (How do I get my orgId?) OAuth Scope: TrainerCentral.userapi.CREATE Method: POST Request Parameters: { "courseAttendee": { "email" : ...
Learner reports API
Course Report Description: To fetch the course engagement report of a particular learner. Request URL: /api/v4/<orgId>/course/<courseId>/courseMember/<courseMemberId>/courseEngagement.json (How do I get the courseMemberID?) Method: GET OAuth scope: ...
Delete learner API
Description: To delete the learner. Request URL: /api/v4/<orgId>/portalMembers/<portalMemberId>.json (How do I get my <orgId>?) Method: DELETE OAuth scope: TrainerCentral.presenterapi.DELETE