Page Comparison

Veld

Type

Format

Omschrijving

Voorbeeld

O/V

Vullingsregel

id

string

uuid

Unieke identifier voor deze notificatie

d290f1ee-6c54-4b01-90e6-d701748f0851

V

schemaVersion

string

string

Het versienummer van de berichtdefinitie die wordt gehanteerd.

1.3.0

V

Conform Semantic Versioning 2.0.0

objectType

string

ENUM

Het type object waarvan een notificatie wordt verstuurd.

Student
StudentDelivery
Employee
Class
Group
SchoolPeriod
SchoolSubject
Product
Course

V

objectId

string

string

Identifier van het dataobject dat wordt verstuurd in het Event.

-

O

Is verplicht bij isDeleteEvent

userIdType

string

ENUM

Het type userId dat wordt gehanteerd in het veld objectId, indien het object een user betreft.

ECKiD
nlPersonProfileId
nlPersonRealId
Las-key
BasispoortId
Medewerkernummer

O*

Indien het dataobject een Student, Employee of StudentDelivery betreft, dan wordt hier gespecificeerd welke type userId is gehanteerd als objectId

schoolId

string

string

Identifier van de onderwijsorganisatie waartoe het dataobject behoort.

O*

Indien het dataobject uit de SIS API komt dan is dit veld verplicht.

De schoolId dient te worden gebruikt om het object op te vragen.

schoolPeriod

string

string

Referentie naar schoolperiode

2021-2022

O*

Referentie naar schoolPeriod.name

Indien het dataobject uit de SIS API komt dan is dit veld verplicht.

Dit stelt de Ontvanger in staat om het nieuwe, gewijzigde of verwijderde dataobject voor de correcte schoolperiode op te vragen.

edu_org_id

string

string

Onderwijsorganisatie waarop de consent is geregistreerd voor de uitwisseling van het data object.

O*

Indien het dataobject uit de SIS API komt dan is dit veld verplicht.

De edu_org_id dient te worden gebruikt om het object op te vragen.

created

string

datetime

Tijdstempel van actie die als trigger heeft gediend voor de notificatie

2017-07-21T17:32:28Z

V

url

string

string

URL naar het endpoint om het nieuwe of gewijzigde dataobject op te halen.

O

isDeleteNotification

boolean

boolean

Indicatie voor de ontvanger dat dit het laatste bericht is betreffende dit dataobject aangezien deze verwijderd is.

True of False

O