Property

Required

Patchable

Type

Remarks

id

(tick)

 

guid

Uniquely generated on POST, but can be set if desired. Should always be unique within the document store.

externalId

(tick)

(tick)

string

Required external identifier for provider. Needs to be unique

internalId

 

(tick)

string

Program run ID

edudexProgramUrl

 

 

string

When applicable, this will hold the edudex url from which the course was imported

status

(tick)

 

enum

Allowed values: Course Status Enum

source

(tick)

 

enum

The source of the course

Allowed values: Source Enum

sourceDisplayValue

 

 

enum

Friendly description of the Source Enum

name

(tick)

(tick)

string

The name of the course.

shortName

 

(tick)

string

The short name of the course

educationLevelCode

 

(tick)

enum

Allowed values: Education Level Code Enum

educationLevelCodeDisplayValue

 

 

enum

Friendly description for the Education Level Code Enum

providerId

(tick)

 

guid

Required, must be a valid provider identifier. If connected with scope read:course or write:course all API methods (GET, POST, DELETE, etc) must filter on the claim provider-id.

learningMethod

(tick)

(tick)

object

Each course has to have at least 1 learning method.

learningMethod.type

(tick)

(tick)

enum

Allowed values: Learning Method Type Enum

In case the learning method is SelfPlanned, no planning.startmoments are allowed.

learningMethod.typeDisplayValue

 

(tick)

enum

Allowed values: Learning Method Type Enum

learningMethod.format

 

(tick)

enum

Allowed values: Learning Method Format Enum

learningMethod.formatDisplayValue

 

(tick)

enum

Allowed values: Learning Method Format Enum

learningMethod.languageCode

 

(tick)

string

Language code of the course

learningMethod.languageCodeDisplayValue

 

(tick)

string

Language code display value of the course

learningMethod.languageMaterialCode

 

(tick)

string

Language code of the material supplied with the course

learningMethod.languageMaterialCodeDisplayValue

 

(tick)

string

Language code display value of the material supplied with the course

learningMethod.studyLoad

 

(tick)

object

The indicated study load for the course

learningMethod.studyLoad.value

 

(tick)

decimal

Indicated study time in hours

learningMethod.studyLoad.unit

 

(tick)

enum

Indicated study time

Allowed values: Study Load Period Enum

learningmethod.contactSessions

 

(tick)

int

The number of sessions present in this course

learningMethod.costs

(tick)

(tick)

object

The costs information for a course.

learningMethod.costs.details

(tick)

(tick)

array

An array of cost details objects.

Important!

The costs are based on the date of ordering, not based on the start date of the startmoment!

learningMethod.costs.details[n].startDate

 

(tick)

date time

(UTC - ISO_8601)

The start date from when this cost details information is valid.

Example: 2023-10-16T08:28:39.6872198Z

learningMethod.costs.details[n].endDate

 

(tick)

date time

(UTC - ISO_8601)

The end date untill when this cost details information is valid.

Example: 2023-10-16T08:28:39.6872198Z

learningMethod.costs.details[n].currencyCode

 

(tick)

enum

Allowed values: Currency Code Enum

learningMethod.costs.details[n].invoiceItems

(tick)

(tick)

array

The invoice items belonging to this cost details instance.

learningMethod.costs.details[n].invoiceItems[n].costType

(tick)

(tick)

enum

Allowed values : Cost Types Enum

learningMethod.costs.details[n].invoiceItems[n].costTypeDisplayValue

 

(tick)

string

Allowed values : Cost Types Enum

learningMethod.costs.details[n].invoiceItems[n].quantity

 

(tick)

integer

The number of times this item will be invoiced.

learningMethod.costs.details[n].invoiceItems[n].priceBeforeTax

(tick)

(tick)

decimal

The price of this invoice item excluding tax.

learningMethod.costs.details[n].invoiceItems[n].vatAmount

(tick)

(tick)

decimal

The VAT of this invoice item.

learningMethod.costs.details[n].invoiceItems[n].vatCountry

 

(tick)

string

The country where the VAT is going to be charged

learningMethod.costs.details[n].invoiceItems[n].vatPercentage

 

(tick)

decimal

The VAT % that is being charged

learningMethod.costs.details[n].invoiceItems[n].vatExemptAmount

(tick)

(tick)

decimal

The VAT replacement of this invoice item for companies (accounts) that are VAT exempt.

learningMethod.costs.details[n].invoiceItems[n].vatExemptAmountVAT

(tick)

(tick)

decimal

The VAT amount companies who are VAT exempt pay

learningMethod.costs.details[n].invoiceItems[n].isOptional

 

 

boolean?

Costs can be optional and not taken into account for price calculations

learningMethod.duration

(tick)

(tick)

object

Object that contains the duration of the course in the form of length and unit

learningMethod.duration.value

(tick)

(tick)

decimal

A positive value higher than zero.

learningMethod.duration.unit

(tick)

(tick)

enum

Allowed values: Duration Unit Enum

diplomaType

 

(tick)

enum

Allowed values: Diploma Type Enum

diplomaTypeDisplayValue

 

 

enum

 

crebo

 

(tick)

string

The number through which the course is registered in the Centraal Register Beroepsopleidingen.

croho

 

(tick)

string

The number through which the course is registered in the Centraal Register Opleidingen Hoger Onderwijs.

isProfessionalCourse

 

 

boolean

Declares if the course material is professional or hobby-based.

content

 

(tick)

array

A list of content items describing the course.

content[n].description

 

(tick)

string

The description of the content.

content[n].descriptionHtml

 

(tick)

string

The description of the content in HTML format.

content[n].intro

 

(tick)

string

The introduction text of the content.

content[n].introHtml

 

(tick)

string

The introduction text of the content in HTML format.

content[n].blocks

 

(tick)

array

The course content blocks.

content[n].blocks[n].heading

(tick)

(tick)

string

The heading of a course content block.

content[n].blocks[n].type

(tick)

(tick)

enum

Allowed values: Content Block Type Enum

content[n].blocks[n].body

 

(tick)

string

The body of a course content block.

content[n].blocks[n].bodyHtml

 

(tick)

string

The body of a course content block in HTML format.

startDate

 

(tick)

date time

(UTC - ISO_8601)

The start date of this course.

Example: 2023-10-16T08:28:39.6872198Z

endDate

 

(tick)

date time

(UTC - ISO_8601)

The end date of this course.

Example: 2023-10-16T08:28:39.6872198Z

commercialPartner

 

(tick)

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

 

(tick)

object

Credits which will be obtained when following this course

credit.value

 

(tick)

decimal

Amount of points which you can get on this course

credit.type

 

(tick)

enum

Type of classification which is applicable for this course

Allowed values: Credit Type Enum

requirements

 

(tick)

object

Requirements which you need to have in order to follow this course

requirements.type

 

(tick)

enum

Type of requirement in order to follow this course

Allowed values: Requirement Type Enum

requirements.description[n]

 

(tick)

array

Descriptions of the requirement in order to follow this course

targetSector[n]

 

(tick)

array

The target profession for whom the course is intended 

targetSector.value

 

(tick)

enum

Allowed values: Target Sector Enum

targetSectorRijksoverheid.[n]

 

(tick)

array

The target sector for the Rijksoverheid

targetSectorRijksoverheid.value

 

(tick)

enum

Allowed values: Target Sector Rijksoverheid Enum

competences

 

(tick)

array

Competences which you will obtain from following this  course

competences[n].value

 

(tick)

enum

A competence which you will obtain from following this  course

Allowed values: Competences Type Enum

subsidies

 

(tick)

array

The subsidies

subsidies[n].value

 

(tick)

enum

Allowed values: Subsidy Enum

competencesRijksoverheids

 

(tick)

array

 

competencesRijksoverheid[n].value

 

(tick)

enum

Name of the competences

Allowed values: Competences Rijksoverheid Type Enum

accreditation

 

(tick)

object

Type of accreditation you will achieve with this course

accreditation.type

 

(tick)

enum

The type of accreditation

Allowed values: Accreditation Type Enum

accreditation.typeOther 

 

(tick)

string

If the type is not defined, providers have the possibility to enter a string here

accreditation.validFrom 

 

(tick)

date time

(UTC - ISO_8601)

Valid from

Example: 2023-10-16T08:28:39.6872198Z

accreditation.validTo

 

(tick)

date time

(UTC - ISO_8601)

Valid to

Example: 2023-10-16T08:28:39.6872198Z

accreditation.points 

 

(tick)

decimal

The points you will get with this accreditation(if any)

providerLmsLink

 

(tick)

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

 

(tick)

array

 

searchword[n]

 

(tick)

string

The name of the search word

installmentsOptions

(tick)

array

The list installments options.

installmentsOptions[n].installmentsInterval

(tick)

(tick)

enum

The interval for the installments: Once, Monthly, Quarterly or Yearly

installmentsOptions[n].installmentsQuantity

(tick)

(tick)

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