Registration 3.1

Endpoints

Zie Technical documentation | Technicaldocumentation Endpointoverzicht 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.

Change history

The following items are changed since the previous version Registration 3.0archived :

  • LoginHeader fixed

  • Idp.EckIDEnabled replaced with EckIdState object

  • School.Fulfilment replaced by HasIdpRegistration

  • IdpLink.EntityId added

  • OrganisationId added to GetIdp request

  • Realm added to GetSchool request

Operation overview

  • GetSchool

  • GetIdp

Operation authentication

All operations need the LoginHeader to authenticate.

Name

Type

Cardinality

Name

Type

Cardinality

LoginHeader

LoginHeader

1...1

Source

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

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 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

Name

Type

Cardinality

OrganisationId

string

0...1

Realm

string

0...1

ModifiedSince

dateTime

0...1

Source

<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

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 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

Name

Type

Cardinality

IdpId

string

0…1

Realm

string

0...1

OrganisationId

string

0...1

ModifiedSince

dateTime

0...1

Source

<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

Name

Type

Cardinality

Idp

Idp

0...n


Errors

General errors

General errors may occur within every operation.

Error code

Description

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

Error code

Description

-

-


Complex types

LoginHeader

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

Username

string

1...1

Username of the service account

Password

string

1...1

Password of the service account

Source

Address

Name

Type

Cardinality

Name

Type

Cardinality

Street

string

0...1

HouseNumber

int

0...1

HouseNumberSuffix

string

0…1

PostalCode

PostalCode

0…1

City

string

0…1

Source

School

Name

Type

Cardinality

Description

Name

Type

Cardinality

Description

DateModified

dateTime

1…1

 

OrganisationId

string

1…1

Unique identifier of the school

Name

string

1…1

 

Address

Address

1…1

 

Brin

Brin

0…1

See simple types

Contact

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

Contact

Name

Type

Cardinality

Name

Type

Cardinality

Name

string

1...1

Role

RoleType

1...1

Email

Email

0…1

Source

SchoolLink

Name

Type

Cardinality

Description

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

IdpLink

Name

Type

Cardinality

Description

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

Idp

Name

Type

Cardinality

Description

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

EckIdState

1...1

Info about the EckId usage

School

SchoolLink

0…n

List of linked schools

Source

EckIdState

Name

Type

Cardinality

Description

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

RegistrationFault

Name

Type

Cardinality

Description

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


Simple types

Name

Type

Possible values / format

Description

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