...
Name | Type | Cardinality |
|---|
AuthenticationHeader | AuthenticationHeader | 1...1 |
Source | Code Block |
|---|
<urn:AuthenticationHeader>
<SupplierId>?</SupplierId>
<SupplierCode>?</SupplierCode>
</urn:AuthenticationHeader> |
|
...
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.
...
In case of an error, a RegistrationFault is returned.
Name | Type | Cardinality |
|---|
Idp | Idp | 0...n |
...
Errors
General errors
...
Name | Type | Cardinality |
|---|
Street | string | 0...1 |
HouseNumber | int | 0...1 |
HouseNumberSuffix | string | 0…1 |
PostalCode | 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> |
|
...
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 | 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="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> |
|
...
Name | Type | Cardinality |
|---|
Name | string | 1...1 |
Role | RoleType | 1...1 |
Email | 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> |
|
...
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 | 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="EckIDEnabled" type="xsd:boolean" />
<xsd:element name="School" type="types:SchoolLink" minOccurs="0" maxOccurs="unbounded" />
</xsd:sequence>
</xsd:complexType> |
|
...