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

HR Learn LMS API v2 - Catalog API

Please read the following article to understand the 2 API methods available within the HR Learn that will enable you to search catalogs and get a catalog.

Please read the following article to understand the 2 API methods available within the HR Learn that will enable you to search catalogs and get a catalog.  The Catalog API performs actions related to catalogs in the HR Learn LMS. The following methods are available via this API:

Search catalogs

HTTP Action

POST

Base URL

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

Endpoint URL

/api/catalog/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
SearchParam (required) string The term you are searching for.

Example:

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

Response

An array of catalog objects matching the search criteria.

Example:

[     {         "IdCatalog": 3,         "IdSite": 2,         "IdParent": null,         "Title": "My Catalog",         "Order": null,         "ShortDescription": "My Catalog",         "LongDescription": null,         "IsPublished": null,         "IsPrivate": false,         "CalculatedCost": 0.0,         "IsClosed": false,         "DtCreated": "2021-05-04T20:31:06.847Z",         "DtModified": "2021-05-04T20:31:06.847Z",         "SearchTags": null,         "NumberEnrollableCourses": 1,         "NumberEnrollableLearningPaths": 0,         "LanguageSpecificProperties": [             {                 "LangString": "en-US",                 "Title": "My Catalog",                 "ShortDescription": "My Catalog",                 "LongDescription": "",                 "SearchTags": ""             }         ],         "Avatar": null,         "Shortcode": null     } ]

Get catalog details

HTTP Action

GET

Base URL

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

Endpoint URL

/api/catalog/v2/{id}

Request Parameters

NONE

Response

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

Example:

{     "IdCatalog": 3,     "IdSite": 2,     "IdParent": null,     "Title": "My Catalog",     "Order": null,     "ShortDescription": "My Catalog",     "LongDescription": null,     "IsPublished": null,     "IsPrivate": false,     "CalculatedCost": 0.0,     "IsClosed": false,     "DtCreated": "2021-05-04T20:30:15.57Z",     "DtModified": "2021-05-04T20:30:15.57Z",     "SearchTags": null,     "NumberEnrollableCourses": 1,     "NumberEnrollableLearningPaths": 0,     "LanguageSpecificProperties": [         {             "LangString": "en-US",             "Title": "My Catalog",             "ShortDescription": "My Catalog",             "LongDescription": "",             "SearchTags": ""         }     ],     "Avatar": null,     "Shortcode": null }