Name 

Required

Comments/description

id

Unique identifier of the course.
(String type)

Name 

Comments/description

id

This is the unique database identifier. This parameter must be empty when the WorkspaceCreate method is used, but is required in order to call WorkspaceEdit. (String type)

websiteId

This is the unique identifier used when accessing the portal pages.

creationDate

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

type

Unique identifier of the type of the course or event. Refer to the edit page of the desired type to retrieve this identifier, or to workspace/gettypes

name

Name of the course or event as displayed in the portal (String type, between 5 and 250 characters)

language

Language of the course or event

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

 (Number type)

categoryId

The identifier of the category with which your course or event is associated. If several categories are already defined, they will be cleared so that only this category is kept. Returns the identifier of the first associated category.

(String type).

coverId

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

providerId

The identifier of the service provider with which your course or event is associated. Your item can be associated with only one service provider. (String type) In create, the default service provider is used.

visibilityType 

Visibility type in the catalogues

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

(Number type)

maxParticipants

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

(Number type)

A value of 0 means no maximum

minParticipants

Minimum number of enrolled users required for the course to take place.

(Number type)

A value of 0 means no minimum

description

Description of the course; this will be displayed in the catalogue and in the course. (String type)

shortDescription

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

(String type)

subscriptionType

Determines whether the event or course accepts enrolments: 

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

startDate

This value is required if the specific SubscriptionType (2) is selected. It determines the start of the range during which enrolments 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 enrolments are accepted. 

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

isOverBookingSubscription

Boolean - this enables the waiting list. The default value is false. 

authorizationType

Accepted authorization types: 

• 0 = Approval by an administrator
• 1 = Automatic

enrolmentType

Accepted enrolment types: 

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

externalLink

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

catalogLink

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

(Get only)

keywords

Search keywords for the course. Maximum 250 characters.

showAvailableSubscriptions

Boolean - By default this value is "false". Displays the number of available and total seats in the catalogue when users enrol. 

certificateId

Identifier of the certificate associated with the course or event. It is awarded automatically based on the completion criteria of the workspace. (String type)

credits

Number of credits associated with the successful completion of this course. It cannot be specified if the course or event already has several categories.

Number type

nbUsersSubbed

Value available in GET only, used to obtain the number of users enrolled across all sessions of the course or event

Number type

nbUsersQueue

Value available in GET only, used to obtain the number of users on the waiting list across all sessions of the course or event

Number type

instanceDaysAvailable

Determines the number of days after a user's enrolment during which they have access to the content.

This value can be redefined for each session.

A value of 0 means always accessible

instanceDaysToComplete

Determines the maximum number of days after a user's enrolment by which they must have completed the content.

This value can be redefined for each session.

A value of 0 means no completion deadline

isAutodeclaration

Determines whether the workspace can be used as a template to self-declare an accreditation.

Boolean type

accreditationNumber

Determines the accreditation number for a self-declaration

Required only if isAutodeclaration is set to True

autodeclarationStartDate

Determines the earliest date for self-declaring this workspace as an accreditation.

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

autodeclarationEndDate

Determines the latest date for self-declaring this workspace as an accreditation.

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

autodeclarationOrganization

Determines the default organization name to display for a new self-declaration.

autodeclarationApprovalRequired

Determines whether the self-declaration must be approved by an administrator

autodeclarationProofUpload

Determines whether the self-declaration allows supporting documents to be uploaded

autodeclarationProofRequired

Determines whether the self-declaration requires supporting documents to be uploaded

autodeclarationSolemnDeclaration

Determines whether the self-declaration requires a solemn declaration from the user before being submitted

catalogId

Only when creating a course or event.

Identifier of the catalogue to which this course or event is to be added.

lastModificationDate

Date of the last modification of the course

Cannot be modified. Available in get and getlist.

customFields

Custom fields linked to the course or event.

taxEnabled

Indicates whether taxes are enabled on the course or event.

(Boolean type)

taxCountryId

Number indicating the country of the course or event

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

taxStateId

Number indicating the state of the course or event. 

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

Name 

Comments/description

portalId

Unique identifier of the portal for which the URL is returned.
(String type)

url

URL to the public catalogue page of this course or event for the corresponding portal.
(String type)

Name 

Required

Comments/description

id

Unique identifier of the course.
(String type)

Name 

Comments/description

branches

List of the unique identifiers of the administrative branches associated with the course or event.
(List of strings type)

Name 

Required

Comments/description

id

Unique identifier of the course.
(String type)

branches

List of the unique identifiers of the administrative branches.
(List of strings type)

Name 

Comments/description

id

Unique identifier of the course or event to which the branches were added.
(String type)

Name 

Required

Comments/description

id

Unique identifier of the course.
(String type)

branches

List of the unique identifiers of the administrative branches.
(List of strings type)

Name 

Comments/description

id

Unique identifier of the course or event from which the branches were removed.
(String type)

Number

Message

Comments/description

400

Required id

You must provide an identifier for the course or event.

401

Invalid id

The identifier provided for the course or event is invalid.

402

Required type

You must provide an identifier for the type of the course or event.

403

Invalid type

The identifier provided for the type of the course or event is not valid.

404

Required name

You must provide a name for the course or event.

405

Invalid name length

The name provided for the course or event must contain between 5 and 250 characters inclusively. 

406

Required minParticipants

You must provide a minimum number of participants.

407

Invalid minParticipants

The minimum number of participants provided must be greater than or equal to 0.

408

Required maxParticipants

You must provide a maximum number of participants.

409

Invalid maxParticipants

The maximum number of participants provided must be greater than or equal to 0.

410

Required subscriptionType

You must provide the enrolment type.

411

Required isOverBookingSubscription

You must provide "True" or "False".

412

Required authorizationType

You must provide the authorization type for enrolments.

413

Required visibilityType

You must provide the visibility type of the course.

414

Required showAvailableSubscriptions

You must provide "True" or "False".

415

Required accreditationNumber

If self-declaration is enabled, you must provide an accreditation number.

416

Invalid accreditationNumber length

The accreditation number provided is invalid.

417

Required autodeclarationOrganization

When self-declaration is enabled, you must provide an organization name.

418

Invalid autodeclarationOrganization length

The length of the organization name provided for the self-declaration must be between 3 and 250 characters inclusively.

419

Invalid instanceDaysAvailable

The number of days provided for the availability of the course or event is invalid.

420

Invalid instanceDaysToComplete

The number of days provided to complete the course is invalid.

421

Invalid providerId

The identifier provided for the provider is invalid.

422

Certificate requires providerId

When you provide a certificate identifier, you must provide an identifier for the provider.

423

Invalid certificateId

The identifier provided for the certificate is invalid.

424

Invalid catalogId

The identifier provided for the catalogue is invalid.

425

Invalid coverId

The identifier provided for the cover image selection is invalid.

426

Required externalLink

If the accepted enrolment type is external, you must provide a redirect link.

427

Invalid externalLink length

If the accepted enrolment type is external, the redirect link provided must contain between 5 and 250 characters inclusively.

428

Invalid keywords length

The keyword list must contain a maximum of 250 characters inclusively.

429

Invalid workspaceType ID

The identifier provided for the course or event type is invalid.

430

Autodeclaration not enabled

You must enable self-declaration in order to modify its settings.

431

Invalid shortDescription Length

The short description must contain a maximum of 200 characters inclusively.

432

Invalid filterId

The identifier provided to perform the filter is invalid.

433

Invalid public id

The public identifier provided for the course or event is invalid.

The value provided for the language is invalid.