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

Organizational chart (Lära and Via HTML)

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

TABLE OF CONTENTS
Branch/get
Branch/getlist
Branch/create
Branch/edit
Branch/delete
Branch/adduser
Branch/addusers
Branch/edituser
Branch/removeuser
Branch/getuserlist
Branch error code descriptions

Branches

The "organizational chart branches" are used to isolate users within their context with a rights profile specific to that context. A branch in the API is named "branch", and a rights profile is named "permission".

Branch/get

Returns all the information relating to a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/get

Request

Example of request call content for information on a branch:

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

Field descriptions

Name
Required
Comment/description
id
X
Unique identifier of the organizational chart branch. (String type)

Response

Example of response call content for information on a branch of the organizational chart: 

{
    "id": "SvnzGVvIvvzqXXlxA30Xtg%3d%3d",
    "parentId": "61%2bwMxJmDOvWFQrEjS4p4g%3d%3d",
    "name": {
        "texts": [
            {
                "text": "Public",
                "languageId": 2
            }
        ],
        "ErrorID": 0
    },
    "creationDate": "2021-11-08T08:40:50.23",
    "createdByUserID": "U0mBRsCQcngrir2ZUs6%2bhw%3d%3d",
    "organizationalUnitId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d"
}

Field descriptions

Name

Comments/description

id

Unique identifier of the targeted organizational chart branch. 

parentId

Unique identifier of the parent, or "higher", branch.

name

Name of the branch displayed to administrators.

  • texts: name of the branch displayed to administrators for each language. 
    • text: name of the branch for the specified language.
    • languageId: display language.
      • 1 = French (Canada) 
      • 2 = English
      • 3 = French (France)
      • 4 = Spanish
    • ErrorId: error code returned for this field (0 if no error).

creationDate

Date the branch was created. This field is generated automatically upon creation.

createdByUserID

Unique identifier of the user who created the branch. This field is generated automatically upon creation.

organizationalUnitId
Unique identifier of the organizational unit.

Branch/getlist

Returns all the information relating to the branches of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/getlist

Request

Example of request call content for the information relating to the branches of the organizational chart in your environment:

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

Field descriptions

Name
Required
Comment/description
filterDate

The method returns the list of branches that were created after the date passed as a filter. (String type, YYYY-MM-DDTHH:MM:SSZ)

Response

Example of response call content for the information relating to the branches of the organizational chart in your environment: 

[
    {
        "id": "HAwToYn4CzS208NIAwBVEQ%3d%3d",
        "name": {
            "texts": [
                {
                    "text": "Administration",
                    "languageId": 1
                },
                {
                    "text": "Administration",
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "creationDate": "2021-10-07T14:05:55.177",
        "createdByUserID": "xuoXIHCPJSCLJu0bIleTlg%3d%3d"
    },
    {
        "id": "z483Dd2vcBB98EfY%2fovklA%3d%3d",
        "parentId": "KCnXY9Tmr7Edkyn5EHvobQ%3d%3d",
        "name": {
            "texts": [
                {
                    "text": "Public",
                    "languageId": 1
                },
                {
                    "text": "Public",
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "creationDate": "2022-05-18T08:18:10.297",
        "createdByUserID": "npx3BF6FKYVE4SX0Ltve2Q%3d%3d"
    }
]

Field descriptions

Name

Comments/description

id

Unique identifier of the organizational chart branch. 

parentId

Unique identifier of the parent, or "higher", branch.

name

Name of the branch displayed to administrators:

  • texts: name of the branch.
  • languageId: The name of the branch can be multilingual: 
    • 1 = French (Canada) 
    • 2 = English
    • 3 = French (France)
  • ErrorId: error code returned for this field (0 if no error).

creationDate

Date the branch was created. This field is generated automatically upon creation.

createdByUserID

Unique identifier of the user who created the branch. This field is generated automatically upon creation.

organizationalUnitId
Unique identifier of the organizational unit.

Branch/create

Creates a branch on the organizational chart in your environment.
API call address : https://.../lmsapi/branch/create

Request

Example of request call content to create a branch on the organizational chart in your environment:

{
  "parentId": "HAwToYn4CzS208NIAwBVEQ%3d%3d",
  "name": {
            "texts": [
                {
                    "text": "Public",
                    "languageId": 1
                },
                {
                    "text": "Public",
                    "languageId": 2
                },
                {
                    "text": "público",
                    "languageId": 3
                }
    ]
  },
  "organizationalUnitId" : "7IoopVM73nHZMhUaQ3JvWw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

parentId

 

Unique identifier of the parent, or "higher", branch. If no value is provided, the branch will be created under the root branch, that is, the default branch of the organizational chart. (String type)

name

 

Name of the branch displayed to administrators:

  • texts: name of the branch.
  • languageId: The name of the branch can be multilingual. (Number type)
    • 1 = French (Canada) 
    • 2 = English
    • 3 = French (France)
organizationalUnitId
Unique identifier of the organizational unit.

Response

Example of response call content when creating a branch on the organizational chart in your environment. The system returns the identifier of the created branch: 

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

Field descriptions

Name

Comments/description

idUnique identifier of the created organizational chart branch.

Branch/edit

Modifies a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/edit

Request

Example of request call content to modify a branch of the organizational chart in your environment:

{
  "id": "uoGcjyx1IWiArobopJMBlg%3d%3d",
  "parentId": "HAwToYn4CzS208NIAwBVEQ%3d%3d",
  "name": {
            "texts": [
                {
                    "text": "Public",
                    "languageId": 1
                },
                {
                    "text": "Public",
                    "languageId": 2
                },
                {
                    "text": "público",
                    "languageId": 3
                }
    ]
  }
}

Field descriptions

Name

Required

Comments/description

id
X
Unique identifier of the branch to modify. The other fields are optional and are updated if a new value is specified. (String type)

parentId

 

Unique identifier of the parent, or "higher", branch. If no value is provided, the branch will remain in the same place. (String type)

name

 

Name of the branch displayed to administrators:

  • texts: name of the branch.
  • languageId: The name of the branch can be multilingual. (Number type)
    • 1 = French (Canada) 
    • 2 = English
    • 3 = French (France)
organizationalUnitId
Unique identifier of the organizational unit.

Response

Example of response call content when modifying a branch of the organizational chart in your environment. The system returns the identifier of the modified branch: 

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

Field descriptions

Name

Comments/description

idUnique identifier of the modified organizational chart branch.

Branch/delete

Deletes a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/delete

Request

Example of request call content to delete a branch of the organizational chart in your environment:

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

Field descriptions

Name


Required


Comments/description


id
X
Unique identifier of the branch to delete. (String type)

Response

Example of response call content when deleting a branch of the organizational chart in your environment. The system returns the identifier of the deleted branch: 

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

Field descriptions

Name

Comments/description

idUnique identifier of the deleted organizational chart branch.

Branch/adduser

Adds a user with a rights profile on a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/adduser

Request

Example of call content to add a user on a branch of the organizational chart in your environment:

{
    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"
}

Field descriptions

Name


Required


Comments/description


userId
X
Unique identifier of the user to add to the specified branch. (String type)
branchId
X
Unique identifier of the branch on which to add the user with the specified rights profile. (String type)
permissionId
X
Unique identifier of the rights profile to grant to the user on the specified branch. (String type)

Response

Example of call content to add a user on a branch of the organizational chart in your environment. The system returns the information relating to the operation: 

{
    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"
}

Field descriptions

Name


Comments/description


userIdUnique identifier of the user added to the specified branch.
branchIdUnique identifier of the branch on which the user was added with the specified rights profile.
permissionIdUnique identifier of the rights profile granted to the user on the specified branch.

Branch/addusers

Adds several users on a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/addusers

Request

Example of call content to add users on a branch of the organizational chart in your environment:

{
  "id": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
  "users" : [
        "2Peiqp5iO09nXXnwfjGPxA%3d%3d",
        "fAb4yjum64Tv74bQ4%2bGeGg%3d%3d"
    ]
}

Field descriptions

Name


Required


Comments/description


Id
X
Unique identifier of the branch on which to place the users. (String type)
users
X
List of the unique identifiers of the users to add on the specified branch. (String type)

Response

Example of call content to add users on a branch of the organizational chart in your environment. The system returns the information relating to the operation: 

{
  "id": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
  "users" : [
        "2Peiqp5iO09nXXnwfjGPxA%3d%3d",
        "fAb4yjum64Tv74bQ4%2bGeGg%3d%3d"
    ]
}

Field descriptions

Name


Comments/description


IdUnique identifier of the branch on which to place the users.
usersList of the unique identifiers of the users to add on the specified branch.

Branch/edituser

Modifies the rights profile of a user on a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/edituser

Request

Example of call content to modify the rights profile of a user on a branch of the organizational chart in your environment:

{
    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d",
   "overwriteManualAssignments" : true
}

Field descriptions

Name


Required


Comments/description


userId
X
Unique identifier of the user whose rights profile is to be modified on the specified branch. (String type)
branchId
X
Unique identifier of the branch on which to modify the rights profile of the specified user. (String type)
permissionId
X
Unique identifier of the rights profile to grant to the user on the specified branch. (String type)
overwriteManualAssignments

Optional field that has 'true' as its default value: this means that the permission will always be modified.

If it is set to 'false': if the permission was granted or modified manually, it will not be modified during this call
(Boolean type)

Response

Example of call content to modify the rights profile of a user on a branch of the organizational chart in your environment. The system returns the information relating to the operation: 

{
    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
    "branchId":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d",
    "permissionId":"tYGlIky4aK%2f7Z1joMMQL0g%3d%3d"
}

Field descriptions

Name


Comments/description


userIdUnique identifier of the user whose rights profile is to be modified on the specified branch.
branchIdUnique identifier of the branch on which to modify the rights profile of the specified user.
permissionIdUnique identifier of the rights profile to grant to the user on the specified branch.

Branch/removeuser

Removes a user from a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/removeuser

Request

Example of call content to remove a user from a branch of the organizational chart in your environment:

{
    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
    "branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d"
}

Field descriptions

Name


Required


Comments/description


userId
X
Unique identifier of the user to remove from the specified branch. (String type)
branchId
X
Unique identifier of the branch from which to remove the specified user. (String type)

Response

Example of call content to remove a user from a branch of the organizational chart in your environment. The system returns the information relating to the operation: 

{
    "userId": "WhcMwDXxCq%2fsp4YP%2btHUjg%3d%3d",
    "branchId": "5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d"
}

Field descriptions

Name


Comments/description


userIdUnique identifier of the user removed from the specified branch.
branchIdUnique identifier of the branch from which the specified user was removed.

Branch/getuserlist

Retrieves a list of the users associated with a branch of the organizational chart in your environment.
API call address : https://.../lmsapi/branch/getuserlist

Request

Example of request call content for the list of users of a branch of the organizational chart in your environment:

{
    "Id":"5vZqv7xWJ1HQb84%2fhKf0Tg%3d%3d"
}

Field descriptions

Name


Required


Comments/description


Id
X
Unique identifier of the branch. (String type)

Response

Example of response call content for the list of users of a branch of the organizational chart in your environment. The system returns the information relating to the operation: 

[
    {
        "userId": "fAb4yjum64Tv74bQ4+GeGg==",
        "permissionID": "pJlqyk0x52S/5ZZGxAITFw==",
        "branchID": "5vZqv7xWJ1HQb84/hKf0Tg=="
    },
    {
        "userId": "2Peiqp5iO09nXXnwfjGPxA==",
        "permissionID": "pJlqyk0x52S/5ZZGxAITFw==",
        "branchID": "5vZqv7xWJ1HQb84/hKf0Tg=="
    }
]

Field descriptions

Name


Comments/description


userIdUnique identifier of the user.
branchIdUnique identifier of the branch.
permissionIdUnique identifier of the rights profile of the user on the specified branch.

Branch error code descriptions

Number

Message

Comments/description

200

Required id

You must provide an identifier for the branch. 

201

Invalid id

The identifier provided for the branch is invalid.

202

Invalid parentId

The identifier provided for the parent branch is invalid.

203

Required name

You must provide a branch name.

204

Invalid name length

The branch name must contain between 3 and 250 characters inclusively.

205

Required userId

You must provide an identifier for the user.

206

Invalid userId

The identifier provided for the user is invalid.

207

Required branchID

You must provide an identifier for the branch.

208

Invalid branchID

The identifier provided for the branch is invalid.

209

Required permissionID

You must provide an identifier for the permission.

210

Invalid permissionID

The identifier provided for the permission is invalid.

211

User already in branch

The user you are trying to add to the branch is already part of it.

212

Branch still linked

The branch cannot be deleted if it has sub-branches or if it is associated with a user, a portal or a provider.

213

User must be in at least one branch

The user must belong to at least one branch.

214Required usersYou must provide a list of users.
215Invalid organizationalUnitId

The identifier provided for the parent organizational unit is invalid

216This action cannot be done because the organizational unit has purchases
You cannot modify the organizational unit of a branch if it has purchases

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