Property
Required
Patchable
Type
Remarks
content
array
A list of content items describing the course.
content[n].description
string
The description of the content.
content[n].descriptionHtml
string
The description of the content in HTML format.
content[n].intro
string
The introduction text of the content.
content[n].introHtml
string
The introduction text of the content in HTML format.
content[n].blocks
array
The course content blocks.
content[n].blocks[n].heading
string
The heading of a course content block.
content[n].blocks[n].type
enum
Allowed values: Content Block Type Enum
content[n].blocks[n].body
string
The body of a course content block.
content[n].blocks[n].bodyHtml
string
The body of a course content block in HTML format.
startDate
date time
(UTC - ISO_8601)
The start date of this course.
Example: 2023-10-16T08:28:39.6872198Z
endDate
date time
(UTC - ISO_8601)
The end date of this course.
Example: 2023-10-16T08:28:39.6872198Z
commercialPartner
enum
On POST course, brandOwner will be applied if left empty
Allowed values: Commercial Partner Enum
commercialPartnerDisplayValue
enum
Friendly description of the commercialPartner enum value
credit
object
Credits which will be obtained when following this course
credit.value
decimal
Amount of points which you can get on this course
credit.type
enum
Type of classification which is applicable for this course
Allowed values: Credit Type Enum
requirements
object
Requirements which you need to have in order to follow this course
requirements.type
enum
Type of requirement in order to follow this course
Allowed values: Requirement Type Enum
requirements.description[n]
array
Descriptions of the requirement in order to follow this course
targetSector[n]
array
The target profession for whom the course is intended
targetSector.value
enum
Allowed values: Target Sector Enum
targetSectorRijksoverheid.[n]
array
The target sector for the Rijksoverheid
targetSectorRijksoverheid.value
enum
Allowed values: Target Sector Rijksoverheid Enum
competences
array
Competences which you will obtain from following this course
competences[n].value
enum
A competence which you will obtain from following this course
Allowed values: Competences Type Enum
subsidies
array
The subsidies
subsidies[n].value
enum
Allowed values: Subsidy Enum
competencesRijksoverheids
array
competencesRijksoverheid[n].value
enum
Name of the competences
Allowed values: Competences Rijksoverheid Type Enum
accreditation
object
Type of accreditation you will achieve with this course
accreditation.type
enum
The type of accreditation
Allowed values: Accreditation Type Enum
accreditation.typeOther
string
If the type is not defined, providers have the possibility to enter a string here
accreditation.validFrom
date time
(UTC - ISO_8601)
Valid from
Example: 2023-10-16T08:28:39.6872198Z
accreditation.validTo
date time
(UTC - ISO_8601)
Valid to
Example: 2023-10-16T08:28:39.6872198Z
accreditation.points
decimal
The points you will get with this accreditation(if any)
providerLmsLink
string
The link to the learning management system of the provider
productType
enum
The product type of the course
Allowed values: Product Type Enum
searchword
array
searchword[n]
string
The name of the search word
installmentsOptions
array
The list installments options.
installmentsOptions[n].installmentsInterval
enum
The interval for the installments: Once, Monthly, Quarterly or Yearly
installmentsOptions[n].installmentsQuantity
integer
In how many installments this can be paid.
deleted
boolean
Indicates whether the course is soft deleted.
dateDeleted
date time
(UTC - ISO_8601)
If the course has been soft deleted, this property indicates the date on which the soft deletion occurred.
Example: 2023-10-16T08:28:39.6872198Z