Programs (Lära)

Name 

Comments/description

id

This is the unique database identifier. (String type)

creationDate

Creation date of the learning program. (get only) String type (YYYY-MM-DDTHH:MM:SSZ)

name

Name of the learning program as displayed in the portal. (String type, between 5 and 250 characters)

minParticipants

Minimum number of registered users required for the learning program to take place.

(Number type)

A value of 0 means no minimum

maxParticipants

Maximum number of users who can register (if the waiting list is not enabled) 

(Number type)

A value of 0 means no maximum

description

Description of the learning program; this will be displayed in the catalogue and in the learning program.

(String type)

coverId

The identifier of the cover image of your learning program. Your item can be associated with only one cover image. (String type)

subscriptionType

Determines whether the learning program accepts registrations: 

• 0 = Open for registration (default value) 
• 1 = Closed 
• 2 = Open for registration for a specific period

enrolmentType

Accepted registration types: 

• 0 = Self-registration
• 1 = Manual  (administrative)
• 2 = External 

authorizationType

Accepted authorization types: 

• 0 = Approval by an administrator
• 1 = Automatic

visibilityType 

Visibility type in the catalogues

• 0 = PublicVisibility = public, unauthenticated visitors
• 1 = AuthenticatedVisibility = authenticated users
• 2 = SubscribedVisibility = registered users only
• 3 = MaskedVisibility = hidden 

(Number type)

startDate

This value is required if the specific SubscriptionType (2) is selected. It determines the start of the range during which registrations are accepted.

(Date type YYYY-MM-DDTHH:MM:SSZ)

endDate

This value is required if the specific SubscriptionType (2) is selected. It determines the end of the range during which registrations are accepted. 

(Date type YYYY-MM-DDTHH:MM:SSZ)

showAvailableSubscriptions

By default this value is "false". Displays the number of available and total seats in the catalogue when users register. (Boolean type)

providerId

The identifier of the service provider with which your learning program is associated. Your item can be associated with only one service provider. (String type) 

certificateId

Identifier of the certificate associated with the learning program. It is awarded automatically based on the completion criteria of the learning program. (String type)

categoryId

The identifier of the category with which your learning program is associated. Your item can be associated with only one category. (String type)

credits

Number of credits associated with the successful completion of this learning program. 

(Number type)

keywords

Search keywords for the learning program. Maximum 250 characters.

createdByUserID

The identifier of the user who created the learning program. (String type).

shortDescription

Short description of the learning program; this will be displayed in the catalogue.

(String type)

status

Status of the learning program.

• 0 = Active 
• 1 = Cancelled
• 2 = Deleted

(Number type)

language

Language of the learning program.

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

 (Number type)

externalLink

Redirect URL applied to the "register" link to redirect the user to an external site for registration. Maximum 250 characters.

taxEnabled

Indicates whether taxes are enabled on the learning program.

(Boolean type)

taxCountryId

Number indicating the country of the learning program

 Number type (See Appendix 3: Countries and States/Provinces)

taxStateId

Number indicating the state of the learning program 

Number type (See Appendix 3: Countries and States/Provinces)

isSinglePayment

Indicates whether payment is made at the learning program level.

(Boolean type)

expirationType

Expiration type for the registrations of the cohorts of the learning program. 

• 0 = No expiration
• 1 = Number of days after registration
• 2 = Deadline

(Number type)

daysToComplete

Number of days after registration before it expires.

(Number type)

dateToComplete

Deadline for the expiration of all the registrations of the learning program.

(Number type)

catalogLink

URL to the public catalogue page for this learning program. The URL provided points to the default portal. 

(Get only)

lastModificationDate

Date of the last modification of the learning program

Cannot be modified. Available in get and getlist.

• Modification of the administrative settings of the learning program;
• Addition or removal of catalogues;

Name 

Comments/description

id

This is the unique database identifier. (String type)

creationDate

Creation date of the learning program. (get only) String type (YYYY-MM-DDTHH:MM:SSZ)

name

Name of the learning program as displayed in the portal. (String type, between 5 and 250 characters)

minParticipants

Minimum number of registered users required for the learning program to take place.

(Number type)

A value of 0 means no minimum

maxParticipants

Maximum number of users who can register (if the waiting list is not enabled) 

(Number type)

A value of 0 means no maximum

description

Description of the learning program; this will be displayed in the catalogue and in the learning program.

(String type)

coverId

The identifier of the cover image of your learning program. Your item can be associated with only one cover image. (String type)

subscriptionType

Determines whether the learning program accepts registrations: 

• 0 = Open for registration (default value) 
• 1 = Closed 
• 2 = Open for registration for a specific period

enrolmentType

Accepted registration types: 

• 0 = Self-registration
• 1 = Manual  (administrative)
• 2 = External 

authorizationType

Accepted authorization types: 

• 0 = Approval by an administrator
• 1 = Automatic

visibilityType 

Visibility type in the catalogues

• 0 = PublicVisibility = public, unauthenticated visitors
• 1 = AuthenticatedVisibility = authenticated users
• 2 = SubscribedVisibility = registered users only
• 3 = MaskedVisibility = hidden 

(Number type)

startDate

This value is required if the specific SubscriptionType (2) is selected. It determines the start of the range during which registrations are accepted.

(Date type YYYY-MM-DDTHH:MM:SSZ)

endDate

This value is required if the specific SubscriptionType (2) is selected. It determines the end of the range during which registrations are accepted. 

(Date type YYYY-MM-DDTHH:MM:SSZ)

showAvailableSubscriptions

By default this value is "false". Displays the number of available and total seats in the catalogue when users register. (Boolean type)

providerId

The identifier of the service provider with which your learning program is associated. Your item can be associated with only one service provider. (String type) 

certificateId

Identifier of the certificate associated with the learning program. It is awarded automatically based on the completion criteria of the learning program. (String type)

categoryId

The identifier of the category with which your learning program is associated. Your item can be associated with only one category. (String type)

credits

Number of credits associated with the successful completion of this learning program. 

(Number type)

keywords

Search keywords for the learning program. Maximum 250 characters.

createdByUserID

The identifier of the user who created the learning program. (String type).

shortDescription

Short description of the learning program; this will be displayed in the catalogue.

(String type)

status

Status of the learning program.

• 0 = Active 
• 1 = Cancelled
• 2 = Deleted

(Number type)

language

Language of the learning program.

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

 (Number type)

externalLink

Redirect URL applied to the "register" link to redirect the user to an external site for registration. Maximum 250 characters.

taxEnabled

Indicates whether taxes are enabled on the learning program.

(Boolean type)

taxCountryId

Number indicating the country of the learning program

 Number type (See Appendix 3: Countries and States/Provinces)

taxStateId

Number indicating the state of the learning program 

Number type (See Appendix 3: Countries and States/Provinces)

isSinglePayment

Indicates whether payment is made at the learning program level.

(Boolean type)

expirationType

Expiration type for the registrations of the cohorts of the learning program. 

• 0 = No expiration
• 1 = Number of days after registration
• 2 = Deadline

(Number type)

daysToComplete

Number of days after registration before it expires.

(Number type)

dateToComplete

Deadline for the expiration of all the registrations of the learning program.

(Number type)

catalogLink

URL to the public catalogue page for this learning program. The URL provided points to the default portal. 

(Get only)

lastModificationDate

Date of the last modification of the learning program

Cannot be modified. Available in get and getlist.