Soumettre un ticket Mes tickets
Welcome
Login  Sign up
a
  1. Mon Assistance SVIeSolutions
  2. Solution home
  3. API Guides
  4. Lära LMS et Via HTML Portals

Catalogs (Lära)

Miro Lagueux
Modified on: Mon, 31 Aug, 2026 at 8:49 AM

TABLE OF CONTENTS
Catalog/get
Catalog/getlist
Catalog/create
Catalog/edit
Catalog/delete
Catalog/adduser
Catalog/removeuser
Catalog/getuserlist
Catalog/addbranch
Catalog/removebranch
Catalog/getbranchlist
Catalog/addgroup
Catalog/removegroup
Catalog/getgrouplist
Catalog/addworkspace
Catalog/removeworkspace
Catalog/getworkspacelist
Catalogue error code descriptions

Catalogues

« Catalogues » are used to present your environment's training offering to your users, and are named « catalog » in the API.

Catalog/get

Retrieves information about a catalogue in your environment.
API call address : https://.../lmsapi/catalog/get

Request

Example of request call content for information on a catalogue:

{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

Response

Example of the response call content for an information request on a catalogue:

{
  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d",
  "name": {
    "texts": [{
        "text": "CATALOG-FR",
        "languageId": 1
      }, {
        "text": "CATALOG-EN",
        "languageId": 2
      }, {
        "text": "CATALOG-ES",
        "languageId": 3
      }
    ]
  },
  "creationDate": "2017-11-30T10:52:24.34",
  "createdByUserID": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

name
- texts
- text
- languageId

Text: Title of the catalogue.
(String type)

languageId: The title can be multilingual: 

  • 1 = French (Canada) 
  • 2 = English
  • 3 = Spanish

(Number type)

creationDate

Date and time the catalogue was created.

(String YYYY-MM-DDTHH:MM:SSZ)

createdByUserID

Unique identifier of the user who created the catalogue.
(String type)

Catalog/getlist

Retrieves information about a list of catalogues in your environment.
API call address : https://.../lmsapi/catalog/getlist

Request

Example of request call content for information on a list of catalogues:

{
"filterDate": “YYYY-MM-DDTHH:MM:SSZ”
}

Field descriptions

Name

Required

Comments/description

filterDateX

Creation date of the catalogues. The call returns the list of objects that were created after the date passed as a filter.
(String YYYY-MM-DDTHH:MM:SSZ)

Response

Example of the response call content for an information request on a list of catalogues:

[
    {
        "id": "n8%2fYjDQpXpCCzeBXIJuS7w%3d%3d",
        "name": {
            "texts": [
                {
                    "text": "Défaut",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "creationDate": "2019-06-18T11:44:10.697",
        "createdByUserID": "5EJOaP8xOZr0tq%2fLtdU3Og%3d%3d"
    },
    {
        "id": "C%2fTsGAbRy3LCOCmGHyv6Hw%3d%3d",
        "name": {
            "texts": [
                {
                    "text": "Pilotage",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "creationDate": "2022-09-26T14:36:25.427",
        "createdByUserID": "hyKnH0JSL7De3ohq7FSvPg%3d%3d"
    }
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

name
- texts
- text
- languageId

Text: Title of the catalogue.
(String type)

languageId: The title can be multilingual: 

  • 1 = French (Canada) 
  • 2 = English
  • 3 = Spanish

(Number type)

creationDate

Date and time the catalogue was created.

(String YYYY-MM-DDTHH:MM:SSZ)

createdByUserID

Unique identifier of the user who created the catalogue.
(String type)

Catalog/create

Creates a catalogue.
API call address : https://.../lmsapi/catalog/create

Request

Example of request call content to create a catalogue:

{
  "name": {
    "texts": [{
        "text": "test2",
        "languageId": 1
      }
    ]
  }
}

Field descriptions

Name

Required

Comments/description

name
- texts
- text
- languageId		X

Text: Title of the catalogue.
(String type)

languageId: The title can be multilingual: 

  • 1 = French (Canada) 
  • 2 = English
  • 3 = Spanish

(Number type)

Response

Example of the response call content for a request to create a catalogue:

{
  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the created catalogue.
(String type)

Catalog/edit

Modifies a catalogue. Only the fields that are updated will be modified.
API call address : https://.../lmsapi/catalog/edit

Request

Example of request call content to modify a catalogue:

{
  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"  
  "name": {
    "texts": [{
        "text": "Mon nouveau nom de catalogue",
        "languageId": 1
      }
    ]
  }
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue to modify.
(String type)

name
- texts
- text
- languageId

Text: Title of the catalogue.
(String type)

languageId: The title can be multilingual: 

  • 1 = French (Canada) 
  • 2 = English
  • 3 = Spanish

(Number type)

Response

Example of the response call content for a request to modify a catalogue:

{
  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the modified catalogue.
(String type)

Catalog/delete

Deletes a catalogue.
API call address : https://.../lmsapi/catalog/delete

Request

Example of request call content to delete a catalogue:

{
"id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue to delete.
(String type)

Response

Example of the response call content for a request to delete a catalogue:

{
  "id": "I2Oa5s9JDCGvE7BtvUfxrg%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the deleted catalogue.
(String type)

Catalog/adduser

Assigns a catalogue to a user.
API call address : https://.../lmsapi/catalog/adduser

Request

Example of request call content to assign a catalogue to a user:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

userIdXUnique identifier of the user.
(String type)

Response

Example of the response call content for a request to assign a catalogue to a user :

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

userId
Unique identifier of the user.
(String type)

Catalog/removeuser

Removes the assignment of a catalogue to a user.
API call address : https://.../lmsapi/catalog/removeuser

Request

Example of request call content to remove the assignment of a catalogue to a user:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

userIdXUnique identifier of the user.
(String type)

Response

Example of the response call content for a request to remove the assignment to assign a catalogue to a user :

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

userId
Unique identifier of the user.
(String type)

Catalog/getuserlist

Retrieves the list of users to whom a catalogue is assigned.
API call address : https://.../lmsapi/catalog/getuserlist

Request

Example of request call content for the list of users to whom a catalogue is assigned:

{
"id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

Response

Example of the response call content for a request for the list of users to whom a catalogue is assigned :

[
    {
        "id": "C%2fTsGAbRy3LCOCmGHyv6Hw%3d%3d",
        "userId": "RrHd5EmYmSgXzC8AegdDeA%3d%3d"
    },
    {
        "id": "C%2fTsGAbRy3LCOCmGHyv6Hw%3d%3d",
        "userId": "3j5BmPY5d5FmUuFDrOo8Ug%3d%3d"
    }
[

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

userId
Unique identifier of the user.
(String type)

Catalog/addbranch

Associates a catalogue with the users of a branch of the organization chart.
API call address : https://.../lmsapi/catalog/addbranch

Request

Example of request call content to associate a catalogue with the users of a branch:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

branchIdX

Unique identifier of the branch.
(String type)

Response

Example of the response call content for a request to associate a catalogue with the users of a branch:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

branchId
Unique identifier of the branch.
(String type)

Catalog/removebranch

Disassociates a catalogue from the users of a branch of the organization chart.
API call address : https://.../lmsapi/catalog/removebranch

Request

Example of request call content to disassociate a catalogue from the users of a branch:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

branchIdX

Unique identifier of the branch.
(String type)

Response

Example of the response call content for a request to disassociate a catalogue from the users of a branch:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

branchId
Unique identifier of the branch.
(String type)

Catalog/getbranchlist

Retrieves the list of branches of the organization chart with which a catalogue is associated.
API call address : https://.../lmsapi/catalog/getbranchlist

Request

Example of request call content for the list of user branches with which a catalogue is associated:

{  
   "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

Response

Example of the response call content for a request for the list of user branches with which a catalogue is associated:

[
  {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "branchId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
  }, 
  {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "branchId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
   }
]

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

branchId
Unique identifier of the branch.
(String type)

Catalog/addgroup

Associates a catalogue with the users of a user group of the organization chart.
API call address : https://.../lmsapi/catalog/addgroup

Request

Example of request call content to associate a catalogue with the users of a group:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

groupIdX

Unique identifier of the user group.
(String type)

Response

Example of the response call content for a request to associate a catalogue with the users of a group:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

groupId
Unique identifier of the user group.
(String type)

Catalog/removegroup

Disassociates a catalogue from the users of a group.
API call address : https://.../lmsapi/catalog/removegroup

Request

Example of request call content to disassociate a catalogue from the users of a group:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

groupIdX

Unique identifier of the group.
(String type)

Response

Example of the response call content for a request to disassociate a catalogue from the users of a group:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

groupId
Unique identifier of the group.
(String type)

Catalog/getgrouplist

Retrieves the list of user groups with which a catalogue is associated.
API call address : https://.../lmsapi/catalog/getgrouplist

Request

Example of request call content for the list of user groups with which a catalogue is associated:

{  
   "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

Response

Example of the response call content for a request for the list of user groups with which a catalogue is associated:

[
  {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "groupId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
  }, 
  {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
   }
]

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

groupId
Unique identifier of the group.
(String type)

Catalog/addworkspace

Associates a training item with a catalogue.
API call address : https://.../lmsapi/catalog/addworkspace

Request

Example of request call content to associate a training item with a catalogue:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

workspaceIdX

Unique identifier of the training item.
(String type)

Response

Example of the response call content for a request to associate a training item with a catalogue:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "workspaceId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

workspacepId
Unique identifier of the training item.
(String type)

Catalog/removeworkspace

Removes a training item from a catalogue.
API call address : https://.../lmsapi/catalog/removeworkspace

Request

Example of request call content to remove a training item from a catalogue:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

workspaceIdX

Unique identifier of the training item.
(String type)

Response

Example of the response call content for a request to remove a training item from a catalogue:

{
  "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
  "groupId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
}

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

workspaceId
Unique identifier of the training item.
(String type)

Catalog/getworkspacelist

Retrieves the list of training items in a catalogue.
API call address : https://.../lmsapi/catalog/getworkspacelist

Request

Example of request call content for the list of training items in a catalogue:

{  
   "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d"
}

Field descriptions

Name

Required

Comments/description

idX

Unique identifier of the catalogue.
(String type)

Response

Example of the response call content for a request for the list of training items in a catalogue:

[
  {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "workspaceId": "edFrrvGGeT9KI0783Dznkw%3d%3d"
  }, 
  {
    "id": "tirQkNjqBn5Tk5vwRlAE1Q%3d%3d",
    "workspaceId": "nWJ7HZLyI8l2otoNsxuXgA%3d%3d"
   }
]

Field descriptions

Name 

Required

Comments/description

id


Unique identifier of the catalogue.
(String type)

workspaceId
Unique identifier of the training item.
(String type)

Catalogue error code descriptions

Number

Message

Comments/description

700

Required id

You must provide an identifier for the catalogue.

701

Invalid id

The identifier provided for the catalogue is invalid.

702

Required name

You must provide a name for the catalogue.

703

Invalid name length

The name provided must contain between 3 and 50 characters inclusively.

704

Branch already in catalog

The branch is already associated with the catalogue.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

Related Articles