Registration 3.0
- André Mussche
- Former user (Deleted)
- Eelke Lok (Unlicensed)
- 1 Endpoints
- 2 WSDL
- 3 Authorization
- 4 Operation overview
- 5 Operation authentication
- 6 Operations
- 6.1 GetSchool
- 6.1.1 Description
- 6.1.2 Authentication
- 6.1.3 Request
- 6.1.4 Response
- 6.2 GetIdp
- 6.2.1 Description
- 6.2.2 Authentication
- 6.2.3 Request
- 6.2.4 Response
- 6.3 Errors
- 6.3.1 General errors
- 6.3.2 Specific errors
- 6.4 Complex types
- 6.4.1 AuthenticationHeader
- 6.4.2 Address
- 6.4.3 School
- 6.4.4 Contact
- 6.4.5 SchoolLink
- 6.4.6 IdpLink
- 6.4.7 Idp
- 6.4.8 RegistrationFault
- 6.1 GetSchool
- 7 Simple types
Endpoints
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 | 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 | 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 | 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 | |||
Address
Name | Type | Cardinality |
|---|---|---|
Street | string | 0...1 |
HouseNumber | int | 0...1 |
HouseNumberSuffix | string | 0…1 |
PostalCode | 0…1 | |
City | string | 0…1 |
Source | ||
School
Name | Type | Cardinality | Description |
|---|---|---|---|
DateModified | dateTime | 1…1 |
|
OrganisationId | string | 1…1 | Unique identifier of the school |
Fulfilment | 0…1 | Digital or Non-digital | |
Name | string | 1…1 |
|
Address | 1…1 |
| |
Brin | 0…1 | See simple types | |
Contact | 0…n | Contact details (additional rights needed) | |
Idp | 0…n | List of linked idp’s | |
Source | |||
Contact
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 | |||
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 | |||
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 | 0…n | List of linked schools | |
Source | |||
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 | |||
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:
| Portals which only uses activation codes have the type “Non-digital” |
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:
|
|