HR Learn LMS API v2 - Learning Path API – HR Learn Support

Keywords:

API

The Learning Path API performs actions related to learning paths in the Inquisiq LMS. The following methods are available via this API:

Search learning paths
Get learning path details
Delete learning path

Search learning paths

HTTP Action

POST

Base URL

https://[Your Inquisiq LMS Portal URL]

Endpoint URL

/api/learningpath/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
"name" - performs a search by name
"modifiedSince" - Find the learning path(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 Learning Path"
}

Response

An array of learning path objects matching the search criteria.

Example:

[
	{
		"Id": 123,
		"IdSite": 2,
		"Name": "My Learning Path",
		"ShortDescription": "This is my learning path.",
		"LongDescription": null,
		"Cost": null,
		"IsPublished": true,
		"IsClosed": false,
		"SelfEnrollmentIsOneTimeOnly": false,
		"ForceCompletionInOrder": false,
		"DtCreated": "2021-06-15T15:16:37.89",
		"DtModified": "2021-07-01T21:33:42.577",
		"IsDeleted": false,
		"DtDeleted": null,
		"Avatar": null,
		"SearchTags": null,
		"IsCallingUserEnrolled": false,
		"IsMultipleSelfEnrollmentEligible": true,
		"LanguageSpecificProperties": [
			{
				"LangString": "en-US",
				"Name": "My Learning Path",
				"ShortDescription": "This is my learning path.",
				"LongDescription": "",
				"SearchTags": ""
			}
		],
		"Shortcode": null,
		"IsSelfEnrollmentDrop": true
	}
]

Get learning path details

HTTP Action	GET
Base URL	https://[Your Inquisiq LMS Portal URL]
Endpoint URL	/api/learningpath/v2/{id}
Request Parameters	NONE
Response	A learning path object matching the {id} of the learning path. Example: { "Id": 123, "IdSite": 2, "Name": "My Learning Path", "ShortDescription": "This is my learning path.", "LongDescription": null, "Cost": null, "IsPublished": true, "IsClosed": false, "SelfEnrollmentIsOneTimeOnly": false, "ForceCompletionInOrder": false, "DtCreated": "2021-06-15T15:16:37.89", "DtModified": "2021-07-01T21:33:42.577", "IsDeleted": false, "DtDeleted": null, "Avatar": null, "SearchTags": null, "IsCallingUserEnrolled": false, "IsMultipleSelfEnrollmentEligible": true, "LanguageSpecificProperties": [ { "LangString": "en-US", "Name": "My Learning Path", "ShortDescription": "This is my learning path.", "LongDescription": "", "SearchTags": "" } ], "Shortcode": null, "IsSelfEnrollmentDrop": true }

Delete learning path

HTTP Action	DELETE
Base URL	https://[Your Inquisiq LMS Portal URL]
Endpoint URL	/api/learningpath/v2/{id}
Request Parameters	NONE
Response	NONE (200 - OK)

Search learning paths

Get learning path details

Delete learning path

Related articles