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

categoryCode [DEPRECATED]

 

(tick)

enum

Allowed values: Category Code Enum

[DEPRECATED] Please use the segment and subsegment properties instead

categoryCodeDisplayValue [DEPRECATED]

 

 

enum

Friendly description for the Category Code Enum

domainCode [DEPRECATED]

 

(tick)

enum

Allowed values: Domain Code Enum

[DEPRECATED] Please use the segment and subsegment properties instead

domainCodeDisplayValue [DEPRECATED]

 

 

enum

Friendly description for the Domain Code enum

domainCodeRijksoverheid [DEPRECATED]

 

(tick)

enum

The domain for the Rijksoverheid

Allowed values: Domain Code Rijksoverheid Enum

[DEPRECATED] Please use the segment and subsegment properties instead

domainCodeRijksoverheidDisplayValue [DEPRECATED]

 

 

enum

Friendly description for the Domain Code Rijksoverheid Enum

educationLevelCode

 

(tick)

enum

Allowed values: Education Level Code Enum

educationLevelCodeDisplayValue

 

 

enum

Friendly description for the Education Level Code Enum

segment

 

(tick)

object

Allowed values: “Name” properties retrieved from the “/provider/v1/segments” endpoint

subSegment

(info)

(tick)

object

Allowed values: “Name” properties retrieved from the “/provider/v1/sub-segments” endpoint.

Required in case “segment” is not empty and course not from Edudex.

The subSegment has to be related to the segment. To see what subSegments are related to a segment use the “subSegments” expand on “/provider/v1/segments/{segmentId}”

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.language [DEPRECATED]

 

(tick)

string

Language of the course

learningMethod.languageCode

 

(tick)

string

Language code of the course

learningMethod.languageDisplayValue [DEPRECATED]

 

(tick)

string

Language display value of the course

learningMethod.languageCodeDisplayValue

 

(tick)

string

Language code display value of the course

learningMethod.languageMaterial [DEPRECATED]

 

(tick)

string

Language of the material supplied with 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

learningMethod.planning

 

(tick)

object

The planning information for this learningmethod.

learningMethod.planning.startMoments

 

(tick)

array

The list of startMoments. If learningMethod.type equals "eLearning", then startMoments should be empty.

learningMethod.planning.startMoments[n].externalId

(tick)

(tick)

string

External identifier for the startmoment. Needs to be unique in the course

learningMethod.planning.startMoments[n].type

 

(tick)

enum

Allowed values: Start Moment Type Enum

learningMethod.planning.startMoments[n].contactSessions

 

(tick)

int

The number of sessions present in this startmoment

learningMethod.planning.startMoments[n].city

(tick)

(tick)

string

The location where the startmoment will take place.

learningMethod.planning.startMoments[n].houseNumber

 

(tick)

string

The house number of the start date.

learningMethod.planning.startMoments[n].postcode

 

(tick)

string

The postcode of the start date.

learningMethod.planning.startMoments[n].streetName

 

(tick)

string

The streetName of the start date.

learningMethod.planning.startMoments[n].dayOfWeek

 

(tick)

enum

Allowed values: sun, mon, tue, wed, thu, fri, sat

learningMethod.planning.startMoments[n].startDate

(tick)

(tick)

object

The startmoment start date object.

learningMethod.planning.startMoments[n].startDate.day

 

(tick)

integer

The day of the start date.

learningMethod.planning.startMoments[n].startDate.month

(tick)

(tick)

integer

The month of the start date.

learningMethod.planning.startMoments[n].startDate.year

(tick)

(tick)

integer

The year of the start date.

learningMethod.planning.startMoments[n].cutOffDate

(info)

(tick)

string

(info) CutOffDate is required when product type is “Incompany” and it must be specified for every startmoment

learningMethod.planning.startMoments[n].startGuaranteed

 

(tick)

boolean?

Indication whether it is guaranteed that this startmoment will take place.

learningMethod.planning.startMoments[n].minParticipants

 

(tick)

integer

The minimum number of participants required on a course

learningMethod.planning.startMoments[n].maxParticipants

 

(tick)

integer

The maximum number of participants allowed on a course

learningMethod.planning.startMoments[n].invoiceItems

 

(tick)

array

The costs information for a course.

learningMethod.planning.startMoments[n].invoiceItems[n].costType

(tick)

(tick)

enum

Allowed values : Cost Types Enum

learningMethod.planning.startMoments[n].invoiceItems[n].quantity

 

(tick)

integer

The number of items

learningMethod.planning.startMoments[n].invoiceItems[n].priceBeforeTax

(tick)

(tick)

decimal

The price of this item excluding tax.

learningMethod.planning.startMoments[n].invoiceItems[n].vatAmount

(tick)

(tick)

decimal

The VAT of this item.

learningMethod.planning.startMoments[n].invoiceItems[n].vatCountry

 

(tick)

string

The country where the VAT is going to be charged

learningMethod.planning.startMoments[n].invoiceItems[n].vatPercentage

 

(tick)

decimal

The VAT % that is being charged

learningMethod.planning.startMoments[n].invoiceItems[n].vatExemptAmount

(tick)

(tick)

decimal

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

learningMethod.planning.startMoments[n].invoiceItems[n].vatExemptAmountVAT

(tick)

(tick)

decimal

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

learningMethod.planning.startMoments[n].invoiceItems[n].isOptional

 

 

boolean?

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

learningMethod.planning.startMoments[n].modules

(tick)

(tick)

array

All modules within this startmoment.

learningMethod.planning.startMoments[n].modules[n].name

(tick)

(tick)

string

The name of the module.

learningMethod.planning.startMoments[n].modules[n].city

 

(tick)

string

The location where the module will take place.

learningMethod.planning.startMoments[n].modules[n].dayOfWeek

 

(tick)

enum

Allowed values: sun, mon, tue, wed, thu, fri, sat

learningMethod.planning.startMoments[n].modules[n].events

(tick)

(tick)

array

All events of this module.

learningMethod.planning.startMoments[n].modules[n].events[n].externalId

 

(tick)

string

External identifier for the event

learningMethod.planning.startMoments[n].modules[n].events[n].eventDate

(tick)

(tick)

date time

(UTC - ISO_8601)

The date when this event will take place.

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

learningMethod.planning.startMoments[n].modules[n].events[n].startTime

 

(tick)

date time

(UTC - ISO_8601)

The start time of this event.

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

learningMethod.planning.startMoments[n].modules[n].events[n].endTime

 

(tick)

date time

(UTC - ISO_8601)

The end time of this event.

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

learningMethod.planning.startMoments[n].modules[n].events[n].city

 

(tick)

string

The location where the event will take place.

learningMethod.planning.startMoments[n].modules[n].events[n].dayOfWeek

 

(tick)

enum

Allowed values: sun, mon, tue, wed, thu, fri, sat

learningMethod.planning.startMoments[n].modules[n].events[n].building

 

(tick)

string

The building in which the event will take place

learningMethod.planning.startMoments[n].modules[n].events[n].room

 

(tick)

string

The room in which the event will take place

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.