Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

...

  • 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:-->
         <ModifiedSince><Realm>?</ModifiedSince>Realm>        
         </!--Optional:-->
         <ModifiedSince>?</ModifiedSince>
      </urn:GetSchoolRequest>

Response

...

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

...