Endpoints

Environment	URL	WSDL
Production	https://cr.directetoegang.nl/soap/1.1/registration	https://cr.directetoegang.nl/soap/3.0/registration/wsdl
Acceptance	https://acc-cr.directetoegang.nl/soap/1.1/registration	https://acc-cr.directetoegang.nl/soap/3.0/registration/wsdl

WSDL

The WSDL and corresponding XSD’s are available as downloadable files:

Authorization

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

Operation overview

GetSchool
GetIdp

Operation authentication

All operations need the AuthenticationHeader to authenticate, which identifies the Supplier.

Name	Type	Cardinality
AuthenticationHeader	AuthenticationHeader	1...1
Source <urn:AuthenticationHeader> <SupplierId>?</SupplierId> <SupplierCode>?</SupplierCode> </urn:AuthenticationHeader>

Operations

GetSchool

Description

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

Authentication

See “Operation authentication”.

Request

Specify an OrganisationId to retrieve one specific school record.
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
ModifiedSince	dateTime	0...1
Source <urn:GetSchoolRequest> <!--Optional:--> <OrganisationId>?</OrganisationId> <!--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.

Authentication

See “Operation authentication”.

Request

Specify Realm or IdpId to retrieve one specific idp record.
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
ModifiedSince	dateTime	0...1
Source <urn:GetIdpRequest> <!--Optional:--> <IdpId>?</IdpId> <!--Optional:--> <Realm>?</Realm> <!--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

AuthenticationHeader

Name

Type

Cardinality

Description

SupplierId

string

1...1

Username

SupplierCode

string

1...1

Password

Source

<xsd:element name="AuthenticationHeader">
	<xsd:complexType>
		<xsd:sequence>
			<xsd:element name="SupplierId" type="xsd:string"/>
			<xsd:element name="SupplierCode" type="xsd:string"/>
		</xsd:sequence>
	</xsd:complexType>
</xsd:element>

Address

Name	Type	Cardinality
Street	string	0...1
HouseNumber	int	0...1
HouseNumberSuffix	string	0…1
PostalCode	PostalCode	0…1
City	string	0…1
Source <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
Fulfilment	Fulfilment	0…1	Digital or Non-digital
Name	string	1…1
Address	Address	1…1
Brin	Brin	0…1	See simple types
Contact	Contact	0…n	Contact details (additional rights needed)
Idp	IdpLink	0…n	List of linked idp’s
Source <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="Fulfilment" type="types:FulfilmentType" minOccurs="0" /> <xsd:element name="Brin" type="types:Brin" minOccurs="0" /> <xsd:element name="Contact" type="types:Contact" maxOccurs="unbounded" minOccurs="0"></xsd:element> <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	Email	0…1
Source <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 <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
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 <xsd:complexType name="IdpLink"> <xsd:sequence> <xsd:element name="IdpId" type="xsd:string" /> <xsd:element name="Realm" 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
EckIDEnabled	boolean	1...1	Value will be true if the idp uses EckID and the distributor has done some validity checks
School	SchoolLink	0…n	List of linked schools
Source <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="EckIDEnabled" type="xsd:boolean" /> <xsd:element name="School" type="types:SchoolLink" minOccurs="0" maxOccurs="unbounded" /> </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

    <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.
Fulfilment	Enum	Possible values: Digital Non-digital	Portals which only uses activation codes have the type “Non-digital”
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

Registration 3.0

Endpoints

WSDL

Authorization

Operation overview

Operation authentication

Operations

GetSchool

Description

Authentication

Request

Response

GetIdp

Description

Authentication

Request

Response

Errors

General errors

Specific errors

Complex types

AuthenticationHeader

Address

School

Contact

SchoolLink

IdpLink

Idp

RegistrationFault

Simple types