Spotlights (Lära)

Miro Lagueux

Modified on: Mon, 31 Aug, 2026 at 10:44 AM

TABLE OF CONTENTS

Spotlights: catalogspotlight/get
Spotlights: catalogspotlight/getlist
Spotlights: catalogspotlight/create
Spotlights: catalogspotlight/edit
Spotlights: catalogspotlight/delete
Spotlights: catalogspotlight/setworkspaceinstances
Spotlights: catalogspotlight/getworkspaceinstances
Spotlights: catalogspotlight/setcohorts
Spotlights: catalogspotlight/getcohorts
Spotlight error code descriptions

Spotlights

"Spotlights" are used to highlight course sessions or program cohorts in the catalogues, by means of a coloured badge bearing a title and a label. A spotlight in the API is named "catalogspotlight".

Spotlights: catalogspotlight/get

https://www.domaine.com/lmsapi/catalogspotlight/get

Returns an object representing a spotlight in your environment.
API call address : https://.../lmsapi/catalogspotlight/get

Request

Example of request call content for information on a spotlight:

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

Field descriptions

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

Response

Example of response call content for information on a spotlight:

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "title": {
        "texts": [
            {
                "text": "API_CS_TITLE",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    },
    "label": {
        "texts": [
            {
                "text": "API_LABEL",
                "languageId": 1
            }
        ],
        "ErrorID": 0
    },
    "color": "F40000"
}

Field descriptions

Name	Comments/description
id	Unique identifier of the spotlight. (String type)
title	Title of the spotlight, as multilingual texts (texts). text: the title as seen by users in the system. (String type, between 3 and 150 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
label	Label of the spotlight, as multilingual texts (texts). text: the label as seen by users in the system. (String type, between 3 and 12 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
color	Colour of the spotlight badge. (String type)

Spotlights: catalogspotlight/getlist

https://www.domaine.com/lmsapi/catalogspotlight/getlist

Returns the list of all the spotlights in your environment.
API call address : https://.../lmsapi/catalogspotlight/getlist

Request

Example of request call content for the list of spotlights:

Field descriptions

Name	Required	Comments/description
		The method does not require any parameter.

Response

Example of response call content for the list of spotlights:

[
    {
        "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "API_CS_TITLE",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "label": {
            "texts": [
                {
                    "text": "API_LABEL",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "color": "F40000"
    },
    {
        "id": "k0gEJ48oDezizeIqAsmhmQ%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "CatalogSpotlightTitle",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "label": {
            "texts": [
                {
                    "text": "CSLabel",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "color": "FFFFFF"
    }
]

Field descriptions

Each element of the list contains the same fields as those returned by catalogspotlight/get:

Name	Comments/description
id	Unique identifier of the spotlight. (String type)
title	Title of the spotlight, as multilingual texts (texts). text: the title as seen by users in the system. (String type, between 3 and 150 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
label	Label of the spotlight, as multilingual texts (texts). text: the label as seen by users in the system. (String type, between 3 and 12 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
color	Colour of the spotlight badge. (String type)

Spotlights: catalogspotlight/create

https://www.domaine.com/lmsapi/catalogspotlight/create

Creates a spotlight in your environment.
API call address : https://.../lmsapi/catalogspotlight/create

Request

Example of request call content to create a spotlight:

{
    "title": {
        "texts": [{
                "text": "CatalogSpotlightTitle",
                "languageId": 1
            }
        ]
    },
    "label": {
        "texts": [{
                "text": "CSLabel",
                "languageId": 1
            }
        ]
    },
    "color": "FFFFFF"
}

Field descriptions

Name	Required	Comments/description
title	X	Title of the spotlight, as multilingual texts (texts). text: the title as seen by users in the system. (String type, between 3 and 150 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
label	X	Label of the spotlight, as multilingual texts (texts). text: the label as seen by users in the system. (String type, between 3 and 12 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
color		Colour of the spotlight badge. (String type)

Response

Example of response call content when creating a spotlight:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the created spotlight. (String type)

Spotlights: catalogspotlight/edit

https://www.domaine.com/lmsapi/catalogspotlight/edit

Modifies an existing spotlight.
API call address : https://.../lmsapi/catalogspotlight/edit

Request

Example of request call content to modify a spotlight:

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "title": {
        "texts": [{
                "text": "titleCS",
                "languageId": 1
            }
        ]
    },
    "label": {
        "texts": [{
                "text": "labelCS",
                "languageId": 1
            }
        ]
    },
    "color": "123456"
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the spotlight. (String type)
title		Title of the spotlight, as multilingual texts (texts). text: the title as seen by users in the system. (String type, between 3 and 150 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
label		Label of the spotlight, as multilingual texts (texts). text: the label as seen by users in the system. (String type, between 3 and 12 characters) languageId: display language. 1 = French (Canada) 2 = English 3 = French (France) 4 = Spanish (Number type)
color		Colour of the spotlight badge. (String type)

Response

Example of response call content when modifying a spotlight:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the modified spotlight. (String type)

Spotlights: catalogspotlight/delete

https://www.domaine.com/lmsapi/catalogspotlight/delete

Deletes an existing spotlight.
API call address : https://.../lmsapi/catalogspotlight/delete

Request

Example of request call content to delete a spotlight:

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

Field descriptions

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

Response

Example of response call content when deleting a spotlight:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the deleted spotlight. (String type)

Spotlights: catalogspotlight/setworkspaceinstances

https://www.domaine.com/lmsapi/catalogspotlight/setworkspaceinstances

Associates course sessions with a spotlight.
API call address : https://.../lmsapi/catalogspotlight/setworkspaceinstances

Request

Example of request call content to associate sessions with a spotlight:

{  
        "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
        "spotlightAssociations": 
        [
            {
                "id" : "jt9UU9fr%2fppeVdmulnSbPQ%3d%3d",      
                "activeFromDate": "2010-01-01T00:00:00",
                "activeUpToDate": "2031-01-01T00:00:00"
            },
            {
                "id" : "1odV3GTk6pHhgLNDBK1bnQ%3d%3d"
            }                    
        ]     
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the spotlight. (String type)
spotlightAssociations	X	Contains the list of sessions that will be associated with the spotlight. id: unique identifier of the session. (String type) activeFromDate: start date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ) activeUpToDate: end date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ)

Response

Example of response call content when associating sessions with a spotlight:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the spotlight. (String type)

Spotlights: catalogspotlight/getworkspaceinstances

https://www.domaine.com/lmsapi/catalogspotlight/getworkspaceinstances

Returns the list of course sessions associated with a spotlight.
API call address : https://.../lmsapi/catalogspotlight/getworkspaceinstances

Request

Example of request call content for the list of sessions associated with a spotlight:

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

Field descriptions

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

Response

Example of response call content for the list of sessions associated with a spotlight:

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "spotlightAssociations": [
        {
            "id": "jt9UU9fr%2fppeVdmulnSbPQ%3d%3d",
            "activeFromDate": "2010-01-01T00:00:00",
            "activeUpToDate": "2031-01-01T00:00:00"
        },
        {
            "id": "1odV3GTk6pHhgLNDBK1bnQ%3d%3d",
            "activeFromDate": "0001-01-01T00:00:00",
            "activeUpToDate": "0001-01-01T00:00:00"
        },
        {
            "id": "C81F0WSGq7p505Q97UjFlQ%3d%3d",
            "activeFromDate": "0001-01-01T00:00:00",
            "activeUpToDate": "0001-01-01T00:00:00"
        }
    ]
}

Field descriptions

Name	Comments/description
id	Unique identifier of the spotlight. (String type)
spotlightAssociations	Contains the list of sessions that will be associated with the spotlight. id: unique identifier of the session. (String type) activeFromDate: start date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ) activeUpToDate: end date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ)

Spotlights: catalogspotlight/setcohorts

https://www.domaine.com/lmsapi/catalogspotlight/setcohorts

Associates program cohorts with a spotlight.
API call address : https://.../lmsapi/catalogspotlight/setcohorts

Request

Example of request call content to associate cohorts with a spotlight:

{  
        "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
        "spotlightAssociations": 
        [
            {
                "id" : "eWAFhEFBmzdeDcziVz93Ag%3d%3d",
                "activeFromDate": "2010-01-01T00:00:00",
                "activeUpToDate": "2021-01-01T00:00:00"
            }                 
        ]     
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the spotlight. (String type)
spotlightAssociations	X	Contains the list of cohorts that will be associated with the spotlight. id: unique identifier of the cohort. (String type) activeFromDate: start date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ) activeUpToDate: end date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ)

Response

Example of response call content when associating cohorts with a spotlight:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the spotlight. (String type)

Spotlights: catalogspotlight/getcohorts

https://www.domaine.com/lmsapi/catalogspotlight/getcohorts

Returns the list of program cohorts associated with a spotlight.
API call address : https://.../lmsapi/catalogspotlight/getcohorts

Request

Example of request call content for the list of cohorts associated with a spotlight:

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

Field descriptions

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

Response

Example of response call content for the list of cohorts associated with a spotlight:

{
    "id": "Eiakb2wlFfzKdJgH23kygQ%3d%3d",
    "spotlightAssociations": [
        {
            "id": "eWAFhEFBmzdeDcziVz93Ag%3d%3d",
            "activeFromDate": "2010-01-01T00:00:00",
            "activeUpToDate": "2021-01-01T00:00:00"
        }
    ]
}

Field descriptions

Name	Comments/description
id	Unique identifier of the spotlight. (String type)
spotlightAssociations	Contains the list of cohorts that will be associated with the spotlight. id: unique identifier of the cohort. (String type) activeFromDate: start date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ) activeUpToDate: end date of the association. (Date type YYYY-MM-DDTHH:MM:SSZ)

Spotlight error code descriptions

Number	Message	Comment/description
2201	RequiredID	You must provide an identifier for the catalogspotlight
2202	InvalidID	You must provide a valid identifier for the catalogspotlight
2203	RequiredTitle	You must provide a title
2204	InvalidTitleLength	The length of the title provided is invalid
2205	RequiredLabel	You must provide a label
2206	InvalidLabelLength	The length of the label provided is invalid
2207	RequiredSpotlightAssociationID	You must provide an identifier for the association object
2208	InvalidSpotlightAssociationID	The identifier provided for the association object is invalid
2209	InvalidSpotlightAssociationData	The data contained in the association object is invalid
2210	InvalidActiveFromDate	The association start date is not valid
2211	InvalidActiveUpToDate	The association end date is not valid
2212	InvalidLanguageID	The language identifier is not valid
2213	UndefinedLanguageID	The language identifier does not match any language
2214	DeleteHasFailed	The deletion failed
2215	AssociationHasFailed	The association failed

English

Spotlights

Spotlights: catalogspotlight/get

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/getlist

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/create

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/edit

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/delete

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/setworkspaceinstances

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/getworkspaceinstances

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/setcohorts

Request

Field descriptions

Response

Field descriptions

Spotlights: catalogspotlight/getcohorts

Request

Field descriptions

Response

Field descriptions

Spotlight error code descriptions

Related Articles