Skip to content
English
Customer portal
Submit a request
  • There are no suggestions because the search field is empty.

HR Learn: API v2 - Course API

The Course API performs actions related to courses in the HR Learn LMS.

The Course API performs actions related to courses in the HR Learn LMS. The following methods are available via this API:

Search courses

HTTP Action

POST

Base URL

https://[Your HR Learn LMS Portal URL]

Endpoint URL

/api/course/v2/search

Request Parameters
Parameter Data Type Description
Type (required) string

The type of search to perform, can be one of the following values:

  • "fts" - performs a full text search across titles and descriptions
  • "code" - performs a search by code
  • "name" - performs a search by name
  • "modifiedSince" - Find the course(s) that have been modified since a specific date and time. Note when this search type is used, the date in the searchParam must be formatted as “yyyy-MM-dd hh:mm:ss”.
SearchParam (required) string The term you are searching for.

Example:

{   "Type": "name",    "SearchParam": "My Course" }

Response

An array of course objects matching the search criteria.

Example:

[     {         "Id": 2,         "IdSite": 2,         "Title": "My Course",         "CourseCode": "MY",         "Avatar": null,         "Cost": null,         "MaximumQuantity": null,         "Credits": null,         "EstimatedLengthInMinutes": 75,         "ShortDescription": "This is my course.",         "LongDescription": null,         "IsPublished": false,         "IsClosed": false,         "IsLocked": false,         "IsPrerequisiteAny": true,         "IsFeedActive": true,         "IsFeedModerated": false,         "IsFeedOpenSubscription": true,         "DtCreated": "2015-05-28T12:51:07.487Z",         "DtModified": "2017-03-06T17:00:14.85Z",         "IsDeleted": false,         "DtDeleted": null,         "Order": null,         "DisallowRating": false,         "Rating": null,         "Votes": null,         "ForceLessonCompletionInOrder": false,         "RequireFirstLessonToBeCompletedBeforeOthers": false,         "LockLastLessonUntilOthersCompleted": false,         "SelfEnrollmentIsOneTimeOnly": false,         "SelfEnrollmentDueInterval": null,         "SelfEnrollmentDueTimeframe": null,         "SelfEnrollmentExpiresFromStartInterval": null,         "SelfEnrollmentExpiresFromStartTimeframe": null,         "SelfEnrollmentExpiresFromFirstLaunchInterval": null,         "SelfEnrollmentExpiresFromFirstLaunchTimeframe": null,         "SearchTags": "",         "IsCallingUserEnrolled": false,         "IsMultipleSelfEnrollmentEligible": true,         "LanguageSpecificProperties": [             {                 "LangString": "en-US",                 "Title": "My Course",                 "ShortDescription": "This is my course.",                 "LongDescription": "",                 "SearchTags": ""             }         ],         "SocialMediaProperties": [],         "IsSelfEnrollmentApprovalRequired": false,         "IsApprovalAllowedByCourseExperts": false,         "IsApprovalAllowedByUserSupervisor": false,         "Shortcode": null,         "IsSelfEnrollmentLockedByPrerequisites": false,         "IsSelfEnrollmentDrop": false,         "IdParent": null,         "CourseSharedScope": [],         "AllowCopy": true     } ]



Get course details

HTTP Action

GET

Base URL

https://[Your HR Learn LMS Portal URL]

Endpoint URL

/api/course/v2/{id}

Request Parameters

NONE

Response

A course object matching the {id} of the course.

Example:

{ 	"Id": 2, 	"IdSite": 2, 	"Title": "My Course", 	"CourseCode": "MY", 	"Avatar": null, 	"Cost": null, 	"MaximumQuantity": null, 	"Credits": null, 	"EstimatedLengthInMinutes": 75, 	"ShortDescription": "This is my course.", 	"LongDescription": null, 	"IsPublished": false, 	"IsClosed": false, 	"IsLocked": false, 	"IsPrerequisiteAny": true, 	"IsFeedActive": true, 	"IsFeedModerated": false, 	"IsFeedOpenSubscription": true, 	"DtCreated": "2015-05-28T12:51:07.487Z", 	"DtModified": "2017-03-06T17:00:14.85Z", 	"IsDeleted": false, 	"DtDeleted": null, 	"Order": null, 	"DisallowRating": false, 	"Rating": null, 	"Votes": null, 	"ForceLessonCompletionInOrder": false, 	"RequireFirstLessonToBeCompletedBeforeOthers": false, 	"LockLastLessonUntilOthersCompleted": false, 	"SelfEnrollmentIsOneTimeOnly": false, 	"SelfEnrollmentDueInterval": null, 	"SelfEnrollmentDueTimeframe": null, 	"SelfEnrollmentExpiresFromStartInterval": null, 	"SelfEnrollmentExpiresFromStartTimeframe": null, 	"SelfEnrollmentExpiresFromFirstLaunchInterval": null, 	"SelfEnrollmentExpiresFromFirstLaunchTimeframe": null, 	"SearchTags": "", 	"IsCallingUserEnrolled": false, 	"IsMultipleSelfEnrollmentEligible": true, 	"LanguageSpecificProperties": [ 		{ 			"LangString": "en-US", 			"Title": "My Course", 			"ShortDescription": "This is my course.", 			"LongDescription": "", 			"SearchTags": "" 		} 	], 	"SocialMediaProperties": [], 	"IsSelfEnrollmentApprovalRequired": false, 	"IsApprovalAllowedByCourseExperts": false, 	"IsApprovalAllowedByUserSupervisor": false, 	"Shortcode": null, 	"IsSelfEnrollmentLockedByPrerequisites": false, 	"IsSelfEnrollmentDrop": false, 	"IdParent": null, 	"CourseSharedScope": [], 	"AllowCopy": true }

Delete course

HTTP Action

DELETE

Base URL

https://[Your HR Learn LMS Portal URL]

Endpoint URL

/api/course/v2/{id}

Request Parameters

NONE

Response

NONE (200 - OK)