ASP.NET Web API Help Page

Introduction

The API methods detailed below allow the administration of users within the LMS. Methods are secured and must be accessed with an appropriate authenticated token. Login and Token retrieval may be achieved calling the /Token service supplying url-encoded parameters of userName, email and grant_type = "password"

FileUploads

API	Description
POST api/FileUploads/UploadFile	Accepts an .xls file upload and returns a list of users contained therein.

Courses

API	Description
POST api/Courses/retrieve_academy_courses	No documentation available.
POST api/Courses/retrieve_academy_course_tier_options	No documentation available.
POST api/Courses/retrieve_academy_course_purchases	No documentation available.
POST api/Courses/retrieve_academy_course_modules	No documentation available.
POST api/Courses/RetrieveCourses	Retrieves a list of applicable courses
POST api/Courses/RetrieveCourseEnrollments	No documentation available.
POST api/Courses/retrieve_user_workshop_session_enrolments?userid={userid}	No documentation available.
POST api/Courses/SetUserManager?userid={userid}&managerid={managerid}	No documentation available.
POST api/Courses/EnrolUserOnWorkshopSession?userid={userid}&workshop_session_id={workshop_session_id}	No documentation available.
POST api/Courses/EnrolUser?userid={userid}&courseid={courseid}	Enrols a user on a given course.
POST api/Courses/activate_course?userid={userid}&category_id={category_id}&course_name={course_name}&_workshop_session_id={_workshop_session_id}	No documentation available.
POST api/Courses?userid={userid}&course_name={course_name}	No documentation available.
POST api/Courses?course_id={course_id}	No documentation available.
GET api/Courses	No documentation available.
POST api/Courses?category_id={category_id}&course_name={course_name}&userid={userid}&_workshop_session_id={_workshop_session_id}	No documentation available.

ScheduledTasks

API	Description
POST api/ScheduledTasks/insert_task?_identifier={_identifier}&_task_name={_task_name}&_path={_path}&_interval={_interval}	No documentation available.
POST api/ScheduledTasks/retrieve_tasks	No documentation available.
POST api/ScheduledTasks/run_task	No documentation available.

Users

API	Description
POST api/Users/retrieve_user?_user_id={_user_id}	No documentation available.
POST api/Users/insert_contact_lead	No documentation available.
POST api/Users/RetrieveUsers	Returns a list of users from the LMS Database
POST api/Users/InsertUser	Inserts a provided user into the LMS Database

Zoho

API	Description
POST api/Zoho/retrieve_attachment_aggregates	No documentation available.
POST api/Zoho/retrieve_attachments	No documentation available.
POST api/Zoho/retrieve_attachment_contacts	No documentation available.
POST api/Zoho/retrieve_zoho_accounts	No documentation available.
GET api/Zoho/layer_2_sync	No documentation available.
GET api/Zoho/update_zoho_accounts	No documentation available.
GET api/Zoho/update_zoho_contacts	No documentation available.
GET api/Zoho/update_zoho_leads	No documentation available.
GET api/Zoho/update_zoho_tasks	No documentation available.
GET api/Zoho/update_zoho_potentials	No documentation available.
GET api/Zoho	No documentation available.
POST api/Zoho?occurence={occurence}&message={message}	No documentation available.

Tests

API	Description
POST api/Tests/RetrieveTests	No documentation available.
GET api/Tests	No documentation available.

LearningChoices

API	Description
POST api/LearningChoices/send_enquiry?_email={_email}&_first_name={_first_name}&_last_name={_last_name}&_institute={_institute}&_level={_level}	No documentation available.
POST api/LearningChoices/send_enquiry_only?_email={_email}&_first_name={_first_name}&_last_name={_last_name}&_institute={_institute}&_level={_level}	No documentation available.

LearnerJournals

API	Description
POST api/LearnerJournals/retrieve_learner_journal_entries	No documentation available.
POST api/LearnerJournals/retrieve_learning_outcomes	No documentation available.