Table of Contents

Endpoints

...

Environment

...

URL

...

WSDL

...

Production

...

https://cr.directetoegang.nl/soap/3.1/registration

...

/wsdl

...

Acceptance
(school year 2023-2024)

...

https://ketentest-cr.directetoegang.nl/soap/3.1/registration

...

Zie Technical documentation voor het actuele overzicht.

Authorization

In order to access the Registration service you need a service account which is provided by support@edu-ix.nl.

...

All operations need the LoginHeader to authenticate.

Name

Type

Cardinality

LoginHeader

1...1

Source

Code Block
<urn:LoginHeader> <Username>?</Username> <Password>?</Password> </urn:LoginHeader>

Operations

GetSchool

Description

...

Specify an OrganisationId to retrieve one specific school record.
Specify a Realm to retrieve all linked school records of an specific idp.
Specify a timestamp in ModifiedSince to retrieve all changes since this timestamp.
Send an empty request to retrieve alle school records.

Name

Type

Cardinality

OrganisationId

string

0...1

Realm

string

0...1

ModifiedSince

dateTime

0...1

Source

Code Block
<urn:GetSchoolRequest> <!--Optional:--> <OrganisationId>?</OrganisationId> <!--Optional:--> <Realm>?</Realm> <!--Optional:--> <ModifiedSince>?</ModifiedSince> </urn:GetSchoolRequest>

Response

In case of an error, a RegistrationFault is returned.

Name	Type	Cardinality
School	School	0...n

...

GetIdp

Description

This operation allows to retrieve 1 or more idp records, including information about their linked schools.

...

Specify Realm or IdpId to retrieve one specific idp record.
Specify an OrganisationId to retrieve the idp record of a specific school.
Specify a timestamp in ModifiedSince to retrieve all changes since this timestamp.
Send an empty request to retrieve alle idp records.

Name

Type

Cardinality

IdpId

string

0…1

Realm

string

0...1

OrganisationId

string

0...1

ModifiedSince

dateTime

0...1

Source

Code Block

      <urn:GetIdpRequest>
         <!--Optional:-->
         <IdpId>?</IdpId>
         <!--Optional:-->
         <Realm>?</Realm>
         <!--Optional:-->
         <OrganisationId>?</OrganisationId>         
         <!--Optional:-->
         <ModifiedSince>?</ModifiedSince>
      </urn:GetIdpRequest>

Response

In case of an error, a RegistrationFault is returned.

Name	Type	Cardinality
Idp	Idp	0...n

...

Errors

General errors

General errors may occur within every operation.

Error code

Description

-1

Generic Error

For instance: Invalid xml request

-2

Authentication Error

For instance when invalid credentials are provided.

-3

Internal Error

Specific errors

Specific errors are bound to the given input or request and depend on the operation you execute.

Error code	Description
-	-

...

Complex types

LoginHeader

Name

Type

Cardinality

Description

Username

string

1...1

Username of the service account

Password

string

1...1

Password of the service account

Source

Code Block

	<xsd:element name="LoginHeader">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="Username" type="types:String100" minOccurs="1" maxOccurs="1"/>
				<xsd:element name="Password" type="types:String64" minOccurs="1" maxOccurs="1"/>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>

Address

Name

Type

Cardinality

Street

string

0...1

HouseNumber

int

0...1

HouseNumberSuffix

string

0…1

PostalCode

0…1

City

string

0…1

Source

Code Block

<xsd:complexType name="Address">
		<xsd:sequence>
			<xsd:element name="Street" type="xsd:string" minOccurs="0" />
			<xsd:element name="HouseNumber" type="xsd:int" minOccurs="0" />
			<xsd:element name="HouseNumberSuffix" type="xsd:string" minOccurs="0" />
			<xsd:element name="PostalCode" type="types:PostalCode" minOccurs="0" />
			<xsd:element name="City" type="xsd:string" minOccurs="0" />
		</xsd:sequence>
</xsd:complexType>

School

Name

Type

Cardinality

Description

DateModified

dateTime

1…1

OrganisationId

string

1…1

Unique identifier of the school

Name

string

1…1

Address

1…1

Brin

0…1

See simple types

Contact

0…n

Contact details (additional rights needed)

HasIdpRegistration

boolean

1…1

Has an idp registered or not (see Idp list)

Idp

IdpLink

0…n

List of linked idp’s

Source

Code Block

	<xsd:complexType name="School">
		<xsd:sequence>
			<xsd:element name="OrganisationId" type="xsd:string" />
			<xsd:element name="DateModified" type="xsd:dateTime" />
			<xsd:element name="Name" type="types:NotEmptyString" />
			<xsd:element name="Address" type="types:Address" />
			<xsd:element name="Brin" type="types:Brin" minOccurs="0" />
			<xsd:element name="Contact" type="types:Contact" maxOccurs="unbounded" minOccurs="0" />
			<xsd:element name="HasIdpRegistration" type="xsd:boolean" />
			<xsd:element name="Idp" type="types:IdpLink" minOccurs="0" maxOccurs="unbounded" />
		</xsd:sequence>
	</xsd:complexType>

Contact

Name

Type

Cardinality

Name

string

1...1

Role

RoleType

1...1

Email

0…1

Source

Code Block

<xsd:complexType name="Contact">
		<xsd:sequence>
			<xsd:element name="Name" type="xsd:string" />
			<xsd:element name="Role" type="types:RoleType" />
			<xsd:element name="Email" type="types:Email" minOccurs="0" />
		</xsd:sequence>
</xsd:complexType>

SchoolLink

Name

Type

Cardinality

Description

OrganisationId

string

1…1

Unique identifier of the school

StartDate

date

1...1

Date from which the link will be active

EndDate

date

0...1

Date till which the link will be active

Active

boolean

1...1

Whether the link is active or not at this moment (using the above start and end date)

Source

Code Block

	<xsd:complexType name="SchoolLink">
		<xsd:sequence>
			<xsd:element name="OrganisationId" type="xsd:string" />
			<xsd:element name="StartDate" type="xsd:date" />
			<xsd:element name="EndDate" type="xsd:date" minOccurs="0" />
			<xsd:element name="Active" type="xsd:boolean" />
		</xsd:sequence>
	</xsd:complexType>

IdpLink

Name

Type

Cardinality

Description

IdpId

string

1...1

Unique identifier (internal) of the idp

Realm

string

1...1

Unique identifier (public) of the idp

EntityId

string

1...1

Value of the “authenticating authority” property of the SAML protocol

StartDate

date

1...1

Date from which the link will be active

EndDate

date

0...1

Date till which the link will be active

Active

boolean

1...1

Whether the link is active now or not (using the above start and end date)

Source

Code Block

	<xsd:complexType name="IdpLink">
		<xsd:sequence>
			<xsd:element name="IdpId" type="xsd:string" />
			<xsd:element name="Realm" type="xsd:string" />
			<xsd:element name="EntityId" type="xsd:string" />
			<xsd:element name="StartDate" type="xsd:date" />
			<xsd:element name="EndDate" type="xsd:date" minOccurs="0" />
			<xsd:element name="Active" type="xsd:boolean" />
		</xsd:sequence>
	</xsd:complexType>

Idp

Name

Type

Cardinality

Description

IdpId

string

1...1

Unique Identifier of the idp

DateModified

dateTime

1...1

Description

string

1...1

Realm

string

1...1

EntityId

string

1...1

Value of the “authenticating authority” property of the SAML protocol

EntreeBrin

string

1...1

Value of the nlEduPersonHomeOrganizationId attribute

PortalSupplier

string

1...1

Name of the ELO, e.g. Magister or Distributeursportaal

EckIdState

1...1

Info about the EckId usage

School

SchoolLink

0…n

List of linked schools

Source

Code Block

	<xsd:complexType name="Idp">
		<xsd:sequence>
			<xsd:element name="IdpId" type="xsd:string" />
			<xsd:element name="DateModified" type="xsd:dateTime" />
			<xsd:element name="Realm" type="xsd:string" />
			<xsd:element name="Description" type="xsd:string" />
			<xsd:element name="EntityId" type="xsd:string" />
			<xsd:element name="EntreeBrin" type="xsd:string" />
			<xsd:element name="PortalSupplier" type="xsd:string" />
			<xsd:element name="EckIdState" type="types:EckIdState" />
			<xsd:element name="School" type="types:SchoolLink" minOccurs="0" maxOccurs="unbounded" />
		</xsd:sequence>
	</xsd:complexType>

EckIdState

Name

Type

Cardinality

Description

StartDate

date

0...1

Date from which the EckID will be used

EndDate

date

0...1

Date till which the EckID will be used

Active

boolean

1...1

Whether the EckID is used or not at this moment (using the above start and end date)

Source

Code Block

	<xsd:complexType name="EckIdState">
		<xsd:sequence>
			<xsd:element name="StartDate" type="xsd:date" minOccurs="0"/>
			<xsd:element name="EndDate" type="xsd:date" minOccurs="0"/>
			<xsd:element name="Active" type="xsd:boolean" />
		</xsd:sequence>
	</xsd:complexType>

RegistrationFault

Name

Type

Cardinality

Description

Code

integer

1...1

Code to identify the fault type.

Message

string

1...1

Specific message which describes the fault.

Source

Code Block

    <xsd:element name="RegistrationFault">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="Code" type="xsd:int"/>
				<xsd:element name="Message" type="xsd:string"/>
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>

...

Simple types

Name	Type	Possible values / format	Description
Brin	String	1234AB	The BRIN (Basisregistratie instellingen) is an identifier. The first four characters are alphanumerical and represent an educational institution. The last characters are numerical and represent an identifier for the location of a educational institution.
Email	String	Max length: 254 characters	String limited by a number of maximum allowed characters.
NotEmptyString	string	Min length: 1 character	String limited by a number of minimum allowed characters.
Phone	String	Max length: 15 characters	String limited by a number of maximum allowed characters.
PostalCode	String		The following regex should be applied: [0-9]{4} [A-Z]{2}
RoleType	Enum	Possible values: ELO-beheerder DT-contactpersoon Distributor

...

Version	Old Version 11	New Version Current
Changes made by	André Mussche	André Mussche
Saved on	Jun 08, 2023	Mar 25, 2024

Versions Compared

Key

Endpoints

Authorization

Operations

GetSchool

Description

Response

GetIdp

Description

Response

Errors

General errors

Specific errors

Complex types

LoginHeader

Address

School

Contact

SchoolLink

IdpLink

Idp

EckIdState

RegistrationFault

Simple types

Page Comparison

Versions Compared

Key

Endpoints

Authorization

Operations

GetSchool

Description

Response

GetIdp

Description

Response

Errors

General errors

Specific errors

Complex types

LoginHeader

Address

School

Contact

SchoolLink

IdpLink

Idp

EckIdState

RegistrationFault

Simple types