Certifications (Lära)

Miro Lagueux

Modified on: Mon, 31 Aug, 2026 at 9:05 AM

TABLE OF CONTENTS
Certification/get
Certification/getlist
Certification/create
Certification/edit
Certification/delete
Certification/addusers
Certification/getusers
Certification/removeusers
Certification/addbranches
Certification/getbranches
Certification/removebranches
Certification/addworkspaces
Certification/getworkspaces
Certification/removeworkspaces
Certification/addprograms
Certification/getprograms
Certification/removeprograms
Certification error code descriptions

Certifications

« Certifications » are a component used to issue a certificate that has an expiry date and specific requirements. They are named « certification » in the API.

Certification/get

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

Request

Example of request call content for information on a certification:

{
"id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d"
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the certification. (String type)

Response

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

{
    "id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d",
    "title": {
        "texts": [
            {
                "text": "Communication dans la cabine de pilotage",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    },
    "expirationMode": 1,
    "expiresAfterIntervalType": 4,
    "expiresAfterInterval": 2,
    "expirationReminderMode": 1,
    "expirationReminderIntervalType": 3,
    "expirationReminderInterval": 1,
    "autoResubscribes": false,
    "resubscribesBeforeExpirationIntervalType": 0,
    "resubscribesBeforeExpirationInterval": 0,
    "completionMode": 1,
    "coverId": "AgaCCp%2bgh%2fXoKvq%2fs1t9Zg%3d%3d",
    "certificateId": "G7skFScL1%2bogPkt9FeIkRQ%3d%3d"
}

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the certification. (String type)
title - texts - text - languageId		Text: Title of the certification. (String type) languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
expirationMode		Indicates the expiry mode of the certification. 0 = Never (default value) 1 = Valid for a set period of time (Number type)
expiresAfterIntervalType		Indicates the unit of measure used to define the expiry of the certification. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months 4 = Years (Number type)
expiresAfterInterval		Defines the quantity of the unit of measure selected in the "expiresAfterIntervalType" field (0 by default) for the expiry of the certification. (Number type)
expirationReminderMode		Indicates the expiry reminder mode of the certification. 0 = Manual status change (default value) 1 = Automatic status change (Number type)
expirationReminderIntervalType		Indicates the unit of measure used to define the expiry reminder of the certification. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
expirationReminderInterval		Defines the quantity of the unit of measure selected in the "expirationReminderIntervalType" field (0 by default) for the expiry reminder of the certification. (Number type)
autoResubscribes		Enables automatic re-enrolment in the sessions and cohorts linked to the certification. When enabled, the automatic re-enrolment takes place at a defined time before its expiry. (Boolean type)
resubscribesBeforeExpirationIntervalType		Indicates the unit of measure used to define the automatic re-enrolment in the requirements of the certification. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
resubscribesBeforeExpirationInterval		Defines the quantity of the unit of measure selected in the "resubscribesBeforeExpirationIntervalType" field (0 by default) for the automatic re-enrolment in the requirements of the certification. (Number type)
completionMode		The completion mode of the certification. 0 = Manual award of the certification (default value) 1 = Upon completion of all programs/training items 2 = Upon completion of a minimum number of programs/training items (Number type).
completionPartialNumber		Indicates the minimum number of requirements to complete if the completion mode is type 2 (completionMode = 2).
coverId		Unique identifier of the cover image linked to the certification. (String type)
certificateId		Unique identifier of the certificate issued upon obtaining the certification. (String type)

Certification/getlist

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

Request

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

{
}

Field descriptions

Name	Required	Comments/description
		No field is required. Please enter empty braces.

Response

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

[
    {
        "id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "Communication dans la cabine de pilotage",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                }
            ],
            "ErrorID": 0
        },
        "expirationMode": 1,
        "expiresAfterIntervalType": 4,
        "expiresAfterInterval": 2,
        "expirationReminderMode": 1,
        "expirationReminderIntervalType": 3,
        "expirationReminderInterval": 1,
        "autoResubscribes": false,
        "resubscribesBeforeExpirationIntervalType": 0,
        "resubscribesBeforeExpirationInterval": 0,
        "completionMode": 1,
        "coverId": "AgaCCp%2bgh%2fXoKvq%2fs1t9Zg%3d%3d",
        "certificateId": "G7skFScL1%2bogPkt9FeIkRQ%3d%3d"
    },
    {
        "id": "BUdPM6Oa5BmEIGOQUikGRA%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "Contrôle des instruments de bord",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                }
            ],
            "ErrorID": 0
        },
        "expirationMode": 1,
        "expiresAfterIntervalType": 4,
        "expiresAfterInterval": 2,
        "expirationReminderMode": 1,
        "expirationReminderIntervalType": 3,
        "expirationReminderInterval": 3,
        "autoResubscribes": false,
        "resubscribesBeforeExpirationIntervalType": 0,
        "resubscribesBeforeExpirationInterval": 0,
        "completionMode": 1,
        "coverId": "J%2b%2f2m50YLKBRsGfz9jcURw%3d%3d",
        "certificateId": "G7skFScL1%2bogPkt9FeIkRQ%3d%3d"
    }
]

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the certification. (String type)
title - texts - text - languageId		Text: Title of the certification. (String type) languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
expirationMode		Indicates the expiry mode of the certification. 0 = Never (default value) 1 = Valid for a set period of time (Number type)
expiresAfterIntervalType		Indicates the unit of measure used to define the expiry of the certification. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months 4 = Years (Number type)
expiresAfterInterval		Defines the quantity of the unit of measure selected in the "expiresAfterIntervalType" field (0 by default) for the expiry of the certification. (Number type)
expirationReminderMode		Indicates the expiry reminder mode of the certification. 0 = Manual status change (default value) 1 = Automatic status change (Number type)
expirationReminderIntervalType		Indicates the unit of measure used to define the expiry reminder of the certification. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
expirationReminderInterval		Defines the quantity of the unit of measure selected in the "expirationReminderIntervalType" field (0 by default) for the expiry reminder of the certification. (Number type)
autoResubscribes		Enables automatic re-enrolment in the sessions and cohorts linked to the certification. When enabled, the automatic re-enrolment takes place at a defined time before its expiry. (Boolean type)
resubscribesBeforeExpirationIntervalType		Indicates the unit of measure used to define the automatic re-enrolment in the requirements of the certification. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
resubscribesBeforeExpirationInterval		Defines the quantity of the unit of measure selected in the "resubscribesBeforeExpirationIntervalType" field (0 by default) for the automatic re-enrolment in the requirements of the certification. (Number type)
completionMode		The completion mode of the certification. 0 = Manual award of the certification (default value) 1 = Upon completion of all programs/training items 2 = Upon completion of a minimum number of programs/training items (Number type).
completionPartialNumber		Indicates the minimum number of requirements to complete if the completion mode is type 2 (completionMode = 2).
coverId		Unique identifier of the cover image linked to the certification. (String type)
certificateId		Unique identifier of the certificate issued upon obtaining the certification. (String type)

Certification/create

Creates a certification.
API call address : https://.../lmsapi/certification/create

Request

Example of request call content to create a certification:

{
        "title": {
            "texts": [
                {
                    "text": "Certification SVI",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                }
            ],
            "ErrorID": 0
        },
        "expirationMode" : 1,
        "expiresAfterIntervalType": 1,
        "expiresAfterInterval": 2,
        "expirationReminderMode": 1,
        "expirationReminderIntervalType": 2,
        "expirationReminderInterval": 1,
        "autoResubscribes": false,
        "resubscribesBeforeExpirationIntervalType": 0,
        "resubscribesBeforeExpirationInterval": 0,
        "completionMode": 1,
        "coverId": "uDhiZb%2bXKpnUdp9zkaRizg%3d%3d",
        "certificateId": "Coxo4jSYP1PNUQ61%2fdUbBA%3d%3d"
    }

Field descriptions

Name	Required	Comments/description
title - texts - text - languageId	X	Text: Title of the certification. (String type) languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
expirationMode		Indicates the expiry mode of the certification. 0 = Never (default value) 1 = Valid for a set period of time (Number type)
expiresAfterIntervalType		Indicates the unit of measure used to define the expiry of the certification. This field is required if the expiry mode is 1. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months 4 = Years (Number type)
expiresAfterInterval		Defines the quantity of the unit of measure selected in the "expiresAfterIntervalType" field (0 by default) for the expiry of the certification. This field is required if the expiry mode is 1. The maximum allowed value is 1000. (Number type)
expirationReminderMode		Indicates the expiry reminder mode of the certification. 0 = Manual status change (default value) 1 = Automatic status change (Number type)
expirationReminderIntervalType		Indicates the unit of measure used to define the expiry reminder of the certification. This field is required if the expiry reminder mode is 1 (automatic) 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
expirationReminderInterval		Defines the quantity of the unit of measure selected in the "expirationReminderIntervalType" field (0 by default) for the expiry reminder of the certification. The maximum allowed value is 1000. (Number type)
autoResubscribes		Enables automatic re-enrolment in the sessions and cohorts linked to the certification. When enabled, the automatic re-enrolment takes place at a defined time before its expiry. (Boolean type)
resubscribesBeforeExpirationIntervalType		Indicates the unit of measure used to define the automatic re-enrolment in the requirements of the certification. This field is required if the autoResubscribes property is enabled. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
resubscribesBeforeExpirationInterval		Defines the quantity of the unit of measure selected in the "resubscribesBeforeExpirationIntervalType" field (0 by default) for the automatic re-enrolment in the requirements of the certification. The maximum allowed value is 1000. (Number type)
completionMode		The completion mode of the certification. 0 = Manual award of the certification (default value) 1 = Upon completion of all programs/training items 2 = Upon completion of a minimum number of programs/training items (Number type).
completionPartialNumber		Required field indicating the minimum number of requirements to complete if the completion mode is type 2 (completionMode = 2). The value cannot be 0 and the maximum is the sum of the associated programs or training items. You must associate training items and programs beforehand (certification/addworkspaces OR certification/addprograms).
coverId		Unique identifier of the cover image linked to the certification. (String type)
certificateId		Unique identifier of the certificate issued upon obtaining the certification. (String type)

Response

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

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/edit

Modifies a certification.
API call address : https://.../lmsapi/certification/edit

Request

Example of request call content to modify a certification:

{
        "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "Certification SVI",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                }
            ],
            "ErrorID": 0
        },
        "expirationMode" : 1,
        "expiresAfterIntervalType": 1,
        "expiresAfterInterval": 2,
        "expirationReminderMode": 1,
        "expirationReminderIntervalType": 2,
        "expirationReminderInterval": 1,
        "autoResubscribes": false,
        "resubscribesBeforeExpirationIntervalType": 0,
        "resubscribesBeforeExpirationInterval": 0,
        "completionMode": 1,
        "coverId": "uDhiZb%2bXKpnUdp9zkaRizg%3d%3d",
        "certificateId": "Coxo4jSYP1PNUQ61%2fdUbBA%3d%3d"
    }

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the certification. (String type)
title - texts - text - languageId		Text: Title of the certification. (String type) languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
expirationMode		Indicates the expiry mode of the certification. 0 = Never (default value) 1 = Valid for a set period of time (Number type)
expiresAfterIntervalType		Indicates the unit of measure used to define the expiry of the certification. This field is required if the expiry mode is 1. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months 4 = Years (Number type)
expiresAfterInterval		Defines the quantity of the unit of measure selected in the "expiresAfterIntervalType" field (0 by default) for the expiry of the certification. This field is required if the expiry mode is 1. The maximum allowed value is 1000. (Number type)
expirationReminderMode		Indicates the expiry reminder mode of the certification. 0 = Manual status change (default value) 1 = Automatic status change (Number type)
expirationReminderIntervalType		Indicates the unit of measure used to define the expiry reminder of the certification. This field is required if the expiry reminder mode is 1 (automatic) 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
expirationReminderInterval		Defines the quantity of the unit of measure selected in the "expirationReminderIntervalType" field (0 by default) for the expiry reminder of the certification. The maximum allowed value is 1000. (Number type)
autoResubscribes		Enables automatic re-enrolment in the sessions and cohorts linked to the certification. When enabled, the automatic re-enrolment takes place at a defined time before its expiry. (Boolean type)
resubscribesBeforeExpirationIntervalType		Indicates the unit of measure used to define the automatic re-enrolment in the requirements of the certification. This field is required if the autoResubscribes property is enabled. 0 = None (default value) 1 = Days 2 = Weeks 3 = Months (Number type)
resubscribesBeforeExpirationInterval		Defines the quantity of the unit of measure selected in the "resubscribesBeforeExpirationIntervalType" field (0 by default) for the automatic re-enrolment in the requirements of the certification. The maximum allowed value is 1000. (Number type)
completionMode		The completion mode of the certification. 0 = Manual award of the certification (default value) 1 = Upon completion of all programs/training items 2 = Upon completion of a minimum number of programs/training items (Number type).
completionPartialNumber		Required field indicating the minimum number of requirements to complete if the completion mode is type 2 (completionMode = 2). The value cannot be 0 and the maximum is the sum of the associated programs or training items. You must associate training items and programs beforehand (certification/addworkspaces OR certification/addprograms).
coverId		Unique identifier of the cover image linked to the certification. (String type)
certificateId		Unique identifier of the certificate issued upon obtaining the certification. (String type)

Response

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

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/delete

Deletes a certification.
API call address : https://.../lmsapi/certification/delete

Request

Example of the request call content to delete a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Response

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

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/addusers

Adds holders who will be subject to the requirements of a certification.
API call address : https://.../lmsapi/certification/addusers

Request

Example of the request call content to add holders to a certification:

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d",
     "users" : [
        {"id":"WLU4WWTo%2fMToYExq1eRlFw%3d%3e" },
        {"id":"TdQNdAVv233NKXZO%2fhSiww%3d%3d" }
     ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

users
- id

Users: unique identifiers of the users to add as holders to the certification.
id: Unique identifier of the user
(String type)

Response

Example of the response call content for a request to add holders to a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/getusers

Retrieves the list of holders subject to the requirements of a certification.
API call address : https://.../lmsapi/certification/delete

Request

Example of the request call content for the list of holders of a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Response

Example of the response call content for a request for the list of holders of a certification:

[
    {
        "id": "6SPYUlYlIeL3WXhC0eJ4jA%3d%3d",
        "id": "32hdyyJ%2brWlI5nnr1IoncQ%3d%3d",
        "id": "l8Lf1hYHzqpK4x%2fVfaDfRw%3d%3d"
    }
]

Field descriptions

Name

Required

Comments/description

Unique identifier of the user.

(String type)

Certification/removeusers

Removes holders from a certification.
API call address : https://.../lmsapi/certification/removeusers

Request

Example of the request call content to remove holders from a certification:

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d",
     "users" : [
        {"id":"WLU4WWTo%2fMToYExq1eRlFw%3d%3e" },
        {"id":"TdQNdAVv233NKXZO%2fhSiww%3d%3d" }
     ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Response

Example of the response call content for a request to remove holders from a certification:

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/addbranches

Adds the holders of a branch who will be subject to the requirements of a certification.
API call address : https://.../lmsapi/certification/addbranches

Request

Example of the request call content to add the holders of a branch to a certification:

{
    "id" : "vspCtSEvs5gD2p01X%2fX8nw%3d%3d",
     "branches" : [
        "j5CTjVbgA4GiVxS5rsxgTg%3d%3d",
        "dykA%2fVTYi0PfZC1j6V3D8A%3d%3d"
     ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

branches

Branches: unique identifiers of the user branches to add as holders to the certification.
(String type)

Response

Example of the response call content for a request to add the holders of a branch to a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/getbranches

Retrieves the list of holder branches associated with a certification.
API call address : https://.../lmsapi/certification/getbranches

Request

Example of the request call content for the list of holder branches associated with a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Response

Example of the response call content for a request for the list of holder branches associated with a certification :

[
    "j5CTjVbgA4GiVxS5rsxgTg%3d%3d",
    "dykA%2fVTYi0PfZC1j6V3D8A%3d%3d"
]

Field descriptions

Name

Required

Comments/description

Unique identifier of the branches.

(String type)

Certification/removebranches

Removes holder branches from a certification.
API call address : https://.../lmsapi/certification/removebranches

Request

Example of the request call content to remove holder branches from a certification:

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "branches": 
         [
                "WLU4WWTo%2fMToYExq1eRlFw%3d%3e",
                "TdQNdAVv233NKXZO%2fhSiww%3d%3d"
         ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

branches

Unique identifier of the holder branches of the certification.

(String type)

Response

Example of the response call content for a request to remove holder branches from a certification:

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/addworkspaces

Adds one or more training items to the requirements of a certification.
API call address : https://.../lmsapi/certification/addworkspaces

Request

Example of the request call content to add one or more training items to the requirements of a certification:

{
    "id" : "vspCtSEvs5gD2p01X%2fX8nw%3d%3d",
     "workspaces" : [
        "j5CTjVbgA4GiVxS5rsxgTg%3d%3d",
        "dykA%2fVTYi0PfZC1j6V3D8A%3d%3d"
     ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

workspaces

Workspaces: unique identifiers of the training items to add to the requirements of the certification.
(String type)

Response

Example of the response call content for a request to add one or more training items to the requirements of a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/getworkspaces

Retrieves the list of training items associated with the requirements of a certification.
API call address : https://.../lmsapi/certification/getworkspaces

Request

Example of the request call content for the list of training items associated with the requirements of a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Response

Example of the response call content for a request for the list of training items associated with the requirements of a certification :

[
    "j5CTjVbgA4GiVxS5rsxgTg%3d%3d",
    "dykA%2fVTYi0PfZC1j6V3D8A%3d%3d"
]

Field descriptions

Name

Required

Comments/description

Unique identifier of the training items.

(String type)

Certification/removeworkspaces

Removes training items associated with the requirements of a certification.
API call address : https://.../lmsapi/certification/removeworkspaces

Request

Example of the request call content to remove training items associated with the requirements of a certification:

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "workspaces": 
         [
                "WLU4WWTo%2fMToYExq1eRlFw%3d%3e",
                "TdQNdAVv233NKXZO%2fhSiww%3d%3d"
         ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

workspaces

Unique identifier of the training items of the certification.

(String type)

Response

Example of the response call content for a request to remove training items associated with the requirements of a certification:

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/addprograms

Adds one or more programs to the requirements of a certification.
API call address : https://.../lmsapi/certification/addprograms

Request

Example of the request call content to add one or more programs to the requirements of a certification:

{
    "id" : "vspCtSEvs5gD2p01X%2fX8nw%3d%3d",
     "programs" : [
        "j5CTjVbgA4GiVxS5rsxgTg%3d%3d",
        "dykA%2fVTYi0PfZC1j6V3D8A%3d%3d"
     ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

programs

Programs: unique identifiers of the program or programs to add to the requirements of the certification.
(String type)

Response

Example of the response call content for a request to add one or more programs to the requirements of a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification/getprograms

Retrieves the list of programs associated with the requirements of a certification.
API call address : https://.../lmsapi/certification/getprograms

Request

Example of the request call content for the list of programs associated with the requirements of a certification:

{
    "id": "vspCtSEvs5gD2p01X%2fX8nw%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Response

Example of the response call content for a request for the list of programs associated with the requirements of a certification :

[
    "j5CTjVbgA4GiVxS5rsxgTg%3d%3d",
    "dykA%2fVTYi0PfZC1j6V3D8A%3d%3d"
]

Field descriptions

Name

Required

Comments/description

Unique identifier of the programs.

(String type)

Certification/removeprograms

Removes programs associated with the requirements of a certification.
API call address : https://.../lmsapi/certification/removeprograms

Request

Example of the request call content to remove programs associated with the requirements of a certification:

{
    "id": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
    "programs": 
         [
                "WLU4WWTo%2fMToYExq1eRlFw%3d%3e",
                "TdQNdAVv233NKXZO%2fhSiww%3d%3d"
         ]
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

programs

Unique identifiers of the programs of the certification.

(String type)

Response

Example of the response call content for a request to remove programs associated with the requirements of a certification:

{
    "id" : "j%2bwcT2u8cUgD4FE0Xgb7ow%3d%3d"
}

Field descriptions

Name

Required

Comments/description

Unique identifier of the certification.

(String type)

Certification error code descriptions

Number	Message	Comment/description
2000	Required id	You must provide an identifier for the certification
2001	Invalid id	The identifier provided for the certification is invalid.
2002	Required title	You must provide a title for the certification.
2003	Invalid languageID	The language identifier is invalid.
2004	LanguageID is undefined	The language identifier is not defined
2005	Invalid title	The title of the certification provided must contain between 3 and 50 characters inclusively.
2006	Invalid expirationMode	The expiry mode provided is invalid
2007	Invalid expiresAfterIntervalType	The expiry interval type provided is invalid
2008	Required expiresAfterIntervalType	You must provide the expiry interval type
2009	Required expiresAfterInterval	You must provide the expiry interval value
2010	Invalid expiresAfterInterval	The expiry interval value is invalid
2011	Invalid expirationReminderMode	The reminder mode provided is invalid
2012	Invalid expirationReminderIntervalType	The expiry reminder interval type provided is invalid
2013	Required expirationReminderIntervalType	You must provide the expiry reminder interval value of the certification
2014	Required expirationReminderInterval	You must provide the expiry reminder interval value of the certification
2015	Invalid expirationReminderInterval	The expiry reminder interval of the certification is invalid
2016	Invalid completionMode value	The completion mode provided is invalid
2017	Invalid coverId	The identifier of the background image is invalid
2018	Invalid certificateId	The certificate identifier is invalid
2019	Delete certification failed	The deletion of the certification failed.
2020	Required users	You must provide the list of users
2021	Invalid userId	The identifier of a user is invalid
2022	User already added	The addition of the users failed. One or more of the users provided have already been added to the certification
2023	User is not in certification	The removal of the users failed. One or more of the users provided are not in the certification
2024	Required branches	You must provide a list of branch identifiers
2025	Branch has been already added	The addition of the branches failed. One or more of the branches provided have already been added to the certification
2026	Branch is not in certification	The removal of the branches failed. One or more of the branches provided are not in the certification
2027	Required workspaces	You must provide a list of training item identifiers
2028	Workspace already added	The addition of the training items failed. One or more of the training items provided have already been added to the certification
2029	Workspace is not in certification	The removal of the training items failed. One or more of the training items provided are not in the certification
2030	Required programs	You must provide a list of program identifiers
2031	Program has been already added	The addition of the programs failed. One or more of the programs provided have already been added to the certification
2032	Program is not in certification	The removal of the programs failed. One or more of the programs provided are not in the certification
2033	Cannot add programs/workspaces in "X" completion mode	Programs and training items can be added when the completion mode of the certification is 1. X = the name of the completionMode of the certification
2034	Invalid value for "property"	The value used in the "property" is not valid.

English

Certifications

Certification/get

Request

Field descriptions

Response

Field descriptions

Certification/getlist

Request

Field descriptions

Response

Field descriptions

Certification/create

Request

Field descriptions

Response

Field descriptions

Certification/edit

Request

Field descriptions

Response

Field descriptions

Certification/delete

Request

Field descriptions

Response

Field descriptions

Certification/addusers

Request

Field descriptions

Response

Field descriptions

Certification/getusers

Request

Field descriptions

Response

Field descriptions

Certification/removeusers

Request

Field descriptions

Response

Field descriptions

Certification/addbranches

Request

Field descriptions

Response

Field descriptions

Certification/getbranches

Request

Field descriptions

Response

Field descriptions

Certification/removebranches

Request

Field descriptions

Response

Field descriptions

Certification/addworkspaces

Request

Field descriptions

Response

Field descriptions

Certification/getworkspaces

Request

Field descriptions

Response

Field descriptions

Certification/removeworkspaces

Request

Field descriptions

Response

Field descriptions

Certification/addprograms

Request

Field descriptions

Response

Field descriptions

Certification/getprograms

Request

Field descriptions